# Android SDK #### Pre-Requisites Conscent.ai Android SDK supports **API 21 (Android 5.0)** and above. Please ensure the minSdkVersion is in the app's **build.gradle** file reflects the same. {% hint style="info" %} *In case of an error for Kotlin not enabled - Enable Kotlin for Project.* *In case of an error in Manifest merging - Merge Manifest as per Android Studio support or include the below line inside your application tag in the Android Manifest file.* 
tools:replace="android:icon,android:roundIcon"
{% endhint %} {% hint style="info" %} To integrate SDK, you need to enable the below-listed dependencies: * Data Binding * View Binding * Jetpack Compose {% endhint %} #### Permissions Add the following permissions to the `AndroidManifest.xml` file. ```xml ```
Installation You can download and add AAR File from [here](https://github.com/tsbmediaventure/ConsCent-docs/tree/master/docs/mobile/Android%20V2%20SDKs), which needs to be included in your **Module libs directory,** and tell gradle to install it like this: ``` Following files are required to be added. ``` ```gradle dependencies { implementation fileTree(include: [ '*.aar'], dir: 'libs') } ```
Dependencies In root level (project level) build.gradle, add classpath, and maven: ```gradle dependencies { classpath 'com.google.gms:google-services:[latest-version]' // Add the Crashlytics Gradle plugin classpath 'com.google.firebase:firebase-crashlytics-gradle:[latest-version]' } ``` In your application build.gradle file, include dependency as below with the latest versions: ```kotlin dependencies{ // Retrofit implementation 'com.squareup.retrofit2:retrofit:2.9.0' implementation 'com.squareup.retrofit2:converter-gson:2.9.0' implementation 'com.squareup.okhttp3:logging-interceptor:5.0.0-alpha.9' // Coroutines implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.4' // Browser implementation 'androidx.browser:browser:1.5.0' implementation 'com.google.android.gms:play-services-base:[latest-version]' implementation (platform("com.google.firebase:firebase-bom:[latest-version]")) implementation ("com.google.firebase:firebase-analytics-ktx") implementation ("com.google.firebase:firebase-crashlytics-ktx") implementation 'com.squareup.picasso:picasso:[latest-version]' implementation "androidx.swiperefreshlayout:swiperefreshlayout:[latest-version]" // compose def composeBom = platform('androidx.compose:compose-bom:2023.04.01') implementation composeBom androidTestImplementation composeBom implementation "androidx.compose.material:material:1.4.3" implementation 'androidx.compose.ui:ui' // Android Studio Preview support implementation 'androidx.compose.ui:ui-tooling-preview' debugImplementation 'androidx.compose.ui:ui-tooling' // Optional - Integration with activities implementation 'androidx.activity:activity-compose:1.7.2' implementation 'androidx.constraintlayout:constraintlayout-compose:1.0.1' implementation 'androidx.compose.ui:ui-text-google-fonts:1.5.0-beta02' // Contains the core Credential Manager functionalities including password // and passkey support. implementation("androidx.credentials:credentials:1.3.0-alpha01") // Provides support from Google Play services for Credential Manager, // which lets you use the APIs on older devices. implementation("androidx.credentials:credentials-play-services-auth:1.3.0-alpha01") implementation("com.google.android.libraries.identity.googleid:googleid:1.1.0") implementation ("com.google.firebase:firebase-auth-ktx:[latest-version]") //fb dependency implementation ("com.facebook.android:facebook-login:latest.release") } ```
Initialize SDK In your application or root activity class's method onCreate, pass these fields to be used in your app. * applicationContext - Pass your application context. * yourClientId - Pass your clientId received from Conscent.ai. * yourAccentColor - Pass your accentColor for the app. * Mode - configuration testing of different environments available. * APP\_MODE - used for checking the debug and production environment of the app. ```kotlin Api Mode can be set as : ConscentConfiguration.MODE.SANDBOX ConscentConfiguration.MODE.PRODUCTION ``` ```kotlin APP_MODE can be set as : ConsCentConfiguration.APP_MODE.DEBUG ConsCentConfiguration.APP_MODE.PROD ``` *If APP\_MODE is DEBUG, all errors will be shown as Toast messages and Logs.* *If APP\_MODE is PROD, only logs will be available for critical errors like Network unavailability, wrong client\_id, and wrong content\_id.*
{% tabs %} {% tab title="Kotlin" %} ```kotlin class TestingApplication : Application() { override fun onCreate() { super.onCreate() ConscentWrapper.configure( application = this, clientId = "5f92a62013332e0f667794dc", appMode = ConscentConfiguration.APP_MODE.DEBUG, apiMode = ConscentConfiguration.MODE.SANDBOX, ) } } ``` {% hint style="info" %} Pass the client ID received from Conscent.ai dashboard {% endhint %} {% endtab %} {% endtabs %} **Initialize the paywall** In order to ensure that the Conscent.ai Paywall appears on the targeted pages and the deep insights and analytics are collected optimally you need to implement the following method on all the content/article pages. To have more control over the content flow, create an instance of the Conscent class inside your activity onCreate method for each unique contentId(recommended). Use the below-described method: {% tabs %} {% tab title="Kotlin" %} ```kotlin // Define a map with dynamic data val variables: Map = mapOf( "packageName" to "com.conscent.plugin", "device" to "ANDROID", "versionCode" to "20.4.5",) val instance = ConscentWrapper.getConscentInstance( callingActivity = yourCallingActivity, parentView = yourParentView, containerView = yourContainerView, popUpContainer = yourPopUpContainerView, onConscentListener = onConscentListener, contentId = contentId, title = contentTitle, categories= arrayListOf("categorie1","categorie2","categorie3"), sections = arrayListOf("section","section1","section3"), tags = arrayListOf("premium"), url = ContentUrl, authorName = authorName, publicationDate = "2024-07-17T11:57:27.312Z", variables = variables //OPTIONAL ) //To display the registration paywall RegistrationPaywall.initRegistrationPaywall() //To display the paywall Paywall.initRegularPaywall() //To display the metered banner MeterBanner.initMeterBanner() ``` {% endtab %} {% endtabs %} > #### Note: Include the AAR files of respective paywalls and banners before calling above functions. #### To set the scroll depth on the content page: ```kotlin instance.scrollDepth = scrollY ``` In case of Fragment, call the below method inside onDestoyView()- ``` instance.onDestroy() ```
ParametersDescription
yourCallingActivity(Activity)This is your activity content which is calling the methods and where callback will be received.
yourParentView(ConstraintLayout)This will be the parent of your layout. Please keep ConstraintLayout as your root view in your activity xml file. Pass the reference of your root view in checkContent function.
yourContainerView(FrameLayout)

This will be a FrameLayout where the payment page will be inflated. Create a frameLayout in your XML and pass it here as a reference.

For eg:

<FrameLayout
        android:id="@+id/frame"
        android:layout_width="match_parent"
        android:layout_height="match_parent" />
contentId (String)This will be your article or content id for which detail needs to be checked.
yourContentTitle (String - Optional)Title of the content for display purposes.
yourSubsUrl (String - Optional)Url is to be used when subscribe button is clicked.
canSubscribe (Boolean - Optional)Pass this as "true" to show subscribe layout else as "false".
showClose (Boolean - Optional)Pass this as "true" to show the close button on the paywall/subscriptions, the default value is "false"
OnConscentListenerYou can pass a listener which will get called after success or failure in processing. If you pass a listener, after successful processing, the success reference will be called and for a failed event, the failure event will be called
You can implement OnConscentListener in your activity and then pass it as a reference. | Methods | Description | | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | onSuccess | This is the success callback that will get called for every successful processing. You can pass your method as a reference or a lambda expression which will get called in case of success. This will send params clientId ,contentId , userId , authToken , accessType(PVM, SUBS, PASS, CONTENT). | | onError (optional) | You can pass it as null. This is the failure callback which will get called for every failed processing. You can pass your method as a reference or a lambda expression and it'll get called for failed cases. You can implement your code in it for failed cases. | | onSubscribe (optional) | If you want to inflate subscribe layout, pass a subscribe function which will be called when subscribe button will be clicked inside the payment flow. Passing null will not inflate subscribe layout. | | onBuyPass (optional) | It will be called when the buy-pass button will be clicked inside the payment flow. | | onSignIn | This is the callback function that will be called when a user clicks on signIn button in the payment flow. This will be only visible if subscribe layout has been inflated. | | onAdFree | This is the callback function which will be called when a user clicks on adfree subscription. | | eventParams | This callback function will be called when a user clicks on the Google login. This will send params paywallId,contentId, paywallType, clientId, and anonId. | | onShowPaywall | This callback function will be called when a paywall is visible on the screen. This will send params - eventLocation, eventType, paywallDisplayType, paywallType. | | onGoogleLoginClick | This will be used to trigger your Google sign. This callback function will be called when a user clicks on the Google login. | | onLoginSuccess | This callback function will be called when a User LoggedIn successFuly. The message, userId, authToken will be received here. | #### To check if an article/content is free/paid or payment needs to be done, in your class, use as below sample: Parameters detail can be checked below for more information. {% tabs %} {% tab title="Kotlin" %} ```kotlin instance.checkContentAccess( contentId ) ``` {% endtab %} {% endtabs %} > Call **checkContentAccess** method on override **onNewIntent** method in Activity Class. **Call the below function and pass the userId, after the user has logged in:** ```kotlin PluginPreferences.setClientUserId("Your_User_Id") ```
Login Functionality Call this method to invoke our Login System ```kotlin ConscentWrapper.INSTANCE?.onSSOLogin( consCentLoginCallbacks = object : ConsCentLoginCallbacks { override fun onLoginSuccess( message: String, userId: String, authToken: String ) { Log.d(TAG, " $message, $userId, $authToken ") } override fun onLoginFailure(message: String, errorCode: String) { Log.d(TAG, "$message, $errorCode ") } }, override fun onRedirectToHomeScreen(message: String, errorCode: String) { Log.d( TAG, "onRedirectToHomeScreen $message," ) } clientActivity = this@yourCallingActivity, ) ```
Fetch User-details Method **Call this method to show User Profile Page:** ```kotlin ConscentWrapper.INSTANCE?.openUserDetails( clientActivity = this@yourCallingActivity, consCentUserProfileCallbacks = object: ConsCentUserProfileCallbacks { override fun userLogoutSuccess(message: String, statusCode: String) { Log.d( TAG, "$message $statusCode" ) } override fun userLogoutFailed(message: String, statusCode: String) { Log.e( TAG, "$message $statusCode" ) } override fun userDeleteAccountSuccess(message: String, statusCode: String) { Log.d( TAG, "$message $statusCode" ) } override fun userDeleteAccountFailed(message: String, statusCode: String) { Log.e( TAG, "$message $statusCode" ) } override fun userNotLoggedIn(message: String, statusCode: String) { Log.e( TAG, "$message $statusCode" ) } override fun userProfileUpdate(message: String, statusCode: String) { Log.d( TAG, "consCentUserProfileCallbacks $message" ) } } ) ``` **Call this method to fetch user-details:** ```kotlin ConscentWrapper.INSTANCE?.getUserDetails( userDetailSuccess = { userDetails-> Log.d(TAG, "showUserDetails: $userDetails") }, failure = { Log.e(TAG, "showUserDetails: $it") }) ```
#### Logout the User: {% tabs %} {% tab title="Kotlin" %} ```kotlin ConscentWrapper.INSTANCE?.onSSOLogOut( this@yourCallingActivity, consCentLogoutCallbacks = object : ConsCentLogoutCallbacks { override fun onLogOutSuccess(message: String, successCode: String) { Log.d(TAG, "$message $successCode") } override fun onLogOutFailure(message: String, errorCode: String) { Log.e(TAG, "$message $errorCode") } }, ) ``` {% endtab %} {% endtabs %} **To use only the Subscription Landing Page, call the below method:** ``` ConscentWrapper.INSTANCE?.openCustomUrl(context: Activity, customUrl: String) ``` > CustomUrl is URL of the Subscription Landing Page with clientId. **Demo App:** [**Link**](https://github.com/RoshanSharma8245/Demo-Blog) --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.conscent.ai/version-2.0/mobile-sdk/android-sdk.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.