braze_plugin 0.4.0
braze_plugin: ^0.4.0 copied to clipboard
This is the Braze plugin for Flutter. Effective marketing automation is an essential part of successfully scaling and managing your business.
0.4.0 #
Breaking
- The native iOS bridge uses Braze iOS SDK 3.18.0.
- The native Android bridge uses Braze Android SDK 3.6.0.
Added
- Added the following new field to
BrazeInAppMessage
:zippedAssetsUrl
.- Note that a known issue in the iOS plugin prevents HTML IAMs from working reliably with the Dart in-app message callback. Android is not affected.
0.3.0 #
Breaking
- The native iOS bridge uses Braze iOS SDK 3.15.0.
- The native Android bridge uses Braze Android SDK 3.5.0.
- Support for the Android configuration parameter
com_appboy_inapp_show_inapp_messages_automatically
has been removed.- To control whether an in-app message object should be displayed natively or not, create and register an instance of
IInAppMessageManagerListener
in your native Android code and implement decisioning in thebeforeInAppMessageDisplayed
method. SeeMainActivity
in our sample app for an example.
- To control whether an in-app message object should be displayed natively or not, create and register an instance of
- On Android, in-app message objects are no longer sent automatically to the Dart in-app message callback after calling
BrazePlugin.setBrazeInAppMessageCallback()
in your Dart code.- Similar to iOS, you will need to implement a delegate interface in your native app code and pass in-app message objects to the Dart layer for passing to the callback.
- On Android, the delegate interface is
IInAppMessageManagerListener
and the method for passing objects to Dart isBrazePlugin.processInAppMessage(inAppMessage)
. - See the sample
IInAppMessageManagerListener
implementation in theMainActivity.kt
file of our sample app for an example. - This approach gives the integrator more flexibility in deciding when a message should be displayed natively, discarded, or passed into the Dart layer.
Added
- Added support for logging in-app message analytics to the Braze interface using
BrazeInAppMessage
instances. SeelogInAppMessageClicked
,logInAppMessageImpression
, andlogInAppMessageButtonClicked
.
0.2.1 #
Added
- Added the following new fields to
BrazeInAppMessage
:imageUrl
,useWebView
,duration
,clickAction
,dismissType
,messageType
- Added the following new fields to
BrazeButton
:useWebView
,clickAction
.
0.2.0 #
Breaking
- The native iOS bridge uses Braze iOS SDK 3.14.0.
- The native Android bridge uses Braze Android SDK 3.2.1.
Added
- Adds
addAlias()
to the public API interface. - Adds
requestLocationInitialization()
to the public API interface. - Adds
getInstallTrackingId()
to the public API interface. - Adds support for disabling native in-app message display on Android.
- To disable automatic in-app message display, create a boolean element named
com_appboy_inapp_show_inapp_messages_automatically
in your Android app'sappboy.xml
and set it tofalse
. - Note: Disabling automatic in-app message display was already possible for iOS. For instructions, see
README.md
.
- To disable automatic in-app message display, create a boolean element named
- Adds a Dart callback for receiving Braze in-app message data in the Flutter host app.
- Analytics are not currently supported on messages displayed through the callback.
- To set the callback, call
BrazePlugin.setBrazeInAppMessageCallback()
from your Flutter app with a function that takes aBrazeInAppMessage
instance.- The
BrazeInAppMessage
object supports a subset of fields available in the native model objects, includinguri
,message
,header
,buttons
, andextras
.
- The
- The callback should begin to function on Android immediately after being set.
- On iOS, you will additionally need to implement the
ABKInAppMessageControllerDelegate
delegate as described in our public documentation. YourbeforeInAppMessageDisplayed
delegate implementation must callBrazePlugin.process(inAppMessage)
. For an example, seeAppDelegate.swift
in our example app.
0.1.1 #
- Formatted
braze_plugin.dart
.
0.1.0 #
- Removes the unused
dart:async
import inbraze_plugin.dart
. - Makes
_callStringMethod
private inbraze_plugin.dart
. - Adds basic dartdoc to the public API interface.
0.0.2 #
- Updates the version of Kotlin used by the Android plugin from
1.2.71
to1.3.11
.
0.0.1 #
- Initial release.
- The native iOS bridge uses Braze iOS SDK 3.12.0.
- The native Android bridge uses Braze Android SDK 3.1.0.