MoEngageSDKInbox

@objc
public class MoEngageSDKInbox : NSObject, @unchecked Sendable

Class to configure the Inbox

Concurrency

@unchecked Sendable: the singleton holds no mutable state — every method is a stateless dispatcher into MoEngageAction. Mirrors MoEngageSDKCards.


                    
                    
                    sharedInstance

Singleton instance

Declaration

Swift

@objc
public static let sharedInstance: MoEngageSDKInbox

Inbox Methods


                    
                    
                    getInboxMessages(forAppID:isolation:withCompletionBlock:)

Fetch inbox messages.

Declaration

Swift

public func getInboxMessages(
    forAppID appID: String? = nil,
    isolation actor: isolated (any Actor)? = #isolation,
    withCompletionBlock completionBlock: @escaping @MainActor(unsafe) ([MoEngageInboxEntry], MoEngageAccountMeta?) -> Void
)

Parameters

`appID`	MoEngage Account Identifier.
`isolation`	The caller’s actor isolation, captured automatically.
`completionBlock`	completion block with inbox messages and account information, invoked on the main thread.


                    
                    
                    getInboxMessages(forAppID:withCompletionBlock:)

Declaration

Swift

@_disfavoredOverload
@objc
public func getInboxMessages(forAppID appID: String? = nil, withCompletionBlock completionBlock: @escaping @MainActor (Array<MoEngageInboxEntry>, MoEngageAccountMeta?) -> Void)


                    
                    
                    getAllNotificationCount(forAppID:isolation:withCompletionBlock:)

Fetch inbox message count

Declaration

Swift

public func getAllNotificationCount(
    forAppID appID: String? = nil,
    isolation actor: isolated (any Actor)? = #isolation,
    withCompletionBlock completionBlock: @escaping @MainActor(unsafe) (Int, MoEngageAccountMeta?) -> Void
)

Parameters

`appID`	MoEngage Account Identifier.
`isolation`	The caller’s actor isolation, captured automatically.
`completionBlock`	completion block with inbox message count and account information, invoked on the main thread.


                    
                    
                    getAllNotificationCount(forAppID:withCompletionBlock:)

Declaration

Swift

@_disfavoredOverload
@objc
public func getAllNotificationCount(forAppID appID: String? = nil, withCompletionBlock completionBlock: @escaping @MainActor (Int, MoEngageAccountMeta?) -> Void)


                    
                    
                    getUnreadNotificationCount(forAppID:isolation:withCompletionBlock:)

Fetch unread inbox message count.

Declaration

Swift

public func getUnreadNotificationCount(
    forAppID appID: String? = nil,
    isolation actor: isolated (any Actor)? = #isolation,
    withCompletionBlock completionBlock: @escaping @MainActor(unsafe) (Int, MoEngageAccountMeta?) -> Void
)

Parameters

`appID`	MoEngage Account Identifier.
`isolation`	The caller’s actor isolation, captured automatically.
`completionBlock`	completion block with unread message count and account information, invoked on the main thread.


                    
                    
                    getUnreadNotificationCount(forAppID:withCompletionBlock:)

Declaration

Swift

@_disfavoredOverload
@objc
public func getUnreadNotificationCount(forAppID appID: String? = nil, withCompletionBlock completionBlock: @escaping @MainActor (Int, MoEngageAccountMeta?) -> Void)


                    
                    
                    processInboxNotification(withCampaignID:forAppID:isolation:)

Perform the action associated with Inbox message

Declaration

Swift

public func processInboxNotification(
    withCampaignID cid: String,
    forAppID appID: String? = nil,
    isolation actor: isolated (any Actor)? = #isolation
)

Parameters

`cid`	campaign Identifier of the inbox message
`appID`	MoEngage Account Identifier.
`isolation`	The caller’s actor isolation, captured automatically.


                    
                    
                    processInboxNotification(withCampaignID:forAppID:)

Declaration

Swift

@_disfavoredOverload
@objc
public func processInboxNotification(withCampaignID cid: String, forAppID appID: String? = nil)


                    
                    
                    markInboxNotificationClicked(withCampaignID:forAppID:isolation:completionHandler:)

Mark the inbox message as Clicked and Read.

Declaration

Swift

public func markInboxNotificationClicked(
    withCampaignID cid: String,
    forAppID appID: String? = nil,
    isolation actor: isolated (any Actor)? = #isolation,
    completionHandler: (@MainActor(unsafe) (Bool) -> Void)? = nil
)

Parameters

`cid`	campaign Identifier of the inbox message
`appID`	MoEngage Account Identifier.
`isolation`	The caller’s actor isolation, captured automatically.
`completionHandler`	completion block with Bool value indicating the status of update, invoked on the main thread.


                    
                    
                    markInboxNotificationClicked(withCampaignID:forAppID:completionHandler:)

Declaration

Swift

@_disfavoredOverload
@objc
public func markInboxNotificationClicked(withCampaignID cid: String, forAppID appID: String? = nil, completionHandler: (@MainActor (Bool) -> Void)? = nil)


                    
                    
                    trackInboxClick(withCampaignID:forAppID:isolation:)

Track Inbox clicked event

Declaration

Swift

public func trackInboxClick(
    withCampaignID cid: String,
    forAppID appID: String? = nil,
    isolation actor: isolated (any Actor)? = #isolation
)

Parameters

`cid`	campaign Identifier of the inbox message
`appID`	MoEngage Account Identifier.
`isolation`	The caller’s actor isolation, captured automatically.


                    
                    
                    trackInboxClick(withCampaignID:forAppID:)

Declaration

Swift

@_disfavoredOverload
@objc
public func trackInboxClick(withCampaignID cid: String, forAppID appID: String? = nil)


                    
                    
                    removeInboxMessage(withCampaignID:forAppID:isolation:completionHandler:)

Remove inbox message based on Campaign id

Declaration

Swift

public func removeInboxMessage(
    withCampaignID cid: String,
    forAppID appID: String? = nil,
    isolation actor: isolated (any Actor)? = #isolation,
    completionHandler: (@MainActor(unsafe) (Bool) -> Void)? = nil
)

Parameters

`cid`	Campaign Identifier of the inbox message
`appID`	MoEngage Account Identifier.
`isolation`	The caller’s actor isolation, captured automatically.
`completionHandler`	Completion block with Bool value indicating the status of update, invoked on the main thread.


                    
                    
                    removeInboxMessage(withCampaignID:forAppID:completionHandler:)

Declaration

Swift

@_disfavoredOverload
@objc
public func removeInboxMessage(withCampaignID cid: String, forAppID appID: String? = nil, completionHandler: (@MainActor (Bool) -> Void)? = nil)


                    
                    
                    removeInboxMessages(forAppID:isolation:completionHandler:)

Remove all inbox messages

Declaration

Swift

public func removeInboxMessages(
    forAppID appID: String? = nil,
    isolation actor: isolated (any Actor)? = #isolation,
    completionHandler: (@MainActor(unsafe) (Bool) -> Void)? = nil
)

Parameters

`appID`	MoEngage Account Identifier.
`isolation`	The caller’s actor isolation, captured automatically.
`completionHandler`	Completion block with Bool value indicating the status of update, invoked on the main thread.


                    
                    
                    removeInboxMessages(forAppID:completionHandler:)

Declaration

Swift

@_disfavoredOverload
@objc
public func removeInboxMessages(forAppID appID: String? = nil, completionHandler: (@MainActor (Bool) -> Void)? = nil)

Delegate Setup


                    
                    
                    setInboxDelegate(delegate:forAppID:isolation:)

Set the inbox delegate to receive the callback on actions performed on MoEngageInboxViewController

Declaration

Swift

public func setInboxDelegate(
    delegate: MoEngageInboxStatusDelegate,
    forAppID appID: String? = nil,
    isolation actor: isolated (any Actor)? = #isolation
)

Parameters

`delegate`	Instance that confirms to `MoEngageInboxStatusDelegate` protocol.
`appID`	MoEngage Account Identifier.
`isolation`	The caller’s actor isolation, captured automatically.


                    
                    
                    setInboxDelegate(delegate:forAppID:)

Declaration

Swift

@_disfavoredOverload
@objc
public func setInboxDelegate(delegate: MoEngageInboxStatusDelegate, forAppID appID: String? = nil)

UI Handling


                    
                    
                    presentInboxViewController(withUIConfiguration:withInboxWithControllerDelegate:forAppID:)

Present InboxController

Declaration

Swift

@MainActor
@objc
public func presentInboxViewController(
    withUIConfiguration uiConfig: MoEngageInboxUIConfiguration? = nil,
    withInboxWithControllerDelegate delegate: MoEngageInboxViewControllerDelegate? = nil,
    forAppID appID: String? = nil
)

Parameters

`uiConfig`	instance of `MoEngageInboxUIConfiguration` which contains inbox UI information.
`delegate`	instance that confirms to `MoEngageInboxViewControllerDelegate` protocol.
`appID`	MoEngage Account Identifier.


                    
                    
                    pushInboxViewController(toNavigationController:withUIConfiguration:withInboxWithControllerDelegate:forAppID:)

Push InboxController

Declaration

Swift

@MainActor
@objc
public func pushInboxViewController(
    toNavigationController navController: UINavigationController,
    withUIConfiguration uiConfig: MoEngageInboxUIConfiguration? = nil,
    withInboxWithControllerDelegate delegate: MoEngageInboxViewControllerDelegate? = nil,
    forAppID appID: String? = nil
)

Parameters

`navController`	UINavigationController to push the inbox controller
`uiConfig`	instance of `MoEngageInboxUIConfiguration` which contains inbox UI information
`delegate`	instance that confirms to `MoEngageInboxViewControllerDelegate` protocol.
`appID`	MoEngage Account Identifier.


                    
                    
                    getInboxViewController(withUIConfiguration:withInboxWithControllerDelegate:forAppID:withCompletionBlock:)

Fetch the MoEngageInboxViewController

Declaration

Swift

@MainActor
@objc
public func getInboxViewController(
    withUIConfiguration uiConfig: MoEngageInboxUIConfiguration? = nil,
    withInboxWithControllerDelegate delegate: MoEngageInboxViewControllerDelegate? = nil,
    forAppID appID: String? = nil,
    withCompletionBlock completionBlock: @escaping @MainActor (MoEngageInboxViewController?) -> Void
)

Parameters

`uiConfig`	instance of `MoEngageInboxUIConfiguration` which contains inbox UI information
`delegate`	instance that confirms to `MoEngageInboxViewControllerDelegate` protocol.
`appID`	MoEngage Account Identifier.
`completionBlock`	completion block with `MoEngageInboxViewController` instance; invoked with `nil` when no SDK instance is registered for `appID`.