MoEngage Class Reference


                    
                    
                    sharedInstance

Shared instance of MoEngage class

Declaration

Swift

@objc
public static var sharedInstance: MoEngage { get }

Default Instance Initialization


                    
                    
                    initializeDefaultTestInstance(_:)

Initialize Default instance in Debug environment

Declaration

Swift

@discardableResult
@objc
public func initializeDefaultTestInstance(_ sdkConfig: sending MoEngageSDKConfig) -> MoEngageInitializeSDKTask

Parameters


                                sdkConfig

Instance of MoEngageSDKConfig

Return Value

MoEngageInitializeSDKTask carrying MoEngageInitResult on success. onFailure fires when config parsing fails — the failure’s reason is a MoEngageCoreRequestFailureReason carrying moduleCode == .invalidInitialisationConfiguration (base reason.code == .unknownError; downcast for the precise discriminator via (failure.reason as? MoEngageCoreRequestFailureReason)?.moduleCode). Marked @discardableResult so existing fire-and-forget callers compile unchanged.


                    
                    
                    initializeDefaultTestInstance(_:sdkState:)

Initialize Default instance in Debug environment with SDK state

Declaration

Swift

@discardableResult
@objc
public func initializeDefaultTestInstance(_ sdkConfig: sending MoEngageSDKConfig, sdkState: MoEngageSDKState) -> MoEngageInitializeSDKTask

Parameters

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

Return Value

MoEngageInitializeSDKTask — see initializeDefaultTestInstance(_:).


                    
                    
                    initializeDefaultLiveInstance(_:)

Initialize Default Instance in Live environment

Declaration

Swift

@discardableResult
@objc
public func initializeDefaultLiveInstance(_ sdkConfig: sending MoEngageSDKConfig) -> MoEngageInitializeSDKTask

Parameters


                                sdkConfig

Instance of MoEngageSDKConfig

Return Value

MoEngageInitializeSDKTask — see initializeDefaultTestInstance(_:).


                    
                    
                    initializeDefaultLiveInstance(_:sdkState:)

Initialize Default Instance in Live environment with SDK state

Declaration

Swift

@discardableResult
@objc
public func initializeDefaultLiveInstance(_ sdkConfig: sending MoEngageSDKConfig, sdkState: MoEngageSDKState) -> MoEngageInitializeSDKTask

Parameters

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

Return Value

MoEngageInitializeSDKTask — see initializeDefaultTestInstance(_:).

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

@discardableResult
@objc
public func initializeDefaultInstance(environement: MoEngageWorkspaceEnvironment = .default) -> MoEngageInitializeSDKTask

Parameters


                                environement

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

Return Value

MoEngageInitializeSDKTask carrying MoEngageInitResult(configSource: .file) on success.


                    
                    
                    initializeDefaultInstance(environement:sdkState:)

Initialize Default Instance based on Info.plist with SDK state

Initialize Default Instance based on MoEngage config parameters

Declaration

Swift

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

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.

Return Value

MoEngageInitializeSDKTask — see initializeDefaultInstance(environement:).

Secondary Instance Initialization


                    
                    
                    initializeTestInstance(_:)

Initialize Secondary instance in debug environment

Declaration

Swift

@discardableResult
@objc
public func initializeTestInstance(_ sdkConfig: sending MoEngageSDKConfig) -> MoEngageInitializeSDKTask

Parameters


                                sdkConfig

Instance of MoEngageSDKConfig

Return Value

MoEngageInitializeSDKTask — see initializeDefaultTestInstance(_:).


                    
                    
                    initializeTestInstance(_:sdkState:)

Initialize Secondary instance in debug environment with SDK state

Declaration

Swift

@discardableResult
@objc
public func initializeTestInstance(_ sdkConfig: sending MoEngageSDKConfig, sdkState: MoEngageSDKState) -> MoEngageInitializeSDKTask

Parameters

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

Return Value

MoEngageInitializeSDKTask — see initializeDefaultTestInstance(_:).


                    
                    
                    initializeLiveInstance(_:)

Initialize Secondary Instance in Live environment

Declaration

Swift

@discardableResult
@objc
public func initializeLiveInstance(_ sdkConfig: sending MoEngageSDKConfig) -> MoEngageInitializeSDKTask

Parameters


                                sdkConfig

Instance of MoEngageSDKConfig

Return Value

MoEngageInitializeSDKTask — see initializeDefaultTestInstance(_:).


                    
                    
                    initializeLiveInstance(_:sdkState:)

Initialize Secondary instance in Live environment with SDK state

Declaration

Swift

@discardableResult
@objc
public func initializeLiveInstance(_ sdkConfig: sending MoEngageSDKConfig, sdkState: MoEngageSDKState) -> MoEngageInitializeSDKTask

Parameters

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

Return Value

MoEngageInitializeSDKTask — see initializeDefaultTestInstance(_:).

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

SDK Event Observer


                    
                    
                    registerSDKEventObserver(_:forWorkspaceId:)

Register an observer to receive SDK-autonomous events (e.g. background batch sync results) for a workspace. Observers are held strongly until unregisterSDKEventObserver is called or the instance is torn down. Call after SDK init for the target workspace.

Note

Registration is eventually consistent — the call hops to the instance actor before the observer is installed. An event fired in the small window immediately after this call returns may not reach the observer.

Declaration

Swift

@objc
public func registerSDKEventObserver(
    _ observer: MoEngageSDKEventObserver, forWorkspaceId workspaceId: String? = nil
)

Parameters

`observer`	The observer to register.
`workspaceId`	Target workspace; `nil` for the default instance.


                    
                    
                    unregisterSDKEventObserver(_:forWorkspaceId:)

Unregister a previously-registered observer. Removes a single registration; if the same observer was registered N times, paired unregister calls are needed.

Declaration

Swift

@objc
public func unregisterSDKEventObserver(
    _ observer: MoEngageSDKEventObserver, forWorkspaceId workspaceId: String? = nil
)

Parameters

`observer`	The observer to remove.
`workspaceId`	The workspace previously registered for; `nil` for default.


                    
                    
                    sdkEventStream(forWorkspaceId:)

Async stream of SDK-autonomous events for the workspace. Concurrency-first counterpart to registerSDKEventObserver. Each stream is an independent consumer. Finishes when the instance is torn down; pre-init calls return an immediately-finished stream. Swift-only; ObjC consumers use the delegate API.

Declaration

Swift

public func sdkEventStream(
    forWorkspaceId workspaceId: String? = nil
) -> AsyncStream<MoEngageSDKEvent>

Parameters


                                workspaceId

Target workspace; nil for the default instance.