Campaigns

SyneriseSource

Source of an action handled by the SDK (passed to InjectorListener.onOpenUrl and InjectorListener.onDeepLink).

Declared In:
lib/enums/injector/synerise_source.dart

Declaration:

enum SyneriseSource {
  notSpecified('NOT_SPECIFIED'),
  simplePush('SIMPLE_PUSH'),
  inAppMessage('IN_APP_MESSAGE'),
  inlineInAppMessage('INLINE_IN_APP_MESSAGE');
}

Properties:

Functions:

Converts from String to SyneriseSource. Returns SyneriseSource.notSpecified for unknown values.

static SyneriseSource fromString(String string)

InAppMessageData

Model representing an in-app message data.

Declared In:
lib/model/in_app/in_app_message_data.dart

Declaration:

class InAppMessageData

Properties:

InlineInAppMessageData

Model representing inline in-app message data.

Declared In:
lib/model/in_app/inline_in_app_message_data.dart

Declaration:

class InlineInAppMessageData

Properties:

InlineInAppSize

Model representing the component size requested by an inline in-app message through the SRInApp.setComponentSize(width, height) JS method. The same measurement is exposed in three units.

Declared In:
lib/model/in_app/inline_in_app_size.dart

Declaration:

class InlineInAppSize

Properties:

InlineInAppView

Widget that places and renders an inline in-app message for a placement key. For campaigns with the automatic trigger, the SDK requests content as soon as the widget is mounted. For on-demand campaigns, call render() on the attached InlineInAppViewController. The widget fills the constraints given by its parent and has no intrinsic size. Give it bounded constraints (for example a SizedBox with a height). Removing the widget from the tree releases the native view automatically.

Declared In:
lib/modules/injector/inapp/inline_in_app_view.dart

Related To:
InlineInAppViewController
InlineInAppMessageData
InlineInAppSize

Declaration:

typedef InlineInAppViewLoadedCallback = void Function(InlineInAppMessageData data);
typedef InlineInAppViewFailedCallback = void Function(InlineInAppMessageData data, String error);
typedef InlineInAppViewSizeChangedCallback = void Function(InlineInAppMessageData data, InlineInAppSize size);

class InlineInAppView extends StatefulWidget

Properties:

Initializers:

const InlineInAppView({
  super.key,
  required String placementKey,
  String? identifier,
  String? adoptViewId,
  InlineInAppViewController? controller,
  void Function()? onProcessingStarted,
  InlineInAppViewLoadedCallback? onLoaded,
  InlineInAppViewLoadedCallback? onUpdated,
  InlineInAppViewFailedCallback? onFailed,
  InlineInAppViewLoadedCallback? onRemove,
  InlineInAppViewSizeChangedCallback? onSizeChanged,
})

InlineInAppViewController

Controller that drives a mounted InlineInAppView. Pass it as the controller parameter of the widget.

Declared In:
lib/modules/injector/inapp/inline_in_app_view.dart

Related To:
InlineInAppView
InlineInAppMessageData

Declaration:

class InlineInAppViewController

Initializers:

InlineInAppViewController()

Functions:

Triggers rendering for the current placement. Use it for campaigns with the on-demand trigger. If the native view is not attached yet, the render is deferred and applied as soon as the view becomes ready.

Future<void> render()

Tears down the inline in-app message (destroys the web view and clears the campaign data) while the widget stays mounted.

Future<void> release()

Resolves true when the widget currently shows a rendered campaign. Resolves false when the widget is not mounted or holds no rendered campaign.

Future<bool> isRendered()

Resolves the data of the campaign currently shown in the widget. Resolves null when the widget is not mounted or holds no rendered campaign.

Future<InlineInAppMessageData?> getData()

InjectorInlineInAppMessageListener

Listener for inline in-app message campaigns. Configure it with Synerise.injector.inlineInAppMessageListener(listenerFunction), which also enables the native global listener. Remove it with Synerise.injector.removeInlineInAppListener(). It handles actions from inline in-app messages and delivers widgets created by the SDK for event-triggered campaigns.

Declared In:
lib/modules/injector/inapp/in_app_impl.dart

Related To:
InlineInAppView
InlineInAppMessageData
InAppCustomMethodCompletion

Declaration:

typedef InjectorInlineInAppMessageListenerFunction = void Function(InjectorInlineInAppMessageListener listener);

class InjectorInlineInAppMessageListener

Properties:

Initializers:

InjectorInlineInAppMessageListener()

InAppCustomMethodCompletion

Completion handler used to resolve a custom method invoked from an in-app message (overlay and inline). Resolve it exactly once. The first resolution wins and later calls are ignored.

Declared In:
lib/model/in_app/in_app_custom_method_completion.dart

Declaration:

class InAppCustomMethodCompletion

Functions:

Resolves the pending in-app message JS Promise with a result. result is optional. Its accepted type depends on the message type:

• overlay in-app messages: any JSON-serializable value
• inline in-app messages: Map<String, dynamic>. Any other value reaches the JS Promise as null

void success(Object? result)

Rejects the pending in-app message JS Promise with an error message.

void failure(String errorMessage)

InAppContextKey

Well-known keys of Synerise.injector.inAppContext. Use them as map keys, for example Synerise.injector.inAppContext[InAppContextKey.jinjavaContext] = {'tier': 'gold'};

Declared In:
lib/enums/injector/in_app_context_key.dart

Declaration:

class InAppContextKey

Properties: