Using the SDK:

Integration:

To add SDK to your app add dependency in the build.gradle(.kts) file:

Kotlin DSL

implementation("com.cookieinformation:mobileconsents:<latest_release>")

Setup

This library is provided to you, to integrate mobile consents in an easy way. Let's get started:

Here is the update for release: 0.2.6:

-Enable resetting consent, either all or by type.

-Support multiple languages, and enforce selecting at least one language.

Please note, these languages must be synchronized with the consent dashboard.

-Consent List UI, has been updated to a clearer separation of required and optional consents.

Here are the main objects you should be familiar with:

class MobileConsentSdk 
class MobileConsentCredentials 
class MobileConsentCustomUI 
class SdkTextStyle 
class TitleStyle 
class SubtitleStyle 
class BodyStyle

The above objects are required in order to initialize the SDK.

MobileConsentSdk - is the object that handles all the consent info, and state. This is init using the builder pattern. -it is also dependent on the MobileConsentCredentials and the MobileConsentCustomUI.

MobileConsentCredentials - The object that contains all credentials required for fetching the relevant data for your company/application.

MobileConsentCustomUI - The colour theme used for various components that are included in the library.

SdkTextStyle - The object that wraps the text styling of the app.

TitleStyle - The typeface of titles.

SubtitleStyle - The typeface of secondary titles

BodyStyle - The typeface of SDKs body

Steps to implement:

-Extend the application class. (Dont forget to add to manifest)

-Make your Extended Application class 'Consentable' - (This is a defined interface, defined in the library).

-Implement the required methods.

Here is a sample:

Kotlin:

class App : Application(), Consentable { override val sdk: MobileConsents by lazy { MobileConsents(provideConsentSdk()) } override fun provideConsentSdk() = MobileConsentSdk.Builder(this) .setClientCredentials(provideCredentials()) .setMobileConsentCustomUI(MobileConsentCustomUI(Color.parseColor("any hexcode color string"))) .setLanguages("A list of locales that the consents support.") //please ensure your consents are set to have the the corresponding translation on the dashboard. .build() override fun provideCredentials(): MobileConsentCredentials { return MobileConsentCredentials( clientId = "Client ID provided XXXXX", solutionId = "Solution ID provided XXXXXXX", clientSecret = "Client Secret ID provided XXXXX" ) } }

Java:

public class MyApplication extends Application implements Consentable { @NonNull @Override public MobileConsents getSdk() { return new MobileConsents(provideConsentSdk(), Dispatchers.getMain()); } @Nullable @Override public Object getSavedConsents(@NonNull Continuation<? super Map<ConsentItem.Type, Boolean>> continuation) { return getSdk().getSavedConsents(new CallListener<Map<ConsentItem.Type, Boolean>>() { @Override public void onSuccess(Map<ConsentItem.Type, Boolean> typeBooleanMap) { } @Override public void onFailure(@NonNull IOException e) { } }); } @NonNull @Override public MobileConsentSdk provideConsentSdk() { return MobileConsentSdk.Builder(this) .setClientCredentials(provideCredentials()) .setMobileConsentCustomUI(MobileConsentCustomUI(Color.parseColor("any hexcode color string"))) .setLanguages("A list of locales that the consents support.") //please ensure your consents are set to have the the corresponding translation on the dashboard. .build(); } @NonNull @Override public MobileConsentCredentials provideCredentials() { return new MobileConsentCredentials( "Client ID provided XXXXX", "Client Secret ID provided XXXXX", "Solution ID provided XXXXXXX" ); } }

Once this is implemented, your application is ready to handle consents out of the box. There are 2 main functions in the SDK, that are responsible for navigating to the mobile consents component. These methods take an activity listener, so the component calling them can know how to handle the updated consent settings.

fun displayConsents(listener) fun displayConsentsIfNeeded(listener)

Here is a sample:

class MainActivity : AppCompatActivity() { private val listener: ActivityResultLauncher<Bundle?> = registerForActivityResult( GetConsents(this), ) { //observes and returns a map of the consent and the values. } override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.activity_main) findViewById<Button>(R.id.display_always).setOnClickListener { (applicationContext as App).sdk.displayConsents(listener) } findViewById<Button>(R.id.display_if_needed).setOnClickListener { (applicationContext as App).sdk.displayConsentsIfNeeded(listener) } } }

If you have any questions about the MCS implementation, take a look at our Mobile FAQ or contact us at support@cookieinformation.com