/flutter_acpanalytics

Flutter Plugin for AEP Analytics

Primary LanguageDartApache License 2.0Apache-2.0

flutter_acpanalytics

pub package Build License

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

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