isabella232 / flutter_griffon

Flutter plugin for AEP Griffon

flutter_griffon

⚠️ This package is currently in beta, we are actively working to a release candidate. If you have any feedback please log an issue or submit a pull request.

flutter_griffon is a flutter plugin for the iOS and Android Project Griffon SDK to allow for integration with Flutter applications. Functionality to enable the Griffon 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

Griffon

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 ACPGriffon

ACPGriffon.registerExtension()

Objective-C

#import "ACPGriffon.h"

[ACPGriffon registerExtension];

Android:

import com.adobe.marketing.mobile.Griffon;

Griffon.registerExtension();

Importing the SDK:

import 'package:flutter_griffon/flutter_griffon.dart';

Getting Griffon version:

String version = await FlutterGriffon.extensionVersion;

Starting a Griffon session:

FlutterGriffon.startSession(url);

Ending a Griffon session:

FlutterGriffon.endSession();

Attempt to reconnect to a Griffon session:

FlutterGriffon.attemptReconnect();

Sending a Griffon event:

FlutterGriffon.sendEvent("vendor", "type", {"customPayload": "customValue"});

Log Local UI Level:

import 'package:flutter_griffon/src/acpgriffon_uilogcolor.dart';

FlutterGriffon.logLocalUILevel(ACPGriffonUILogColor.VISIBILITY_LOW, "message");
FlutterGriffon.logLocalUILevel(ACPGriffonUILogColor.VISIBILITY_NORMAL, "message");
FlutterGriffon.logLocalUILevel(ACPGriffonUILogColor.VISIBILITY_HIGH, "message");
FlutterGriffon.logLocalUILevel(ACPGriffonUILogColor.VISIBILITY_CRITICAL, "message");

Contributing

See CONTRIBUTING

License

See LICENSE