Builder

open class Builder

Initialise MoEngage SDK using this class. Please follow the guidelines mentioned in MoEngage Integration Docs for integrating the MoEngage SDK.

Author

Umang Chamaria

Constructors

Builder

open fun Builder(@NonNull application: Application, @NonNull appId: String)

Builder to initialise MoEngage SDK.

Functions

build

open fun build(): MoEngage

Builds the configuration to initialise MoEngage SDK.

configureCards

open fun configureCards(@NonNull config: CardConfig): MoEngage.Builder

Configure Card feature.

configureDataSync

open fun configureDataSync(@NonNull config: DataSyncConfig): MoEngage.Builder

Optionally configure when the SDK sync collected data.

configureFcm

open fun configureFcm(@NonNull config: FcmConfig): MoEngage.Builder

Configure the Firebase Cloud Messaging.

configureGeofence

open fun configureGeofence(@NonNull config: GeofenceConfig): MoEngage.Builder

Configure Location

configureInApps

open fun configureInApps(@NonNull config: InAppConfig): MoEngage.Builder

Configure InApp

configureLogs

open fun configureLogs(@NonNull config: LogConfig): MoEngage.Builder

Configure logging done by MoEngage SDK

configureMiPush

open fun configureMiPush(@NonNull config: MiPushConfig): MoEngage.Builder

@Deprecated

~~open~~ ~~fun~~ ~~configureMiPush~~(~~appId~~: String, ~~appKey~~: String, ~~enableTokenRegistration~~: Boolean): MoEngage.Builder

Configure Mi Push.

configureNotificationMetaData

open fun configureNotificationMetaData(@NonNull config: NotificationConfig): MoEngage.Builder

Configure Push Notification Meta Data

configurePushKit

open fun configurePushKit(@NonNull config: PushKitConfig): MoEngage.Builder

Configure Push Kit

configureRealTimeTrigger

open fun configureRealTimeTrigger(@NonNull config: RttConfig): MoEngage.Builder

Configure Real Time trigger.

configureTrackingOptOut

open fun configureTrackingOptOut(@NonNull config: TrackingOptOutConfig): MoEngage.Builder

Configure tracking opt-out.

enableEncryption

open fun enableEncryption(): MoEngage.Builder

By default the MoEngage SDK does not add additional encryption on top of https to REST API calls.

enableLogs

@Deprecated

~~open~~ ~~fun~~ ~~enableLogs~~(~~level~~: Int): MoEngage.Builder

Enable SDK logs with the given level.

enableLogsForSignedBuild

@Deprecated

~~open~~ ~~fun~~ ~~enableLogsForSignedBuild~~(): MoEngage.Builder

Enables/Disables MoEngage logs.

enableMultipleNotificationInDrawer

@Deprecated

~~open~~ ~~fun~~ ~~enableMultipleNotificationInDrawer~~(): MoEngage.Builder

By default, the SDK shows only one notification at a given point in time, existing notification is updated with the new notification.

enablePartnerIntegration

open fun enablePartnerIntegration(@NonNull partner: IntegrationPartner): MoEngage.Builder

If you are using MoEngage bundled with any partner integration use this API to notify the partner.

enablePushKitTokenRegistration

@Deprecated

~~open~~ ~~fun~~ ~~enablePushKitTokenRegistration~~(): MoEngage.Builder

By default the MoEngage SDK does not register for Huawei PushKit push token.

enableSegmentIntegration

@Deprecated

~~open~~ ~~fun~~ ~~enableSegmentIntegration~~(): MoEngage.Builder

This API it to notify MoEngage SDK that the app uses MoEngage SDK along with Segment's SDK as a bundle.

optOutBackStackBuilder

@Deprecated

~~open~~ ~~fun~~ ~~optOutBackStackBuilder~~(): MoEngage.Builder

By default MoEngage SDK synthesis the back-stack from the manifest when redirecting user on push click.

optOutInAppOnActivity

@Deprecated

~~open~~ ~~fun~~ ~~optOutInAppOnActivity~~(~~inAppOptOutClassList~~: List<Class>): MoEngage.Builder

By default, the MoEngage SDK will try to show in-app messages on all the activities.

optOutNavBar

@Deprecated

~~open~~ ~~fun~~ ~~optOutNavBar~~(): MoEngage.Builder

By default, the MoEngage SDK hides the top navigation bar when showing in-apps.

optOutNotificationLargeIcon

@Deprecated

~~open~~ ~~fun~~ ~~optOutNotificationLargeIcon~~(): MoEngage.Builder

Optionally remove notification large icon

optOutTokenRegistration

@Deprecated

~~open~~ ~~fun~~ ~~optOutTokenRegistration~~(): MoEngage.Builder

By default the MoEngage SDK registers for push token.

setDataCenter

open fun setDataCenter(@NonNull dataCenter: DataCenter): MoEngage.Builder

Optionally set the data-center to which the data should flow.

setNotificationColor

@Deprecated

~~open~~ ~~fun~~ ~~setNotificationColor~~(@ColorRes ~~color~~: Int): MoEngage.Builder

Set the color for notification.

setNotificationLargeIcon

@Deprecated

~~open~~ ~~fun~~ ~~setNotificationLargeIcon~~(@DrawableRes ~~largeIcon~~: Int): MoEngage.Builder

Set the large icon to be shown in the notification.

setNotificationSmallIcon

@Deprecated

~~open~~ ~~fun~~ ~~setNotificationSmallIcon~~(@DrawableRes ~~smallIcon~~: Int): MoEngage.Builder

Set the small icon to be shown in the notification.

setNotificationTone

@Deprecated

~~open~~ ~~fun~~ ~~setNotificationTone~~(~~tone~~: String): MoEngage.Builder

Set the file name for notification tone.

setSenderId

@Deprecated

~~open~~ ~~fun~~ ~~setSenderId~~(@NonNull ~~senderId~~: String): MoEngage.Builder

Set the sender-id/project id for the FCM project.

setTokenRetryInterval

open fun setTokenRetryInterval(tokenRetryInterval: Long): MoEngage.Builder

Time interval after which SDK retry generating the push token in case of registration failure.