Campaigns

Set In-App listener

Sets inAppListener to injector.

Method name:
Injector.setOnInAppListener(OnInAppListener listener)

Declaration:

public static void setOnInAppListener(OnInAppListener listener)

Parameters:

Return Value:
No value returned.

Example:

Injector.setOnInAppListener(listener);

Injector.setOnInAppListener(listener)

Remove In-App listener

Removes inAppListener from injector. Method name:
Injector.removeInAppListener()

Declaration:

public static void removeInAppListener()

Parameters:
No parameters.

Return Value:
No value returned.

Example:

Injector.removeInAppListener();

Injector.removeInAppListener()

Close in-app message

Closes an in-app message and sends an inApp.discard event.

Usage examples:

• Closing a top bar or bottom bar when the user taps outside the in-app area.
• Automatically dismissing messages when navigating away from a screen.
• Controlling in-app visibility based on app logic for a smoother user experience.

Method name:
Injector.closeInAppMessage(campaignHash)

Declaration:

public static void closeInAppMessage(String campaignHash)

Parameters:

Return value:
No value returned.

Example:

Injector.closeInAppMessage(campaignHash);

Injector.closeInAppMessage(campaignHash)

Set Inline In-App listener

Sets the global listener for inline in-app message events.

Method name:
Injector.setOnInlineInAppListener(OnInlineInAppListener listener)

Declaration:

public static void setOnInlineInAppListener(OnInlineInAppListener listener)

Parameters:

Return Value:
No value returned.

Example:

Injector.setOnInlineInAppListener(listener);

Injector.setOnInlineInAppListener(listener)

Remove Inline In-App listener

Removes the global inline in-app message listener from injector. Method name:
Injector.removeInlineInAppListener()

Declaration:

public static void removeInlineInAppListener()

Parameters:
No parameters.

Return Value:
No value returned.

Example:

Injector.removeInlineInAppListener();

Injector.removeInlineInAppListener()

Create Inline In-App view

Creates an inline in-app message view for a given placement key. The returned view must be embedded into the app's view hierarchy by the application.

Method name:
Injector.createInlineInAppView(Context context, String placementKey)

Declaration:

public static InlineInAppView createInlineInAppView(Context context, String placementKey)

Parameters:

Return Value:
InlineInAppView object.

Example:

InlineInAppView inlineView = Injector.createInlineInAppView(context, "home_top_banner");

val inlineView = Injector.createInlineInAppView(context, "home_top_banner")

Notify In-App context change

Notifies all active in-app message components that the global context has changed. After this call, the SDK invokes SRInApp.onContextFromApp(context) in each active in-app message. Method name:
Injector.notifyInAppContextChange()

Declaration:

public static void notifyInAppContextChange()

Parameters:
No parameters.

Return Value:
No value returned.

Example:

Injector.inAppContext = context;
Injector.notifyInAppContextChange();

Injector.inAppContext = context
Injector.notifyInAppContextChange()

Get Inline In-App view identifier

Returns the free-form identifier attached to this view by the application. Not used by the SDK. Method name:
InlineInAppView.getIdentifier()

Declaration:

public String getIdentifier()

Parameters:
No parameters.

Return Value:
String identifier or null.

Example:

String identifier = inlineView.getIdentifier();

val identifier = inlineView.getIdentifier()

Set Inline In-App view identifier

Sets a free-form identifier on the view. The identifier is not used by the SDK — it exists so the application can tell multiple InlineInAppView instances apart.

Method name:
InlineInAppView.setIdentifier(String)

Declaration:

public void setIdentifier(String identifier)

Parameters:

Return Value:
No value returned.

Example:

inlineView.setIdentifier("home_top");

inlineView.setIdentifier("home_top")

Check if Inline In-App view is rendered

Returns whether an inline in-app message campaign is currently rendered in this view. Method name:
InlineInAppView.isRendered()

Declaration:

public boolean isRendered()

Parameters:
No parameters.

Return Value:
true if a campaign is currently rendered in this view, false otherwise.

Example:

boolean rendered = inlineView.isRendered();

val rendered = inlineView.isRendered()

Get Inline In-App view placement key

Returns the placement key this view is bound to. Method name:
InlineInAppView.getPlacementKey()

Declaration:

public String getPlacementKey()

Parameters:
No parameters.

Return Value:
String — the placement key this view is bound to, or null if none was set.

Example:

String placementKey = inlineView.getPlacementKey();

val placementKey = inlineView.getPlacementKey()

Render Inline In-App view

Triggers on-demand rendering of content in an inline in-app view. Use this method when the campaign trigger type is set to "on demand". Method name:
InlineInAppView.render()

Declaration:

public void render()

Parameters:
No parameters.

Return Value:
No value returned.

Example:

inlineView.render();

inlineView.render()

Get Inline In-App view data

Returns the data of the currently loaded inline in-app message campaign. Method name:
InlineInAppView.getData()

Declaration:

public InlineInAppMessageData getData()

Parameters:
No parameters.

Return Value:
InlineInAppMessageData object or null.

Example:

InlineInAppMessageData data = inlineView.getData();

val data = inlineView.getData()

Release Inline In-App view

Releases the resources held by the inline in-app view, including the WebView and campaign state, and unregisters the component from the SDK. Call this method before removing the view from the hierarchy. Method name:
InlineInAppView.release()

Declaration:

public void release()

Parameters:
No parameters.

Return Value:
No value returned.

Example:

inlineView.release();
ViewGroup parent = (ViewGroup) inlineView.getParent();
if (parent != null) {
    parent.removeView(inlineView);
}
inlineView = null;

inlineView?.release()
(inlineView?.parent as? ViewGroup)?.removeView(inlineView)
inlineView = null

Set Inline In-App View listener

Sets a per-view listener for the lifecycle of an inline in-app message (loaded, updated, failed, size changed, removed).

Method name:
InlineInAppView.setOnInlineInAppViewListener(OnInlineInAppViewListener listener)

Declaration:

public void setOnInlineInAppViewListener(OnInlineInAppViewListener listener)

Parameters:

Return Value:
No value returned.

Example:

inlineView.setOnInlineInAppViewListener(new OnInlineInAppViewListener() {
    @Override
    public void onProcessingStarted() { }

    @Override
    public void onLoaded(InlineInAppMessageData data) { }

    @Override
    public void onUpdated(InlineInAppMessageData data) { }

    @Override
    public void onFailed(InlineInAppMessageData data, String error) { }

    @Override
    public void onSizeChanged(InlineInAppMessageData data, InlineInAppSize size) { }

    @Override
    public void onRemove(InlineInAppMessageData data) { }
});

inlineView.setOnInlineInAppViewListener(object : OnInlineInAppViewListener {
    override fun onProcessingStarted() { }
    override fun onLoaded(data: InlineInAppMessageData) { }
    override fun onUpdated(data: InlineInAppMessageData) { }
    override fun onFailed(data: InlineInAppMessageData, error: String) { }
    override fun onSizeChanged(data: InlineInAppMessageData, size: InlineInAppSize) { }
    override fun onRemove(data: InlineInAppMessageData) { }
})

Register for push notifications

This method passes the Firebase Token to Synerise for notifications.

Method name:
Client.registerForPush(firebaseId, mobilePushAgreement)

Declaration:

public static IApiCall registerForPush(@NonNull String firebaseId, boolean mobilePushAgreement)

fun registerForPush(@NonNull firebaseId:String, mobilePushAgreement:boolean):IApiCall

Parameters:

Return Value:
IApiCall object to execute the request.

Example:

IApiCall call = Client.registerForPush(refreshedToken, true);
            call.execute(() -> Log.d(TAG, "Register for Push succeed: " + refreshedToken),
                         apiError -> Log.w(TAG, "Register for push failed: " + refreshedToken));

val call = Client.registerForPush(refreshedToken, true)
call.execute({ Log.d(TAG, "Register for Push succeed: " + refreshedToken) },
             { apiError-> Log.w(TAG, "Register for push failed: " + refreshedToken) })

Register for push notifications without agreement

This method passes the Firebase Token to Synerise for notifications and doesn't update the agreement of the profile.

Method name:
Client.registerForPush(firebaseId)

Declaration:

public static IApiCall registerForPush(@NonNull String firebaseId)

fun registerForPush(@NonNull firebaseId:String):IApiCall

Parameters:

Return Value:
IApiCall object to execute the request.

Example:

IApiCall call = Client.registerForPush(refreshedToken);
            call.execute(() -> Log.d(TAG, "Register for Push succeed: " + refreshedToken),
                         apiError -> Log.w(TAG, "Register for push failed: " + refreshedToken));

val call = Client.registerForPush(refreshedToken)
call.execute({ Log.d(TAG, "Register for Push succeed: " + refreshedToken) },
             { apiError-> Log.w(TAG, "Register for push failed: " + refreshedToken) })

Check if push notification is from Synerise

This method verifies if a notification was sent by Synerise.

Method name:
Injector.isSynerisePush(pushPayload);

Declaration:

public static boolean isSynerisePush(Map<String, String> pushPayload)

Parameters:

Return Value:
Boolean indicating if the incoming push contains an "issuer" key with the "Synerise" value.

Example:

boolean isSynerisePush = Injector.isSynerisePush(data);

var isSynerisePush = Injector.isSynerisePush(data)

Check if push notification is a Simple Push Campaign

This method verifies if a notification’s sender is Synerise and if the notification is a Simple Push campaign

Method name:
Injector.isSyneriseSimplePush(pushPayload);

Declaration:

public static boolean isSyneriseSimplePush(Map<String, String> pushPayload)

Parameters:

Return Value:
Boolean indicating if the incoming push contains a "content-type" key with the "simple-push" value.

Example:

boolean isSyneriseSimplePush = Injector.isSyneriseSimplePush(data);

var isSyneriseSimplePush = Injector.isSyneriseSimplePush(data)

Check if push notification is a Silent Command

This method verifies if a notification’s sender is Synerise and if the notification is a Silent Command.

Method name:
Injector.isSilentCommand(pushPayload);

Declaration:

public static boolean isSilentCommand(Map<String, String> pushPayload)

Parameters:

Return Value:
Boolean indicating if the incoming push contains a "content-type" key with the "silent-command" value.

Example:

boolean isSilentCommand = Injector.isSilentCommand(data);

var isSilentCommand = Injector.isSilentCommand(data)

Get a Silent Command

Method that converts push payload into a SilentCommand object.

Method name:
Injector.getSilentCommand(payload);

Declaration:

public static SilentCommand getSilentCommand(Map<String, String> payload) throws ValidationException

Parameters:

Return Value:
SilentCommand object, may be null if the payload is not a SilentCommand payload.

Example:

try {
    SilentCommand silentCommand = Injector.getSilentCommand(payload);
} catch (ValidationException e) {
    // handle the invalid payload
}

var silentCommand = Injector.getSilentCommand(payload)

Check if push notification is a Silent SDK Command

This method verifies if a notification's sender is Synerise and if the notification is a Silent SDK Command.

Method name:
Injector.isSilentCommandSdk(pushPayload);

Declaration:

public static boolean isSilentCommandSdk(Map<String, String> pushPayload)

Parameters:

Return Value:
Boolean indicating if the incoming push contains a "content-type" key with the "silent-sdk-command" value.

Example:

boolean isSilentCommandSdk = Injector.isSilentCommandSdk(data);

var isSilentCommandSdk = Injector.isSilentCommandSdk(data)

Check if push notification is encrypted

This method verifies if a notification is encrypted.

Method name:
Injector.isPushEncrypted(pushPayload);

Declaration:

public static boolean isPushEncrypted(Map<String, String> pushPayload)

Parameters:

Return Value:
Boolean indicating if the incoming push is encrypted by Synerise.

Example:

boolean isPushEncrypted = Injector.isPushEncrypted(data);

var isPushEncrypted = Injector.isPushEncrypted(data)

Decrypt push notification

This method decrypts the notification payload.

Method name:
Injector.decryptPushPayload(pushPayload);

Declaration:

public static Map<String, String> decryptPushPayload(Map<String, String> pushPayload) throws DecryptionException

Parameters:

Return Value:
Key-Value map of data with the decrypted push.

Example:

try {
    Map<String, String> decrypted = Injector.decryptPushPayload(data);
} catch (DecryptionException e) {
    // handle the decryption failure
}

try {
    val decrypted = Injector.decryptPushPayload(data)
} catch (e: DecryptionException) {
    // handle the decryption failure
}

Handle Synerise push notification

This method handles a notification payload and starts activity.

Method name:
Injector.handlePushPayload(pushPayload);

Declaration:

public static boolean handlePushPayload(Bundle bundle)
public static boolean handlePushPayload(Map<String, String> pushPayload)

Parameters:

Return Value:
Boolean indicating if the incoming push contains an "issuer" key with the value "Synerise".

Example:

boolean isSynerisePush = Injector.handlePushPayload(getIntent().getExtras());

var isSynerisePush = Injector.handlePushPayload(getIntent().getExtras())

Get pushes

This method fetches Push Notifications set for mobile campaigns.

Method name:
Injector.getPushes();

Declaration:

public static IDataApiCall<List<SynerisePushResponse>> getPushes()

Parameters:
No parameters.

Return Value:
IDataApiCall<List<SynerisePushResponse>> with a parameterized list of SynerisePushResponse to execute a request.

Example:

IDataApiCall<List<SynerisePushResponse>> apiCall = Injector.getPushes();
        apiCall.execute(this::success, this::showAlertError);

val apiCall = Injector.getPushes()
apiCall.execute(({ this.success() }), ({ this.showAlertError() }))

Removed methods

Check if push notification is a Banner Campaign

This method verifies if a notification’s sender is Synerise and if the notification is a Banner campaign.

Method name:
Injector.isSyneriseBanner(pushPayload);

Declaration:

public static boolean isSyneriseBanner(Map<String, String> pushPayload)

Parameters:

Return Value:
Boolean indicating if the incoming push contains a "content-type" key with the "template-banner" value.

Example:

boolean isSyneriseBanner = Injector.isSyneriseBanner(data);

var isSyneriseBanner = Injector.isSyneriseBanner(data)

Fetch Banners

This method fetches banners set for mobile campaigns and caches the valid ones.

Method name:
Injector.fetchBanners(successListener, errorListener);

Declaration:

public static void fetchBanners()
public static void fetchBanners(@NonNull final DataActionListener<List<TemplateBanner>> successListener,
                                    @NonNull final DataActionListener<ApiError> errorListener)

Parameters:

Return Value:
No value is returned.

Example:

Injector.fetchBanners();

Injector.fetchBanners();

Get Banners

This method provides valid banners directly from SDK cache.

Method name:
Injector.getBanners();

Declaration:

public static List<TemplateBanner> getBanners()

Parameters:
No parameters.

Return Value:
List<TemplateBanner> of cached banners.

Example:

List<TemplateBanner> bannerList = Injector.getBanners();

var bannerList = Injector.getBanners()

Show Banner

This method shows a banner immediately.

Method name:
Injector.showBanner(banner, markPresented);

Declaration:

public static void showBanner(TemplateBanner banner, boolean markPresented)

Parameters:

Return Value:
No value returned.

Example:

Injector.showBanner(banner, markPresented);

Injector.showBanner(banner, markPresented)

Get Walkthrough

This method fetches a walkthrough.

Method name:
Injector.getWalkthrough();

Declaration:

public static void getWalkthrough()

Parameters:
No parameters.

Return Value:
No return value.

Example:

Injector.getWalkthrough();

Injector.getWalkthrough()

Show Walkthrough

This method shows a walkthrough when it is loaded.

Method name:
Injector.showWalkthrough();

Declaration:

public static boolean showWalkthrough()

Parameters:
No parameters.

Return Value:
Boolean value is returned. true if the loaded or cached Walkthrough was presented, false otherwise.

Example:

Injector.showWalkthrough();

Injector.showWalkthrough()

Check if Walkthrough is loaded

This method checks if a walkthrough is loaded.

Method name:
Injector.isWalkthroughLoaded();

Declaration:

public static boolean isWalkthroughLoaded()

Parameters:
No parameters.

Return Value:
Boolean value is returned. true if Walkthrough is already loaded, false otherwise.

Example:

Boolean isWalkthroughLoaded = Injector.isWalkthroughLoaded();

var isWalkthroughLoaded = Injector.isWalkthroughLoaded()

Check if loaded Walkthrough is unique

This method checks if the walkthrough is unique compared to the previous one.

Method name:
Injector.isLoadedWalkthroughUnique();

Declaration:

public static boolean isLoadedWalkthroughUnique()

Parameters:
No parameters.

Return Value:
Returns true if the loaded Walkthrough is loaded and different than previously presented, false otherwise.

Example:

Boolean isWalkthroughLoadedUnique = Injector.isLoadedWalkthroughUnique();

var isWalkthroughLoadedUnique = Injector.isLoadedWalkthroughUnique()

Set Banner listener

Set your own banner listener to receive optional callbacks.
Instantiate OnBannerListener and override the desired callbacks.

Method name:
Injector.setOnBannerListener(banner, markPresented);

Declaration:

public static void setOnBannerListener(OnBannerListener listener)

Parameters:

Return Value:
No value returned.

Example:

Injector.setOnBannerListener(listener);

Injector.setOnBannerListener(listener)

Remove Banner listener

Remove banner listener to stop receiving callbacks.
It is recommended to call this method when your Activity is stopped.

Method name:
Injector.removeBannerListener();

Declaration:

public static void removeBannerListener()

Parameters:
No parameters.

Return Value:
No value returned.

Example:

Injector.removeBannerListener();

Injector.removeBannerListener()