flutter_acpanalytics

Notice of deprecation

Since April 25, 2023, Apple has required apps submitted to the App Store to be built with Xcode 14.1 or later. The Experience Platform Mobile SDKs and extensions outlined below were built with prior versions of Xcode and are no longer compatible with iOS and iPadOS given Apple’s current App Store requirements. Consequently, on August 31, 2023, Adobe will be deprecating support for the following Experience Platform Mobile SDKs and wrapper extensions:

• ACP iOS SDK
• Cordova
• Flutter for ACP
• React Native for ACP
• Xamarin

After August 31, 2023, applications already submitted to the App Store that contain these SDKs and wrapper extensions will continue to operate, however, Adobe will not be providing security updates or bug fixes, and these SDKs and wrapper extensions will be provided as-is exclusive of any warranty, due to the App Store policy outlined above.

We encourage all customers to migrate to the latest Adobe Experience Platform versions of the Mobile SDK to ensure continued compatibility and support. Documentation for the latest versions of the Adobe Experience Platform Mobile SDKs can be found here. The iOS migration guide can be found here.

---

flutter_acpanalytics is a flutter plugin for the iOS and Android AEP Analytics SDK to allow for integration with flutter applications. Functionality to enable the Analytics extension is provided entirely through Dart documented below.

Installation

Install instructions for this package can be found here.

Note: After you have installed the SDK, don't forget to run pod install in your ios directory to link the libraries to your Xcode project.

Tests

Run:

flutter test

Usage

Analytics

Importing the SDK:

import 'package:flutter_acpanalytics/flutter_acpanalytics.dart';

Getting the SDK version:

String version = await FlutterACPAnalytics.extensionVersion;

Registering the extension with ACPCore:

Note: It is required to initialize the SDK via native code inside your AppDelegate and MainApplication for iOS and Android respectively. For more information see how to initialize Core.

iOS

Swift

import ACPAnalytics

ACPAnalytics.registerExtension()

Objective-C

#import "ACPAnalytics.h"

[ACPAnalytics registerExtension];

Android:

import com.adobe.marketing.mobile.Analytics;

Analytics.registerExtension();

Get the tracking identifier:

String trackingId;

try {
   trackingId = await FlutterACPAnalytics.trackingIdentifier;
} on PlatformException {
   log("Failed to get the tracking identifier");
}

Send queued hits:

FlutterACPAnalytics.sendQueuedHits();

Get the queue size:

int queueSize;

try {
   queueSize = await FlutterACPAnalytics.queueSize;
} on PlatformException {
   log("Failed to get the queue size");
}

Clear queued hits:

FlutterACPAnalytics.clearQueue();

Set the custom visitor identifier:

FlutterACPAnalytics.setVisitorIdentifier("vid");

Get the custom visitor identifier:

String visitorId;

try {
   visitorId = await FlutterACPAnalytics.visitorIdentifier;
} on PlatformException {
   visitorId = "Failed to get the visitor identifier";
}

Track app actions:

FlutterACPCore.trackAction("myAction",  data: {"key1": "value1"});

Track app states:

FlutterACPCore.trackState("myState",  data: {"key1": "value1"});

Contributing

See CONTRIBUTING

License

See LICENSE