core/com.moengage.core/MoEngage/Builder

Builder

class Builder(application: Application, val appId: String, dataCenter: DataCenter)

Create an instance of MoEngage.Builder

Since

12.8.00

Parameters

application

instance of Application

appId

Account identifier for MoEngage Account.

dataCenter

Data Center to which the data should flow.

Constructors

Link copied to clipboard
constructor(application: Application, appId: String)

Create an instance of MoEngage.Builder

constructor(application: Application, appId: String, dataCenter: DataCenter)

Properties

Link copied to clipboard
val appId: String
Link copied to clipboard
val initConfig: InitConfig

Functions

Link copied to clipboard
fun build(): MoEngage

Builds the configuration to initialise MoEngage SDK. With the returned object, call MoEngage.initialiseDefaultInstance if you want to initialize sdk as default instance, otherwise call MoEngage.initialiseInstance

Link copied to clipboard
fun configureCards(config: CardConfig): MoEngage.Builder

Configure Card feature.

Link copied to clipboard
fun configureDataSync(config: DataSyncConfig): MoEngage.Builder

Optionally configure when the SDK sync collected data.

Link copied to clipboard
fun configureFcm(config: FcmConfig): MoEngage.Builder

Configure the Firebase Cloud Messaging.

Link copied to clipboard
fun configureInApps(config: InAppConfig): MoEngage.Builder

Configure InApp

Link copied to clipboard
fun configureLogs(config: LogConfig): MoEngage.Builder

Configure logging done by MoEngage SDK

Link copied to clipboard
fun configureNetworkRequest(config: NetworkRequestConfig): MoEngage.Builder

By default, the MoEngage SDK does not add additional security on top of https to REST API calls. In case you want the MoEngage SDK to add additional security in the network request use this API to configure the request.

Link copied to clipboard
fun configureNotificationMetaData(config: NotificationConfig): MoEngage.Builder

Configure Push Notification Meta Data

Link copied to clipboard
fun configurePushKit(config: PushKitConfig): MoEngage.Builder

Configure Push Kit

Link copied to clipboard
fun configureRealTimeTrigger(config: RttConfig): MoEngage.Builder

Configure Real Time trigger.

Link copied to clipboard
fun configureStorageSecurity(config: StorageSecurityConfig): MoEngage.Builder

Configure encryption feature of the MoEngage SDK. This configuration is used to enable encryption of data temporarily stored on the end users device. Once enabled it cannot be reverted. If enabled make sure to add the com:moengage:encrypted-storage artifact.

Link copied to clipboard
fun configureTrackingOptOut(config: TrackingOptOutConfig): MoEngage.Builder

Configure tracking opt-out.

Link copied to clipboard
fun configureUserRegistration(config: UserRegistrationConfig): MoEngage.Builder

Configure User Registration

Link copied to clipboard
fun enablePartnerIntegration(partner: IntegrationPartner): MoEngage.Builder

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

Link copied to clipboard
fun setDataCenter(dataCenter: DataCenter): MoEngage.Builder

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

Link copied to clipboard
fun setTokenRetryInterval(tokenRetryInterval: Long): MoEngage.Builder

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