Adobe visitor service module

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

Tealium for Flutter lets you use the Tealium mobile libraries (iOS, Android) to install the Adobe Visitor Service Module for the Tealium Flutter plugin.

How it works

Tealium mobile libraries are 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:

In your Flutter app project, run
```
dart pub add tealium_adobevisitor
```

Import the Dart code to your project:

import 'package:tealium_adobevisitor/common.dart';

Initialize

Configure the Adobe Visitor Service module prior to initializing the main Tealium Flutter integration.

final adobeVisitorConfig = AdobeVisitorConfig(
    "ADOBE-ORG-ID",
    adobeVisitorRetries: 1,
    adobeVisitorExistingEcid: "EXISTING-ECID",  // optional
);

TealiumAdobeVisitor.configure(adobeVisitorConfig);

Set the adobeVisitorCustomVisitorId, adobeVisitorDataProviderId, and adobeVisitorAuthState properties only if all three values are known at the start of the app session. Set adobeVisitorAuthState only when you also set adobeVisitorCustomVisitorId. If the visitor’s ID is not known at initialization (for example, before login), omit these properties and call linkEcidToKnownIdentifier once the ID becomes available.

final adobeVisitorConfig = AdobeVisitorConfig(
    "ADOBE-ORG-ID",
    adobeVisitorRetries: 1,
    adobeVisitorExistingEcid: "EXISTING-ECID",
    adobeVisitorDataProviderId: "DATA-PROVIDER-ID",
    adobeVisitorCustomVisitorId: "CUSTOM-VISITOR-ID",
    adobeVisitorAuthState: AuthState.authenticated,
);

TealiumAdobeVisitor.configure(adobeVisitorConfig);

API reference

After the Adobe Visitor Service Module and the main Tealium Flutter integration have both been initialized, you can link an existing Adobe visitor.

`linkEcidToKnownIdentifier(knownId, adobeDataProviderId, authState)`

Links existing Experience Cloud ID (ECID) to known identifier.

final visitor = await TealiumAdobeVisitor.linkEcidToKnownIdentifier("myidentifier", "123456", AuthState.unknown);

`getAdobeVisitor()`

Get the current Adobe visitor information.

TealiumAdobeVisitor.getAdobeVisitor()
        .then((visitor) => print(visitor));

`decorateUrl(url)`

Decorates the URL with ECID visitor data.

String? decoratedUrl = await TealiumAdobeVisitor.decorateUrl("https://example.com");

`getUrlParameters()`

Retrieves URL parameters containing the Adobe Visitor ID to be manually appended to a URL.

TealiumAdobeVisitor.getUrlParameters().then(
                            (value) =>
                            value?.forEach((key, value) {
                                print("Retrieved URL Parameters: $key = $value");
                            })
                    );

`resetVisitor()`

Reset current visitor.

TealiumAdobeVisitor.resetVisitor();