Constants

The following constants are available globally.

  • Default registry name for cancel schedules action.

    Declaration

    Objective-C

    extern NSString *const UACancelSchedulesActionDefaultRegistryName

    Swift

    let UACancelSchedulesActionDefaultRegistryName: String

  • Default registry alias for cancel schedules action.

    Declaration

    Objective-C

    extern NSString *const UACancelSchedulesActionDefaultRegistryAlias

    Swift

    let UACancelSchedulesActionDefaultRegistryAlias: String

  • Argument value to cancel all schedules.

    Declaration

    Objective-C

    extern NSString *const UACancelSchedulesActionAll

    Swift

    let UACancelSchedulesActionAll: String

  • Key in the argument value map to list the schedule IDs to cancel.

    Declaration

    Objective-C

    extern NSString *const UACancelSchedulesActionIDs

    Swift

    let UACancelSchedulesActionIDs: String

  • Key in the argument value map to list the schedule groups to cancel.

    Declaration

    Objective-C

    extern NSString *const UACancelSchedulesActionGroups

    Swift

    let UACancelSchedulesActionGroups: String

  • Message name limit (100 characters).

    Declaration

    Objective-C

    extern const NSUInteger UAInAppMessageNameLimit

    Swift

    let UAInAppMessageNameLimit: UInt

  • The in-app message default display behavior. Usually displayed using the default coordinator that allows defining display interval.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAInAppMessageDisplayBehaviorDefault

    Swift

    let UAInAppMessageDisplayBehaviorDefault: String

  • The in-app message should be displayed ASAP.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAInAppMessageDisplayBehaviorImmediate

    Swift

    let UAInAppMessageDisplayBehaviorImmediate: String

  • Banner in-app message display style defaults plist name.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UABannerStyleFileName

    Swift

    let UABannerStyleFileName: String

  • Maximum number of button supported by a banner.

    Declaration

    Objective-C

    extern const NSUInteger UAInAppMessageBannerMaxButtons

    Swift

    let UAInAppMessageBannerMaxButtons: UInt

  • The key representing the additionalPadding in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UABannerAdditionalPaddingKey

    Swift

    let UABannerAdditionalPaddingKey: String

  • The key representing the top-level text style in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UABannerTextStyleKey

    Swift

    let UABannerTextStyleKey: String

  • The key representing the header style in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UABannerHeaderStyleKey

    Swift

    let UABannerHeaderStyleKey: String

  • The key representing the body style in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UABannerBodyStyleKey

    Swift

    let UABannerBodyStyleKey: String

  • The key representing the button style in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UABannerButtonStyleKey

    Swift

    let UABannerButtonStyleKey: String

  • The key representing the media style in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UABannerMediaStyleKey

    Swift

    let UABannerMediaStyleKey: String

  • The key representing the max width in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UABannerMaxWidthKey

    Swift

    let UABannerMaxWidthKey: String

  • Button identifier limit (100 characters).

    Declaration

    Objective-C

    extern const NSUInteger UAInAppMessageButtonInfoIDLimit

    Swift

    let UAInAppMessageButtonInfoIDLimit: UInt

  • The key representing the button additionalPadding in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAButtonAdditionalPaddingKey

    Swift

    let UAButtonAdditionalPaddingKey: String

  • The key representing the stacked button spacing in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAStackedButtonSpacingKey

    Swift

    let UAStackedButtonSpacingKey: String

  • The key representing the separated button spacing in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UASeparatedButtonSpacingKey

    Swift

    let UASeparatedButtonSpacingKey: String

  • The key representing the button height in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAButtonHeightKey

    Swift

    let UAButtonHeightKey: String

  • JSON keys and values.

    Declaration

    Objective-C

    extern NSString *const UAInAppMessageBodyKey

    Swift

    let UAInAppMessageBodyKey: String

  • Buttons are stacked.

    Declaration

    Objective-C

    extern NSString *const UAInAppMessageButtonLayoutStackedValue

    Swift

    let UAInAppMessageButtonLayoutStackedValue: String

  • Buttons are displayed with a space between them.

    Declaration

    Objective-C

    extern NSString *const UAInAppMessageButtonLayoutSeparateValue

    Swift

    let UAInAppMessageButtonLayoutSeparateValue: String

  • Buttons are displayed right next to each other.

    Declaration

    Objective-C

    extern NSString *const UAInAppMessageButtonLayoutJoinedValue

    Swift

    let UAInAppMessageButtonLayoutJoinedValue: String

  • Key name for the isReady property. Use this for emitting change notifications.

    Declaration

    Objective-C

    extern NSString *const UAInAppMessageDisplayCoordinatorIsReadyKey

    Swift

    let UAInAppMessageDisplayCoordinatorIsReadyKey: String

  • Full screen in-app message display style defaults plist name.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAFullScreenStyleFileName

    Swift

    let UAFullScreenStyleFileName: String

  • Maximum number of button supported by a full screen.

    Declaration

    Objective-C

    extern const NSUInteger UAInAppMessageFullScreenMaxButtons

    Swift

    let UAInAppMessageFullScreenMaxButtons: UInt

  • The key representing the dismissIconResource in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAFullScreenDismissIconResourceKey

    Swift

    let UAFullScreenDismissIconResourceKey: String

  • The key representing the top-level text style in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAFullScreenTextStyleKey

    Swift

    let UAFullScreenTextStyleKey: String

  • The key representing the header style in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAFullScreenHeaderStyleKey

    Swift

    let UAFullScreenHeaderStyleKey: String

  • The key representing the body style in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAFullScreenBodyStyleKey

    Swift

    let UAFullScreenBodyStyleKey: String

  • The key representing the button style in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAFullScreenButtonStyleKey

    Swift

    let UAFullScreenButtonStyleKey: String

  • The key representing the media style in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAFullScreenMediaStyleKey

    Swift

    let UAFullScreenMediaStyleKey: String

  • HTML in-app message display style defaults plist name.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAHTMLStyleFileName

    Swift

    let UAHTMLStyleFileName: String

  • The key representing the dismissIconResource in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAHTMLDismissIconResourceKey

    Swift

    let UAHTMLDismissIconResourceKey: String

  • The key representing the additionalPadding in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAHTMLAdditionalPaddingKey

    Swift

    let UAHTMLAdditionalPaddingKey: String

  • The key representing the max width in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAHTMLMaxWidthKey

    Swift

    let UAHTMLMaxWidthKey: String

  • The key representing the max height in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAHTMLMaxHeightKey

    Swift

    let UAHTMLMaxHeightKey: String

  • The key representing the hide dismiss icon flag in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAHTMLHideDismissIconKey

    Swift

    let UAHTMLHideDismissIconKey: String

  • Modal in-app message display style defaults plist name.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAModalStyleFileName

    Swift

    let UAModalStyleFileName: String

  • Maximum number of button supported by a modal message.

    Declaration

    Objective-C

    extern const NSUInteger UAInAppMessageModalMaxButtons

    Swift

    let UAInAppMessageModalMaxButtons: UInt

  • The key representing the dismissIconResource in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAModalDismissIconResourceKey

    Swift

    let UAModalDismissIconResourceKey: String

  • The key representing the additionalPadding in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAModalAdditionalPaddingKey

    Swift

    let UAModalAdditionalPaddingKey: String

  • The key representing the top-level text style in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAModalTextStyleKey

    Swift

    let UAModalTextStyleKey: String

  • The key representing the header style in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAModalHeaderStyleKey

    Swift

    let UAModalHeaderStyleKey: String

  • The key representing the body style in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAModalBodyStyleKey

    Swift

    let UAModalBodyStyleKey: String

  • The key representing the button style in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAModalButtonStyleKey

    Swift

    let UAModalButtonStyleKey: String

  • The key representing the media style in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAModalMediaStyleKey

    Swift

    let UAModalMediaStyleKey: String

  • The key representing the max width in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAModalMaxWidthKey

    Swift

    let UAModalMaxWidthKey: String

  • The key representing the max height in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAModalMaxHeightKey

    Swift

    let UAModalMaxHeightKey: String

  • The key representing the additionalPadding in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UATextAdditonalPaddingKey

    Swift

    let UATextAdditonalPaddingKey: String

  • The key representing the padding in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UALineSpacingKey

    Swift

    let UALineSpacingKey: String

  • Default registry name for landing page action.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UALandingPageActionDefaultRegistryName

    Swift

    let UALandingPageActionDefaultRegistryName: String

  • Default registry alias for landing page action.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UALandingPageActionDefaultRegistryAlias

    Swift

    let UALandingPageActionDefaultRegistryAlias: String

  • The URL key.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UALandingPageURLKey

    Swift

    let UALandingPageURLKey: String

  • The height key.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UALandingPageHeightKey

    Swift

    let UALandingPageHeightKey: String

  • The width key.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UALandingPageWidthKey

    Swift

    let UALandingPageWidthKey: String

  • The aspect lock key.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UALandingPageAspectLockKey

    Swift

    let UALandingPageAspectLockKey: String

  • The default border radius in points.

    Declaration

    Objective-C

    extern const CGFloat UALandingPageDefaultBorderRadiusPoints

    Swift

    let UALandingPageDefaultBorderRadiusPoints: CGFloat

  • Max number of triggers a schedule can support.

    Declaration

    Objective-C

    extern const NSUInteger UAScheduleMaxTriggers

    Swift

    let UAScheduleMaxTriggers: UInt

  • Default registry name for schedule action.

    Declaration

    Objective-C

    extern NSString *const UAScheduleActionDefaultRegistryName

    Swift

    let UAScheduleActionDefaultRegistryName: String

  • Default registry alias for schedule action.

    Declaration

    Objective-C

    extern NSString *const UAScheduleActionDefaultRegistryAlias

    Swift

    let UAScheduleActionDefaultRegistryAlias: String

  • The domain for NSErrors generated by delayWithJSON:error:.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleDelayErrorDomain

    Swift

    let UAScheduleDelayErrorDomain: String

  • JSON key for the seconds delay condition.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleDelaySecondsKey

    Swift

    let UAScheduleDelaySecondsKey: String

  • JSON key delay’s region ID condition.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleDelayRegionKey

    Swift

    let UAScheduleDelayRegionKey: String

  • JSON key delay’s screen names condition.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleDelayScreensKey

    Swift

    let UAScheduleDelayScreensKey: String

  • JSON key for the cancellation triggers.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleDelayCancellationTriggersKey

    Swift

    let UAScheduleDelayCancellationTriggersKey: String

  • JSON key for the app state condition.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleDelayAppStateKey

    Swift

    let UAScheduleDelayAppStateKey: String

  • JSON name for the foreground app state condition.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleDelayAppStateForegroundName

    Swift

    let UAScheduleDelayAppStateForegroundName: String

  • JSON name for the background app state condition.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleDelayAppStateBackgroundName

    Swift

    let UAScheduleDelayAppStateBackgroundName: String

  • Max number of cancellation triggers a delay can support.

    Declaration

    Objective-C

    extern const NSUInteger UAScheduleDelayMaxCancellationTriggers

    Swift

    let UAScheduleDelayMaxCancellationTriggers: UInt

  • The domain for NSErrors generated by triggerWithJSON:error:.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleTriggerErrorDomain

    Swift

    let UAScheduleTriggerErrorDomain: String

  • JSON key for the trigger’s type. The type should be one of the type names.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleTriggerTypeKey

    Swift

    let UAScheduleTriggerTypeKey: String

  • JSON key for the trigger’s predicate.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleTriggerPredicateKey

    Swift

    let UAScheduleTriggerPredicateKey: String

  • JSON key for the trigger’s goal.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleTriggerGoalKey

    Swift

    let UAScheduleTriggerGoalKey: String

  • App init trigger name when defining a trigger in JSON.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleTriggerAppInitName

    Swift

    let UAScheduleTriggerAppInitName: String

  • Foreground trigger name when defining a trigger in JSON.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleTriggerAppForegroundName

    Swift

    let UAScheduleTriggerAppForegroundName: String

  • Background trigger name when defining a trigger in JSON.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleTriggerAppBackgroundName

    Swift

    let UAScheduleTriggerAppBackgroundName: String

  • Region enter trigger name when defining a trigger in JSON.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleTriggerRegionEnterName

    Swift

    let UAScheduleTriggerRegionEnterName: String

  • Region exit trigger name when defining a trigger in JSON.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleTriggerRegionExitName

    Swift

    let UAScheduleTriggerRegionExitName: String

  • Custom event count trigger name when defining a trigger in JSON.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleTriggerCustomEventCountName

    Swift

    let UAScheduleTriggerCustomEventCountName: String

  • Custom event value trigger name when defining a trigger in JSON.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleTriggerCustomEventValueName

    Swift

    let UAScheduleTriggerCustomEventValueName: String

  • Screen trigger name when defining a trigger in JSON.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleTriggerScreenName

    Swift

    let UAScheduleTriggerScreenName: String

  • Active session trigger name when defining a trigger in JSON.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleTriggerActiveSessionName

    Swift

    let UAScheduleTriggerActiveSessionName: String

  • Version trigger name when defining a trigger in JSON.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleTriggerVersionName

    Swift

    let UAScheduleTriggerVersionName: String

  • Metadata key for the push notification. Available when an action is triggered from a push notification or user notification action.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAActionMetadataPushPayloadKey

    Swift

    let UAActionMetadataPushPayloadKey: String

  • Metadata key for the push notification. Available when an action is triggered from a push notification that was presented in the foreground with alert options.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAActionMetadataForegroundPresentationKey

    Swift

    let UAActionMetadataForegroundPresentationKey: String

  • Metadata key for the inbox message’s identifier. Available when an action is triggered from an inbox message.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAActionMetadataInboxMessageIDKey

    Swift

    let UAActionMetadataInboxMessageIDKey: String

  • Metadata key for the user notification action identifier. Available when an action is triggered from a user notification action.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAActionMetadataUserNotificationActionIDKey

    Swift

    let UAActionMetadataUserNotificationActionIDKey: String

  • Metadata key for the user notification action response info. Available when an action is triggered from a user notification action with the behavior UIUserNotificationActionBehaviorTextInput.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAActionMetadataResponseInfoKey

    Swift

    let UAActionMetadataResponseInfoKey: String

  • Metadata key for the name of the action in the registry. Available when an action is triggered by name.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAActionMetadataRegisteredName

    Swift

    let UAActionMetadataRegisteredName: String