Context API module (now Context API)

This is the previous version (2.x) of Tealium for Flutter. For the latest version, see Tealium for Flutter.

Moments API has been renamed to Context API. For full product documentation, see About Context API.

Tealium for Flutter lets you use the Tealium mobile libraries (iOS, Android) to install the Context API Module for the Tealium Flutter plugin.

How it works

Tealium mobile libraries can be integrated into your Flutter application using one of the following methods:

• Dart package (Recommended)
• Manually with GitHub

Requirements

• Flutter application development framework
• IDE, such as Android Studio or VS Code
• Flutter plugin installed on the IDE

Install

To install the Tealium library for Flutter:

1. In your Flutter app project, run the following command:

   dart pub add tealium_moments_api
   

2. Import the following Dart code into your project:

   import 'package:tealium_moments_api/common.dart';
   import 'package:tealium_moments_api/tealium_moments_api.dart';
   

Initialize

Configure the Context API module before initializing the main Tealium Flutter integration.

Set the Context API Region as specified in the Context API interface. The following regions are available:

• GERMANY
• US_EAST
• SYDNEY
• OREGON
• TOKYO
• HONG_KONG

If you are using the domain allow list, set the referrer to an allowed domain.

The following example code uses the US_EAST region and example.com as the referrer to match the allowed domain:

final config = MomentsApiConfig(
    MomentsApiRegion.US_EAST,   // required
    "https://example.com");     // optional

// Configure the module
TealiumMomentsApi.configure(config);

// ... Initialize main Tealium plugin

Class: TealiumMomentsApi

After the Context API Module and the main Tealium Flutter integration have both been initialized, you can retrieve engine data by ID.

fetchEngineResponse

Retrieves the engine response for the given engine ID.

TealiumMomentsApi.fetchEngineResponse(
    engineId: "ENGINEID",
    callback: (response) {
        if (response is EngineResponse) {
            // handle success
            final audiences = response.audiences;
            // do something
        } else if (response is String) {
            // handle error
        }
    }
);

Parameters

EngineResponse

The EngineResponse class contains the visitor data returned from the Context API engine.