inappmessaging / com.rakuten.tech.mobile.inappmessaging.runtime / InAppMessaging

InAppMessaging

abstract class InAppMessaging

Main entry point for the IAM SDK. Should be accessed via InAppMessaging.instance.

Functions

| logEvent | This methods logs the event which the InAppMessaging SDK checks to know the messages’ triggers are satisfied, then display that message if all trigger conditions are satisfied.abstract fun logEvent(event: Event): Unit | | registerMessageDisplayActivity | This method registers activity where message can be displayed This method should be called in onResume() of the activity to register. In order for InAppMessaging SDK to display messages, host app must pass an Activity which the host app allows the SDK to display any Messages.abstract fun registerMessageDisplayActivity(activity: Activity): Unit | | registerPreference | This method registers provider containing user information userInfoProvider, like RAE Token and Uer ID.abstract fun registerPreference(userInfoProvider: UserInfoProvider): Unit | | unregisterMessageDisplayActivity | This method unregisters the activity from InAppMessaging This method should be called in onPause() of the registered activity in order to avoid memory leaks. If there is message being displayed, it will be closed automatically.abstract fun unregisterMessageDisplayActivity(): Unit | | updateSession | This methods updates the host app’s session. This allows InAppMessaging to update the locally stored messages which can be dependent on user information.abstract fun ~~updateSession~~(): Unit |

Companion Object Functions

| instance | Instance of InAppMessaging.fun instance(): InAppMessaging |