Setup

Add the SDK to your project

SDK is available from pub.dev: https://pub.dev/packages/didomi_sdk/install

Add the Didomi SDK dependency: 

 $ flutter pub add didomi_sdk

This will add a line like this to your package's pubspec.yaml (and run an implicit dart pub get):

dependencies:
  didomi_sdk: ^1.0.1

Afterwards, to update the dependency to the latest version, you can use the command

$ flutter pub upgrade

On Android, the error Module was compiled with an incompatible version of Kotlin. may occur. Make sure ext.kotlinVersion is set to 1.5.31 in android/build.gradle.

Then you can import project from your dart code:

import 'package:didomi_sdk/didomi_sdk.dart';

Initialize the SDK

Once our SDK has been added to your project, you need to initialize it. The initialization process will prepare the SDK for interactions with the user and your application. It is important to launch the SDK initialization as soon as possible.

In your code, call the initialize method and pass your API key:

void initDidomi() {
  // Setup a listener to know when the SDK is ready
  DidomiSdk.onReady(() => {
    // The Didomi SDK is ready to go, you can call other functions
  });
  DidomiSdk.initializeWithParameters(
      DidomiInitializeParameters(apiKey:"<Your API key>",
      noticeId: "<Your Notice ID>"));
}

Keep in mind that the SDK initialization is an asynchronous process so you must avoid interacting with the DidomiSdk object until it is actually ready to handle your requests. Use the onReady event in dart to register a listener for the ready event.

Take a look at our sample app to see how the setup is done.

Use FlutterFragmentActivity instead of FlutterActivity (Android)

The Didomi SDK requires a FragmentActivity to display the notice. By default, Flutter projects use FlutterActivity which extends Activity: to use the SDK, it must be changed to a FlutterFragmentActivity instead.

The activity class should be present in folder android/app/src/main/kotlin/ under the package name described in android/app/src/main/AndroidManifest.xml. Update it to use FlutterFragmentActivity.

package <Your package name>

import io.flutter.embedding.android.FlutterFragmentActivity

class MainActivity: FlutterFragmentActivity() {
}

Some sdk users reported a dependency conflict after updating the MainActivity class. They solved it by adding the dependency

implementation "androidx.activity:activity-ktx:1.3.1"

in the file android/app/build.gradle .

Setup the SDK UI

Note: the setupUI method should be called only from your contexts where the application starts.

You do not need to call onReady, isReady or shouldConsentBeCollected before calling setupUI because they are called internally. Therefore, by calling this method the consent notice will be displayed if it is required and only once the SDK is ready.

Call the setupUI function of the SDK in your context where the application starts:

class _MyHomePageState extends State<MyHomePage> {

  @override
  void initState() {
    super.initState();
    DidomiSdk.setupUI();
  }
}

Deep links

If you are using deep links or have multiple pages in your Flutter app, make sure that the setupUI function is called on every context that the user can launch the app on. This will ensure that consent is always collected as needed and there is no path where the user can launch the app without consent being collected. If setupUI is missing in some entry points, you will see lower consent rates as users will be using the app without giving consent.

Configure the SDK

We support three options for configuring the UI and the behavior of the SDK:

  • Didomi Console: the SDK is configured remotely from the Didomi Console

  • Local file: the SDK is configured from a didomi_config.json file embedded in your app package

  • Remote file: the SDK is configured from a remote didomi_config.json file

From the Console (Recommended)

You can configure the consent notice in your app by creating a notice in your Didomi Console. It will automatically be linked to your app through your API Key and, optionally, your notice id. You can access the Didomi console here.

In order to enable this option, make sure to pass the disableDidomiRemoteConfig parameter as false (default value) when calling the initialize method as shown below.

  DidomiSdk.initializeWithParameters(
      DidomiInitializeParameters(
          apiKey: "<Your API key>",
          disableDidomiRemoteConfig: false,
          noticeId: "<Your notice ID>"
      )
  );

The SDK will automatically use the remote configuration hosted by Didomi and cache it locally. The cached version is refreshed every 60 minutes. If there is no connection available to download the remote configuration and no locally cached version, the SDK will try to use a local didomi_config.json configuration file as a fallback. See the Local option below for more information on how to configure the SDK through a local configuration file.

Local file (Deprecated)

Using a local file automatically disables the TCF integration. If your app uses the TCF, you must use a configuration from the Didomi Console.

Using a local file will prevent you to support multiple regulations.

With this option, you create your own SDK configuration file and embed it in your app package.

The SDK behavior is configured in a didomi_config.json file that must be placed in the Android and iOS folders of your project.

You can create a file with the following content to get started:

{
    "app": {
        "name": "My App Name",
        "privacyPolicyURL": "http://www.website.com/privacy",
        "vendors": {
            "iab": {
                "all": true
            }
        },
        "gdprAppliesGlobally": true,
        "gdprAppliesWhenUnknown": true
    }
}

For Android, the configuration file must be placed in the assets folder of the Android platform code (in this example: android/app/src/main/assets)

For iOS, the configuration file must be placed in the Resources group (make sure project.pbxproj file is updated)

You also need to disable loading the remote configuration to ensure that only the local file is loaded and that no HTTP request is sent. Update your initialize call to set the disableDidomiRemoteConfig parameter to true:

 DidomiSdk.initializeWithParameters(
      DidomiInitializeParameters(
            apiKey: "<Your API key>",
            disableDidomiRemoteConfig: true,
            noticeId: "<Your notice ID>"
      )
);

Your SDK is now setup. Read the Getting started section of our Mobile SDKs to learn more about how to configure it to match your app UI and requirements.

Remote file

Enabling this option will prevent the configuration from being loaded from the Didomi Console.

You can provide a remote URL for the SDK to download the didomi_config.json configuration file from. That allows you to update the SDK configuration without having to re-publish you mobile application.

When that configuration is enabled, the SDK will automatically use the remote configuration and cache it locally. The cached version is refreshed every 60 minutes. If there is no connection available to download the remote file and no locally cached version, the SDK will try to use the local didomi_config.json (described above) as a fallback.

To enable that option, change your call to initialize to provide the remote file URL:

 DidomiSdk.initializeWithParameters(
      DidomiInitializeParameters(
            apiKey: "<Your API key>",
            remoteConfigurationURL: "http://www.website.com/didomi_config.json",
            disableDidomiRemoteConfig: false
      )
);

Also see the reference documentation of the initialize function for more information.

PreviousFlutterNextReference

Last updated