MoEngageSDKInApp

@objc
public class MoEngageSDKInApp : NSObject

Class to configure to InApp


                    
                    
                    sharedInstance

Singleton instance

Declaration

Swift

@objc
public static let sharedInstance: MoEngageSDKInApp

General Campaigns

showInApp()
Call this method to show Pop-up OR Fullscreen InApps inside the app for Default MoEngage Instance.
Declaration
Swift

@discardableResult @objc public func showInApp() -> MoEngageShowInAppTask
Return Value

MoEngageShowInAppTask that resolves once the selected campaign has been rendered (after the configured display delay), or rejects with MoEngageInAppRequestFailureReason (.campaignNotFound / .renderFailed / .htmlAssetLoadFailed) or the shared .sdkNotInitialized code.


                    
                    
                    showInApp(forAppId:)

Call this method to show Pop-up OR Fullscreen InApps inside the app.

Declaration

Swift

@discardableResult
@objc
public func showInApp(forAppId appId: String? = nil) -> MoEngageShowInAppTask

Parameters


                                appId

MoEngage Account Identifier.

Return Value

MoEngageShowInAppTask — see showInApp() for the resolve / reject contract.

Nudge Campaigns

showNudge()
Method to show non-intrusive nudge campaign at any available position for Default MoEngage Instance.
Declaration
Swift

@available(tvOS, unavailable) @discardableResult @objc public func showNudge() -> MoEngageShowNudgeTask
Return Value

MoEngageShowNudgeTask — see MoEngageShowNudgeTask for the resolve / reject contract.


                    
                    
                    showNudge(forAppId:)

Method to show non-intrusive nudge campaign at any available position.

Declaration

Swift

@available(tvOS, unavailable)
@discardableResult
@objc
public func showNudge(forAppId appId: String? = nil) -> MoEngageShowNudgeTask

Parameters


                                appId

MoEngage Account Identifier.

Return Value

MoEngageShowNudgeTask — see MoEngageShowNudgeTask for the resolve / reject contract.


                    
                    
                    showNudge(atPosition:)

Method to show non-intrusive nudge campaign at the specified position if available for Default MoEngage Instance.

Declaration

Swift

@available(tvOS, unavailable)
@discardableResult
@objc
public func showNudge(atPosition position: MoEngageNudgePosition = MoEngageNudgePosition.any) -> MoEngageShowNudgeTask

Parameters


                                position

specifies the position where the nudge has to be showed Top/Bottom.

Return Value

MoEngageShowNudgeTask — see MoEngageShowNudgeTask for the resolve / reject contract.


                    
                    
                    showNudge(atPosition:forAppId:)

Method to show non-intrusive nudge campaign at the specified position if available.

Declaration

Swift

@available(tvOS, unavailable)
@discardableResult
@objc
public func showNudge(atPosition position: MoEngageNudgePosition = MoEngageNudgePosition.any, forAppId appId: String? = nil) -> MoEngageShowNudgeTask

Parameters

`position`	specifies the position where the nudge has to be showed Top/Bottom.
`appId`	MoEngage Account Identifier.

Return Value

MoEngageShowNudgeTask — see MoEngageShowNudgeTask for the resolve / reject contract.

Self Handled Campaigns

getSelfHandledInApp()
Method to obtain self-handled inApp Campaign for Default MoEngage Instance.
Declaration
Swift

@discardableResult @objc public func getSelfHandledInApp() -> MoEngageGetSelfHandledInAppTask
Return Value

MoEngageGetSelfHandledInAppTask resolving with MoEngageGetSelfHandledInAppResult whose campaign is nil when no eligible self-handled campaign is available (a valid customer-observable state — not a failure). Rejects with .sdkNotInitialized if no instance matches.


                    
                    
                    getSelfHandledInApp(forAppId:)

Method to obtain self-handled inApp Campaign.

Declaration

Swift

@discardableResult
@objc
public func getSelfHandledInApp(forAppId appId: String? = nil) -> MoEngageGetSelfHandledInAppTask

Parameters


                                appId

MoEngage Account Identifier.

Return Value

MoEngageGetSelfHandledInAppTask — see getSelfHandledInApp() for the contract.


                    
                    
                    getSelfHandledInApp(completionBlock:)

Deprecated. Use the typed-task-returning getSelfHandledInApp() / getSelfHandledInApp(forAppId:) variants.

Declaration

Swift

@available(*, deprecated, message: "Use the typed-task-returning getSelfHandledInApp(﹚ variant; attach onSuccess to receive the campaign.")
@objc
public func getSelfHandledInApp(completionBlock: @escaping ((_ campaignInfo: MoEngageInAppSelfHandledCampaign?, _ accountMeta: MoEngageAccountMeta?) -> Void))


                    
                    
                    getSelfHandledInApp(forAppId:completionBlock:)

Deprecated. Use the typed-task-returning getSelfHandledInApp(forAppId:) variant.

Declaration

Swift

@available(*, deprecated, message: "Use the typed-task-returning getSelfHandledInApp(forAppId:﹚ variant; attach onSuccess to receive the campaign.")
@objc
public func getSelfHandledInApp(forAppId appId: String? = nil, completionBlock: @escaping ((_ campaignInfo: MoEngageInAppSelfHandledCampaign?, _ accountMeta: MoEngageAccountMeta?) -> Void))

getSelfHandledInApps()
Method to get multiple self-handled inApp Campaigns for Default MoEngage Instance.
Declaration
Swift

@discardableResult @objc public func getSelfHandledInApps() -> MoEngageGetSelfHandledInAppsTask
Return Value

MoEngageGetSelfHandledInAppsTask resolving with MoEngageGetSelfHandledInAppsResult whose campaigns may be empty.


                    
                    
                    getSelfHandledInApps(forAppId:)

Method to get multiple self-handled inApp Campaigns.

Declaration

Swift

@discardableResult
@objc
public func getSelfHandledInApps(forAppId appId: String? = nil) -> MoEngageGetSelfHandledInAppsTask

Parameters


                                appId

MoEngage Account Identifier.

Return Value

MoEngageGetSelfHandledInAppsTask — see getSelfHandledInApps().


                    
                    
                    getSelfHandledInApps(completionBlock:)

Deprecated. Use the typed-task-returning getSelfHandledInApps() variant.

Declaration

Swift

@available(*, deprecated, message: "Use the typed-task-returning getSelfHandledInApps(﹚ variant; attach onSuccess to receive the campaigns.")
@objc
public func getSelfHandledInApps(completionBlock: @escaping (_ campaignData: MoEngageInAppSelfHandledData) -> Void)


                    
                    
                    getSelfHandledInApps(for:completionBlock:)

Deprecated. Use the typed-task-returning getSelfHandledInApps(forAppId:) variant.

Declaration

Swift

@available(*, deprecated, message: "Use the typed-task-returning getSelfHandledInApps(forAppId:﹚ variant; attach onSuccess to receive the campaigns.")
@objc
public func getSelfHandledInApps(for appId: String, completionBlock: @escaping (_ campaignData: MoEngageInAppSelfHandledData) -> Void)


                    
                    
                    selfHandledShown(campaignInfo:)

Method to be called if a self-handled InApp is shown inside the app for Default MoEngage Instance.

Declaration

Swift

@discardableResult
@objc
public func selfHandledShown(campaignInfo: MoEngageInAppSelfHandledCampaign) -> MoEngageSelfHandledTrackingTask

Parameters


                                campaignInfo

MoEngageInAppSelfHandledCampaign instance with the campaign info.

Return Value

MoEngageSelfHandledTrackingTask resolving with MoEngageSelfHandledTrackingResult once the impression has been accepted into the SDK’s tracking pipeline.


                    
                    
                    selfHandledShown(campaignInfo:forAppId:)

Method to be called if a self-handled InApp is shown inside the app.

Declaration

Swift

@discardableResult
@objc
public func selfHandledShown(campaignInfo: MoEngageInAppSelfHandledCampaign, forAppId appId: String? = nil) -> MoEngageSelfHandledTrackingTask

Parameters

`campaignInfo`	MoEngageInAppSelfHandledCampaign instance with the campaign info.
`appId`	MoEngage Account Identifier.

Return Value

MoEngageSelfHandledTrackingTask — see selfHandledShown(campaignInfo:).

selfHandledClicked(campaignInfo:)
Method to be called if a self-handled InApp is clicked by the user for Default MoEngage Instance.
Declaration
Swift

@discardableResult @objc public func selfHandledClicked(campaignInfo: MoEngageInAppSelfHandledCampaign) -> MoEngageSelfHandledTrackingTask


                    
                    
                    selfHandledClicked(campaignInfo:forAppId:)

Method to be called if a self-handled InApp is clicked by the user.

Declaration

Swift

@discardableResult
@objc
public func selfHandledClicked(campaignInfo: MoEngageInAppSelfHandledCampaign, forAppId appId: String? = nil) -> MoEngageSelfHandledTrackingTask

selfHandledDismissed(campaignInfo:)
Method to be called if a self-handled InApp is dismissed by the user for Default MoEngage Instance.
Declaration
Swift

@discardableResult @objc public func selfHandledDismissed(campaignInfo: MoEngageInAppSelfHandledCampaign) -> MoEngageSelfHandledTrackingTask


                    
                    
                    selfHandledDismissed(campaignInfo:forAppId:)

Method to be called if a self-handled InApp is dismissed by the user.

Declaration

Swift

@discardableResult
@objc
public func selfHandledDismissed(campaignInfo: MoEngageInAppSelfHandledCampaign, forAppId appId: String? = nil) -> MoEngageSelfHandledTrackingTask

Configuration-shape APIs

disableInApps()
Method to disable inApps module for Default MoEngage Instance.
Declaration
Swift

@objc public func disableInApps()


                    
                    
                    disableInApps(forAppId:)

Method to disable inApps module.

Declaration

Swift

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

Parameters


                                appId

MoEngage Account Identifier.

Block InApps

blockInApp(forViewController:)
Call this method to block InApps in a particular ViewController for Default MoEngage Instance.
Declaration
Swift

@objc public func blockInApp(forViewController viewController: UIViewController)


                    
                    
                    blockInApp(forViewController:forAppId:)

Call this method to block InApps in a particular ViewController.

Declaration

Swift

@objc
public func blockInApp(forViewController viewController: UIViewController, forAppId appId: String? = nil)

InApp Contexts

setCurrentInAppContexts(_:)
Method to set the current inApp contexts for Default MoEngage instance.
Declaration
Swift

@objc public func setCurrentInAppContexts(_ contexts: [String])


                    
                    
                    setCurrentInAppContexts(_:forAppId:)

Method to set the current inApp contexts.

Declaration

Swift

@objc
public func setCurrentInAppContexts(_ contexts: [String], forAppId appId: String? = nil)

invalidateInAppContexts()
Invalidate/reset the contexts set currently in the app for Default MoEngage instance.
Declaration
Swift

@objc public func invalidateInAppContexts()
invalidateInAppContexts(forAppId:)
Invalidate/reset the contexts set currently in the app.
Declaration
Swift

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

InApp Delegate Handling

setInAppDelegate(_:)
Method to set delegate for the inApp Callbacks for Default MoEngage instance.
Declaration
Swift

@objc public func setInAppDelegate(_ delegate: MoEngageInAppNativeDelegate)


                    
                    
                    setInAppDelegate(_:forAppId:)

Method to set delegate for the inApp Callbacks.

Declaration

Swift

@objc
public func setInAppDelegate(_ delegate: MoEngageInAppNativeDelegate, forAppId appId: String? = nil)

resetInAppDelegate()
Method to reset the inApp Delegate for Default Instance for Default MoEngage instance.
Declaration
Swift

@objc public func resetInAppDelegate()
resetInAppDelegate(forAppId:)
Method to reset the inApp Delegate for Default Instance.
Declaration
Swift

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