MoEngage Class Reference

sharedInstance
Shared instance of MoEngage class
Declaration
Swift

@objc public static let sharedInstance: MoEngage

Default Instance Initialization


                    
                    
                    initializeDefaultTestInstance(_:)

Initialize Default instance in Debug environment

Declaration

Swift

@objc
public func initializeDefaultTestInstance(_ sdkConfig: MoEngageSDKConfig)

Parameters


                                sdkConfig

Instance of MoEngageSDKConfig


                    
                    
                    initializeDefaultTestInstance(_:sdkState:)

Initialize Default instance in Debug environment with SDK state

Declaration

Swift

@objc
public func initializeDefaultTestInstance(_ sdkConfig: MoEngageSDKConfig, sdkState: MoEngageSDKState)

Parameters

`sdkConfig`	Instance of `MoEngageSDKConfig`
`sdkState`	`MoEngageSDKState` enum that indicates if SDK must be enabled/disabled.


                    
                    
                    initializeDefaultLiveInstance(_:)

Initialize Default Instance in Live environment

Declaration

Swift

@objc
public func initializeDefaultLiveInstance(_ sdkConfig: MoEngageSDKConfig)

Parameters


                                sdkConfig

Instance of MoEngageSDKConfig


                    
                    
                    initializeDefaultLiveInstance(_:sdkState:)

Initialize Default Instance in Live environment with SDK state

Declaration

Swift

@objc
public func initializeDefaultLiveInstance(_ sdkConfig: MoEngageSDKConfig, sdkState: MoEngageSDKState)

Parameters

`sdkConfig`	Instance of `MoEngageSDKConfig`
`sdkState`	`MoEngageSDKState` enum that indicates if SDK must be enabled/disabled.

File Based Instance Initialization


                    
                    
                    initializeDefaultInstance(environement:)

Initialize Default Instance based on Info.plist.

Initialize Default Instance based on MoEngage config parameters provied in Info.plist

Declaration

Swift

@objc
public func initializeDefaultInstance(environement: MoEngageWorkspaceEnvironment = .default)

Parameters


                                environement

MoEngageWorkspaceEnvironment enum that indicates if SDK workspace TEST/LIVE/DEFAULT(Based on Plist data).


                    
                    
                    initializeDefaultInstance(environement:sdkState:)

Initialize Default Instance based on Info.plist with SDK state

Initialize Default Instance based on MoEngage config parameters

Declaration

Swift

@objc
public func initializeDefaultInstance(
    environement: MoEngageWorkspaceEnvironment = .default, sdkState: MoEngageSDKState
)

Parameters

`environement`	`MoEngageWorkspaceEnvironment` enum that indicates if SDK workspace TEST/LIVE/DEFAULT(Based on Plist data).
`sdkState`	`MoEngageSDKState` enum that indicates if SDK must be enabled/disabled.

Secondary Instance Initialization


                    
                    
                    initializeTestInstance(_:)

Initialize Secondary instance in debug environment

Declaration

Swift

@objc
public func initializeTestInstance(_ sdkConfig: MoEngageSDKConfig)

Parameters


                                sdkConfig

Instance of MoEngageSDKConfig


                    
                    
                    initializeTestInstance(_:sdkState:)

Initialize Secondary instance in debug environment with SDK state

Declaration

Swift

@objc
public func initializeTestInstance(_ sdkConfig: MoEngageSDKConfig, sdkState: MoEngageSDKState)

Parameters

`sdkConfig`	Instance of `MoEngageSDKConfig`
`sdkState`	`MoEngageSDKState` enum that indicates if SDK must be enabled/disabled.


                    
                    
                    initializeLiveInstance(_:)

Initialize Secondary Instance in Live environment

Declaration

Swift

@objc
public func initializeLiveInstance(_ sdkConfig: MoEngageSDKConfig)

Parameters


                                sdkConfig

Instance of MoEngageSDKConfig


                    
                    
                    initializeLiveInstance(_:sdkState:)

Initialize Secondary instance in Live environment with SDK state

Declaration

Swift

@objc
public func initializeLiveInstance(_ sdkConfig: MoEngageSDKConfig, sdkState: MoEngageSDKState)

Parameters

`sdkConfig`	Instance of `MoEngageSDKConfig`
`sdkState`	`MoEngageSDKState` enum that indicates if SDK must be enabled/disabled.

SDK Enable/disable methods

enableSDK()
API to enable SDK usage for the account configured as default.
Declaration
Swift

@objc public func enableSDK()


                    
                    
                    enableSDK(appId:)

API to enable SDK usage for the account for Secondary instance

Declaration

Swift

@objc
public func enableSDK(appId: String? = nil)

Parameters


                                appId

MoEngage Account Identifier

disableSDK()
API to disable all features of the SDK for the account configured as default.
Declaration
Swift

@objc public func disableSDK()


                    
                    
                    disableSDK(appId:)

API to disable all features of the SDK for Secondary instance

Declaration

Swift

@objc
public func disableSDK(appId: String? = nil)

Parameters


                                appId

MoEngage Account Identifier