MoEngageSDKCards Class Reference


                    
                    
                    sharedInstance

Singleton instance

Declaration

Swift

@objc
public static var sharedInstance: MoEngageSDKCards { get }

Set Delegate


                    
                    
                    setCardsDelegate(delegate:forAppID:isolation:)

Set the Cards delegate

Declaration

Swift

public func setCardsDelegate(
    delegate: MoEngageCardsDelegate,
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation
)

Parameters

`delegate`	delegate object
`appID`	MoEngage Account Identifier


                    
                    
                    setCardsDelegate(delegate:forAppID:)

Set the Cards delegate. Objective-C compatible overload.

Declaration

Swift

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


                    
                    
                    getCards(forCategory:forAppID:isolation:withCompletionBlock:)

Fetch Cards campaign for given category

Declaration

Swift

@available(*, deprecated, message: "This API is deprecated. Please use the newer API getCardData(for:appID:completionBlock:﹚")
public func getCards(
    forCategory category: String,
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation,
    withCompletionBlock completionBlock:
        @escaping @MainActor(unsafe) (
            _ cards: [MoEngageCardCampaign],
            _ accountMeta: MoEngageAccountMeta?
        ) -> Void
)

Parameters

`category`	category for which cards should be fetched.
`appID`	MoEngage Account Identifier
`completionBlock`	completion block with cards campaign info and account info.


                    
                    
                    getCards(forCategory:forAppID:withCompletionBlock:)

Fetch Cards campaign for given category. Objective-C compatible overload.

Declaration

Swift

@available(*, deprecated, message: "This API is deprecated. Please use the newer API getCardData(for:appID:completionBlock:﹚")
@_disfavoredOverload
@objc
public func getCards(
    forCategory category: String,
    forAppID appID: String? = nil,
    withCompletionBlock completionBlock:
  @escaping @MainActor(unsafe) (
      _ cards: [MoEngageCardCampaign],
      _ accountMeta: MoEngageAccountMeta?
  ) -> Void
)


                    
                    
                    getCardData(for:appID:isolation:completionBlock:)

Retrieves card information for a specified category

Declaration

Swift

public func getCardData(
    for category: String,
    appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation,
    completionBlock:
        @escaping @MainActor(unsafe) (MoEngageCardData?) -> Void
)


                    
                    
                    getCardData(for:appID:completionBlock:)

Retrieves card information for a specified category. Objective-C compatible overload.

Declaration

Swift

@_disfavoredOverload
@objc
public func getCardData(
    for category: String,
    appID: String? = nil,
    completionBlock:
  @escaping @MainActor(unsafe) (MoEngageCardData?) -> Void
)


                    
                    
                    isAllCategoryEnabled(forAppID:isolation:withCompletionBlock:)

Fetch ShowAllTab status.

Declaration

Swift

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

Parameters


                                appID

MoEngage Account Identifier

Return Value

true if All tab is shown else false


                    
                    
                    isAllCategoryEnabled(forAppID:withCompletionBlock:)

Fetch ShowAllTab status. Objective-C compatible overload.

Declaration

Swift

@_disfavoredOverload
@objc
public func isAllCategoryEnabled(
    forAppID appID: String? = nil,
    withCompletionBlock completionBlock:
  @escaping @MainActor(unsafe) (Bool) -> Void
)

Fetch Cards


                    
                    
                    fetchCards(forAppID:isolation:withCompletion:)

Fetch the latest cards after refreshing data with inbox sync interval.

Declaration

Swift

public func fetchCards(
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation,
    withCompletion completionBlock: (
        @MainActor(unsafe) (_ data: MoEngageCardData?) -> Void
    )? = nil
)

Parameters

`appID`	MoEngage Account Identifier
`completionBlock`	completion block with cards data and account info


                    
                    
                    fetchCards(forAppID:withCompletion:)

Fetch the latest cards after refreshing data with inbox sync interval. Objective-C compatible overload.

Declaration

Swift

@_disfavoredOverload
@objc
public func fetchCards(
    forAppID appID: String? = nil,
    withCompletion completionBlock: (
  @MainActor(unsafe) (_ data: MoEngageCardData?) -> Void
    )? = nil
)

Card Status


                    
                    
                    getAllCardStatusDict(forAppID:isolation:withCompletionBlock:)

Fetch Cards status

Declaration

Swift

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

Parameters


                                appID

MoEngage Account Identifier

Return Value

Array of dictionary containing card status

Cards Data


                    
                    
                    getCardsData(forAppID:isolation:withCompletionBlock:)

Method to fetch Cards data

Declaration

Swift

public func getCardsData(
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation,
    withCompletionBlock completionBlock:
        @escaping @MainActor(unsafe) (
            _ cardsData: MoEngageCardsData?,
            _ accountMeta: MoEngageAccountMeta?
        ) -> Void
)

Parameters

`appID`	MoEngage Account Identifier
`completionBlock`	completion block with cards data and account info.


                    
                    
                    getCardsData(forAppID:withCompletionBlock:)

Method to fetch Cards data. Objective-C compatible overload.

Declaration

Swift

@_disfavoredOverload
@objc
public func getCardsData(
    forAppID appID: String? = nil,
    withCompletionBlock completionBlock:
  @escaping @MainActor(unsafe) (
      _ cardsData: MoEngageCardsData?,
      _ accountMeta: MoEngageAccountMeta?
  ) -> Void
)


                    
                    
                    getCardsCategories(forAppID:isolation:withCompletionBlock:)

Fetch Cards categories

Declaration

Swift

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

Parameters

`appID`	MoEngage Account Identifier
`completionBlock`	completion block with cards categories and account info.


                    
                    
                    getCardsCategories(forAppID:withCompletionBlock:)

Fetch Cards categories. Objective-C compatible overload.

Declaration

Swift

@_disfavoredOverload
@objc
public func getCardsCategories(
    forAppID appID: String? = nil,
    withCompletionBlock completionBlock:
  @escaping @MainActor(unsafe) (
      _ categories: [String], _ accountMeta: MoEngageAccountMeta?
  ) -> Void
)

Inbox Lifecycle


                    
                    
                    cardsViewControllerLoaded(forAppID:isolation:)

Track impression for loading CardsController

Declaration

Swift

public func cardsViewControllerLoaded(
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation
)

Parameters


                                appID

MoEngage Account identifier

cardsViewControllerLoaded(forAppID:)
Track impression for loading CardsController. Objective-C compatible overload.
Declaration
Swift

@_disfavoredOverload @objc public func cardsViewControllerLoaded(forAppID appID: String? = nil)


                    
                    
                    cardsViewControllerDismissed(forAppID:isolation:)

Dismiss CardsViewController

Declaration

Swift

public func cardsViewControllerDismissed(
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation
)

Parameters


                                appID

MoEngage Account Identifier

cardsViewControllerDismissed(forAppID:)
Dismiss CardsViewController. Objective-C compatible overload.
Declaration
Swift

@_disfavoredOverload @objc public func cardsViewControllerDismissed(forAppID appID: String? = nil)

Cards Count


                    
                    
                    getNewCardsCount(forAppID:isolation:withCompletionBlock:)

Fetch new cards count

Declaration

Swift

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

Parameters

`appID`	MoEngage Account Identifier
`completionBlock`	completion block with new cards count and account info.


                    
                    
                    getNewCardsCount(forAppID:withCompletionBlock:)

Fetch new cards count. Objective-C compatible overload.

Declaration

Swift

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


                    
                    
                    getUnclickedCardsCount(forAppID:isolation:withCompletionBlock:)

Fetch unclicked cards count

Declaration

Swift

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

Parameters

`appID`	MoEngage Account Identifier
`completionBlock`	completion block with unclicked cards count and account info.


                    
                    
                    getUnclickedCardsCount(forAppID:withCompletionBlock:)

Fetch unclicked cards count. Objective-C compatible overload.

Declaration

Swift

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


                    
                    
                    getClickedCardsCount(forAppID:isolation:withCompletionBlock:)

Fetch clicked cards count

Declaration

Swift

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

Parameters

`appID`	MoEngage Account Identifier
`completionBlock`	completion block with clicked cards count and account info.


                    
                    
                    getClickedCardsCount(forAppID:withCompletionBlock:)

Fetch clicked cards count. Objective-C compatible overload.

Declaration

Swift

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

Delete Cards


                    
                    
                    deleteCards(_:forAppID:isolation:andCompletionBlock:)

Delete the cards

Declaration

Swift

public func deleteCards(
    _ cardsArr: [MoEngageCardCampaign],
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation,
    andCompletionBlock completionBlock:
        @escaping @MainActor(unsafe) (
            _ isDeleted: Bool, _ accountMeta: MoEngageAccountMeta?
        ) -> Void
)

Parameters

`cardsArr`	array of `MoEngageCardCampaign`
`appID`	MoEngage Account Identifier
`completionBlock`	completion block called once card is deleted.


                    
                    
                    deleteCards(_:forAppID:andCompletionBlock:)

Delete the cards. Objective-C compatible overload.

Declaration

Swift

@_disfavoredOverload
@objc
public func deleteCards(
    _ cardsArr: [MoEngageCardCampaign],
    forAppID appID: String? = nil,
    andCompletionBlock completionBlock:
  @escaping @MainActor(unsafe) (
      _ isDeleted: Bool, _ accountMeta: MoEngageAccountMeta?
  ) -> Void
)

Sync Cards


                    
                    
                    syncCards(forAppID:isolation:withCompletion:)

Sync the cards from server

Declaration

Swift

public func syncCards(
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation,
    withCompletion completionBlock: (
        @MainActor(unsafe) (_ success: Bool) -> Void
    )? = nil
)

Parameters

`appID`	MoEngage Account Identifier
`completionBlock`	Returns true if sync is successful else false


                    
                    
                    syncCards(forAppID:withCompletion:)

Sync the cards from server. Objective-C compatible overload.

Declaration

Swift

@_disfavoredOverload
@objc
public func syncCards(
    forAppID appID: String? = nil,
    withCompletion completionBlock: (
  @MainActor(unsafe) (_ success: Bool) -> Void
    )? = nil
)

Parameters

`appID`	MoEngage Account Identifier
`completionBlock`	Returns true if sync is successful else false


                    
                    
                    onAppOpenSync(forAppID:isolation:withCompletion:)

Method to sync the cards with app open interval

Declaration

Swift

public func onAppOpenSync(
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation,
    withCompletion completionBlock: (
        @MainActor(unsafe) (_ data: MoEngageCardSyncCompleteData?) -> Void
    )? = nil
)

Parameters

`appID`	account identifier
`completionBlock`	completion block to be called after sync is performed


                    
                    
                    onAppOpenSync(forAppID:withCompletion:)

Method to sync the cards with app open interval. Objective-C compatible overload.

Declaration

Swift

@_disfavoredOverload
@objc
public func onAppOpenSync(
    forAppID appID: String? = nil,
    withCompletion completionBlock: (
  @MainActor(unsafe) (_ data: MoEngageCardSyncCompleteData?) -> Void
    )? = nil
)


                    
                    
                    onCardSectionLoaded(forAppID:isolation:withCompletion:)

Method to track inbox click and sync the cards with inbox load interval

Declaration

Swift

public func onCardSectionLoaded(
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation,
    withCompletion completionBlock: (
        @MainActor(unsafe) (_ data: MoEngageCardSyncCompleteData?) -> Void
    )? = nil
)

Parameters

`appID`	account identifier
`completionBlock`	completion block to be called after sync is performed


                    
                    
                    onCardSectionLoaded(forAppID:withCompletion:)

Method to track inbox click and sync the cards with inbox load interval. Objective-C compatible overload.

Declaration

Swift

@_disfavoredOverload
@objc
public func onCardSectionLoaded(
    forAppID appID: String? = nil,
    withCompletion completionBlock: (
  @MainActor(unsafe) (_ data: MoEngageCardSyncCompleteData?) -> Void
    )? = nil
)


                    
                    
                    refreshCards(forAppID:isolation:withCompletion:)

Method to sync the cards with pull to refresh interval

Declaration

Swift

public func refreshCards(
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation,
    withCompletion completionBlock: (
        @MainActor(unsafe) (_ data: MoEngageCardSyncCompleteData?) -> Void
    )? = nil
)

Parameters

`appID`	account identifier
`completionBlock`	completion block to be called after sync is performed


                    
                    
                    refreshCards(forAppID:withCompletion:)

Method to sync the cards with pull to refresh interval. Objective-C compatible overload.

Declaration

Swift

@_disfavoredOverload
@objc
public func refreshCards(
    forAppID appID: String? = nil,
    withCompletion completionBlock: (
  @MainActor(unsafe) (_ data: MoEngageCardSyncCompleteData?) -> Void
    )? = nil
)

Card Tracking


                    
                    
                    cardShown(_:forAppID:isolation:)

Track cards shown event and update delivery counters accordingly.

Declaration

Swift

public func cardShown(
    _ card: MoEngageCardCampaign,
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation
)

Parameters

`card`	instance of `MoEngageCardCampaign`
`appID`	MoEngage Account Identifier


                    
                    
                    cardShown(_:forAppID:)

Track cards shown event and update delivery counters accordingly. Objective-C compatible overload.

Declaration

Swift

@_disfavoredOverload
@objc
public func cardShown(
    _ card: MoEngageCardCampaign,
    forAppID appID: String? = nil
)


                    
                    
                    cardClicked(_:forAppID:isolation:)

Mark the card as clicked and tracks an event for statistical purpose.

Declaration

Swift

public func cardClicked(
    _ card: MoEngageCardCampaign,
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation
)

Parameters

`card`	instance of `MoEngageCardCampaign`
`appID`	MoEngage Account Identifier


                    
                    
                    cardClicked(_:forAppID:)

Mark the card as clicked and tracks an event for statistical purpose. Objective-C compatible overload.

Declaration

Swift

@_disfavoredOverload
@objc
public func cardClicked(
    _ card: MoEngageCardCampaign,
    forAppID appID: String? = nil
)


                    
                    
                    cardClicked(_:withWidgetID:forAppID:isolation:)

Mark a card as clicked and tracks an event for statistical purpose.

Declaration

Swift

public func cardClicked(
    _ card: MoEngageCardCampaign,
    withWidgetID widgetID: Int,
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation
)

Parameters

`card`	instance of `MoEngageCardCampaign`
`widgetID`	unique identifier for the widget that was clicked
`appID`	MoEngage Account Identifier


                    
                    
                    cardClicked(_:withWidgetID:forAppID:)

Mark a card as clicked and tracks an event for statistical purpose. Objective-C compatible overload.

Declaration

Swift

@_disfavoredOverload
@objc
public func cardClicked(
    _ card: MoEngageCardCampaign,
    withWidgetID widgetID: Int,
    forAppID appID: String? = nil
)


                    
                    
                    cardDelivered(_:forAppID:isolation:)

Mark card delivered event

Declaration

Swift

public func cardDelivered(
    _ card: MoEngageCardCampaign,
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation
)

Parameters

`card`	instance of `MoEngageCardCampaign`
`appID`	MoEngage Account Identifier


                    
                    
                    cardDelivered(_:forAppID:)

Mark card delivered event. Objective-C compatible overload.

Declaration

Swift

@_disfavoredOverload
@objc
public func cardDelivered(
    _ card: MoEngageCardCampaign,
    forAppID appID: String? = nil
)


                    
                    
                    cardDelivered(forAppID:isolation:)

Method to mark tracking delivery of all cards to inbox.

Declaration

Swift

public func cardDelivered(
    forAppID appID: String? = nil,
    isolation `actor`: isolated (any Actor)? = #isolation
)

Parameters


                                appID

account identifier.

cardDelivered(forAppID:)
Method to mark tracking delivery of all cards to inbox. Objective-C compatible overload.
Declaration
Swift

@_disfavoredOverload @objc public func cardDelivered(forAppID appID: String? = nil)

UI Methods


                    
                    
                    presentCardsViewController(withUIConfiguration:withCardsViewControllerDelegate:forAppID:)

Present the CardsViewController

Declaration

Swift

@available(tvOS, unavailable)
@MainActor
@objc
public func presentCardsViewController(
    withUIConfiguration config: MoEngageCardsUIConfiguration? = nil,
    withCardsViewControllerDelegate delegate: MoEngageCardsViewControllerDelegate? = nil,
    forAppID appID: String? = nil
)

Parameters

`config`	Cards config instance
`delegate`	optional cards delegate
`appID`	MoEngage Account Identifier


                    
                    
                    pushCardsViewController(toNavigationController:withUIConfiguration:withCardsViewControllerDelegate:forAppID:)

Push the CardsViewController

Declaration

Swift

@available(tvOS, unavailable)
@MainActor
@objc
public func pushCardsViewController(
    toNavigationController navController: UINavigationController,
    withUIConfiguration config: MoEngageCardsUIConfiguration? = nil,
    withCardsViewControllerDelegate delegate: MoEngageCardsViewControllerDelegate? = nil,
    forAppID appID: String? = nil
)

Parameters

`navController`	UINavigationController instance
`config`	Cards custom UI configuration
`delegate`	optional cards delegate
`appID`	MoEngage Account Identifier


                    
                    
                    getCardsViewController(withUIConfiguration:withCardsViewControllerDelegate:forAppID:withCompletionBlock:)

Method to return the CardsViewController

Declaration

Swift

@available(tvOS, unavailable)
@MainActor
@objc
public func getCardsViewController(
    withUIConfiguration config: MoEngageCardsUIConfiguration? = nil,
    withCardsViewControllerDelegate delegate: MoEngageCardsViewControllerDelegate? = nil,
    forAppID appID: String? = nil,
    withCompletionBlock completionBlock:
  @escaping @MainActor(unsafe) (MoEngageCardsListViewController?) -> Void
)

Parameters

`config`	Cards custom UI configuration
`delegate`	optional cards delegate
`appID`	MoEngage Account Identifier

Return Value

MoEngageCardsListViewController