Other Enumerations
The following enumerations are available globally.
-
Discriminates which
See moresetUserAttribute*variant produced the result. Customers can switch on this when handling generic user-attribute outcomes.Declaration
Swift
@objc(MoEngageUserAttributeVariant) public enum MoEngageUserAttributeVariant : Int
-
Identifies which compliance toggle produced a
See moreMoEngageTrackingToggleResult.Declaration
Swift
@objc(MoEngageTrackingToggleKind) public enum MoEngageTrackingToggleKind : Int -
Attribute level enum for Portfolio user attributes
See moreDeclaration
Swift
@objc public enum MoEngageUserAttributeLevel : Int, CaseIterable, Sendable -
Environment of the SDK
See more -
Specifies the environment to use for MoEngage SDK configuration.
This enum allows developers to explicitly control which environment (test or live) the SDK should use, regardless of the settings in the Info.plist file.
See moreNote
Using an explicit environment setting overrides any environment configuration specified in the Info.plist file.Declaration
Swift
@objc public enum MoEngageWorkspaceEnvironment : UInt, Sendable -
Integration Partners for MoEngage SDK.
See moreDeclaration
Swift
@objc public enum MoEngagePartnerIntegrationType : Int, CustomStringConvertible, Sendable
-
Describes what triggered an autonomous batch sync (the cause of a
See moreMoEngageSDKEventSyncSuccessorMoEngageSDKEventSyncFailureevent).Declaration
Swift
@objc(MoEngageEventSyncTriggerType) public enum MoEngageEventSyncTriggerType : Int -
Owns all badge-count logic for the MoEngage SDK. : nodoc:
See moreDeclaration
Swift
@available(tvOS, unavailable) public enum MoEngageBadgeHandler -
A representation of static card images for MoEngage’s UI components.
This enumeration defines the possible states of a card image:
- pinnedCard: Indicates that the card is pinned.
- noCard: Indicates that no card is present.
- loadingPlaceHolder: Indicates that a loading placeholder image should be used.
The
See moredescriptioncomputed property returns a human-readable string corresponding to each enum case.Declaration
Swift
@objc public enum MoEngageStaticCardImage : Int
-
Frequency Capping scope types for trigger and rule matching
Defines the different scopes at which FC rules can be applied:
- Trigger scopes: When to evaluate FC (session start, screen load, custom event)
- Rule scopes: How to match campaigns (all campaigns, tags, specific campaign)
It’s equivalent to other trigger types like
See moresessionStart,screenLoad,eventCustom.Declaration
Swift
public enum MoEngageFCScope : String, CaseIterable -
Tag matching operator for FC rules. Public enum required for use in public model objects (MoEngageInAppFCTagRule)
See moreDeclaration
Swift
public enum MoEngageInAppFCTagOperator -
Defines all in-app stat tracking types used across the InApps module.
Each case’s raw value is the string code sent to the stats API.
Categories
- Attempted: Campaign evaluation was attempted
- Priority Stage: Campaign filtered out during prioritization
- Delivery Stage: Campaign delivery failed
- Impression Stage: Campaign display failed after delivery
- Evaluation Stage: Campaign evaluation timed out or user left
- Session: Session-related stat events
- Frequency Capping (FC): FC limit reached (priority or impression stage)
Note: Do not reorder existing cases — new cases must be appended at the end of each section.
See moreDeclaration
Swift
public enum MoEngageInAppStatType : String, Codable, CaseIterable -
Declaration
Swift
@objc public enum MoEngageInAppOrientationType : UIntextension MoEngageInAppOrientationType: Codable -
Declaration
Swift
public enum MoEngageInAppTemplateType : Intextension MoEngageInAppTemplateType: Codable -
SDK campaign type for InApp campaigns.
See moreDeclaration
Swift
public enum MoEngageInAppSDKCampaignType : Intextension MoEngageInAppSDKCampaignType: Codable -
Represents the reason why a campaign was blocked by Frequency Capping
This enum provides detailed information about why a campaign was blocked, including the specific limits that were exceeded and current counts.
See moreDeclaration
Swift
public enum MoEngageInAppFCBlockReason -
Represents the different trigger types for Frequency Capping evaluation
This enum defines the various scenarios where FC rules can be applied:
- sessionStart: When a new session begins
- screenLoad: When a screen is loaded
- customEvent: When a custom event is triggered
- allCampaigns: Global evaluation for all campaigns
Each trigger type corresponds to specific FC rules in the global settings:
sessionStart→s_s(session start) rulescreenLoad→s_l(screen load) rulecustomEvent→c_e(custom event) ruleallCampaigns→a_c(all campaigns) rule
Declaration
Swift
public enum MoEngageInAppFCTriggerType : String, CaseIterable -
Enumeration representing the sub-type classification of in-app campaigns.
This enum defines different categories of in-app campaigns based on their purpose and behavior. It helps in categorizing campaigns for better targeting and analytics.
See moreDeclaration
Swift
@objc public enum MoEngageInAppCampaignSubType : Intextension MoEngageInAppCampaignSubType: Codable -
Indicates the rendering kind of an in-app campaign — the customer-visible discriminator surfaced via
See moreMoEngageShowInAppResult.inAppType. Native campaigns are rendered using native UIKit views; HTML campaigns are rendered inside a web view..invalidis the fallback when the SDK couldn’t determine the kind (typically a payload decode failure — surfaced viaonFailurerather thanonSuccess).Declaration
Swift
@objc public enum MoEngageInAppType : Intextension MoEngageInAppType: Codable -
InApp widget axis type.
See moreDeclaration
Swift
@objc public enum MoEngageInAppAxisType : Int -
InApp widget type.
See moreDeclaration
Swift
@objc public enum MoEngageInAppWidgetType : Int -
InApp widget alignment type.
See moreDeclaration
Swift
@objc public enum MoEngageInAppWidgetAlignment : Int, Hashable -
InApp Widget initial Visibilty status :nodoc
See moreDeclaration
Swift
@objc public enum MoEngageInAppViewVisibility : Int -
:nodoc Enum to get the eligible campaign
See moreDeclaration
Swift
@objc public enum MoEngageInAppEligibleCriteria : Int -
Defines the action type performed by an InApp click.
See moreDeclaration
Swift
@objc public enum MoEngageInAppActionType : Int -
Navigation Type
See moreDeclaration
Swift
@objc public enum MoEngageNavigationType : Int
-
Position at which a nudge InApp campaign is displayed on screen.
See moreDeclaration
Swift
@objc public enum MoEngageNudgePosition : Intextension MoEngageNudgePosition: CustomStringConvertible -
Declaration
Swift
@objc public enum MoEngageTestInAppSessionTermination : Int -
Declaration
Swift
@objc public enum MoEngageTestInAppEvents : Int
-
Represents the data source of an experience campaign or metadata.
See moreDeclaration
Swift
@objc public enum MoEngagePersonalizeDataSource : Int
Other Enumerations Reference