Constants

The following constants are available globally.

  • The domain for NSErrors generated by the NSJSONSerialization+UAAdditions methods.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAJSONSerializationErrorDomain

    Swift

    let UAJSONSerializationErrorDomain: String
  • The domain for errors encountered during an action operator.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAActionOperatorErrorDomain

    Swift

    let UAActionOperatorErrorDomain: 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. Available when an action is triggered from a inbox message.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAActionMetadataInboxMessageKey

    Swift

    let UAActionMetadataInboxMessageKey: 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 (iOS 9 and above).

    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
  • JSON key for the schedule’s actions.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAActionScheduleInfoActionsKey

    Swift

    let UAActionScheduleInfoActionsKey: String
  • Maximum number of associated IDs that can be set.

    Declaration

    Objective-C

    extern const NSUInteger UAAssociatedIdentifiersMaxCount

    Swift

    let UAAssociatedIdentifiersMaxCount: UInt
  • Character limit for associated IDs or keys.

    Declaration

    Objective-C

    extern const NSUInteger UAAssociatedIdentifiersMaxCharacterCount

    Swift

    let UAAssociatedIdentifiersMaxCharacterCount: UInt
  • Automation schedules limit.

    Declaration

    Objective-C

    extern const NSUInteger UAAutomationScheduleLimit

    Swift

    let UAAutomationScheduleLimit: UInt
  • 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
  • The max character limit for Strings.

    Declaration

    Objective-C

    extern const NSUInteger UACustomEventCharacterLimit

    Swift

    let UACustomEventCharacterLimit: UInt
  • The max number of properties.

    Declaration

    Objective-C

    extern const NSUInteger UACustomEventMaxPropertiesCount

    Swift

    let UACustomEventMaxPropertiesCount: UInt
  • Argument value to enable user notifications.

    Declaration

    Objective-C

    extern NSString *const UAEnableUserNotificationsActionValue

    Swift

    let UAEnableUserNotificationsActionValue: String
  • Argument value to enable user location.

    Declaration

    Objective-C

    extern NSString *const UAEnableLocationActionValue

    Swift

    let UAEnableLocationActionValue: String
  • Argument value to enable background location.

    Declaration

    Objective-C

    extern NSString *const UAEnableBackgroundLocationActionValue

    Swift

    let UAEnableBackgroundLocationActionValue: String
  • The domain for NSErrors generated by matcherWithJSON:error:.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAJSONMatcherErrorDomain

    Swift

    let UAJSONMatcherErrorDomain: String
  • The domain for NSErrors generated by predicateWithJSON:error.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAJSONPredicateErrorDomain

    Swift

    let UAJSONPredicateErrorDomain: String
  • The domain for NSErrors generated by matcherWithJSON:error:.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAJSONValueMatcherErrorDomain

    Swift

    let UAJSONValueMatcherErrorDomain: String
  • Action identifier representing an application launch via notification.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UANotificationDefaultActionIdentifier

    Swift

    let UANotificationDefaultActionIdentifier: String
  • Action identifier representing a notification dismissal.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UANotificationDismissActionIdentifier

    Swift

    let UANotificationDismissActionIdentifier: String
  • The key for the top padding inside a stlye plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAPaddingTopKey

    Swift

    let UAPaddingTopKey: String
  • The key for the bottom padding inside a stlye plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAPaddingBottomKey

    Swift

    let UAPaddingBottomKey: String
  • The key for the trailing padding inside a stlye plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAPaddingTrailingKey

    Swift

    let UAPaddingTrailingKey: String
  • The key for the leading padding inside a stlye plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAPaddingLeadingKey

    Swift

    let UAPaddingLeadingKey: String
  • NSNotification event when the channel is created. The event will contain the channel ID under UAChannelCreatedEventChannelKey and a flag under UAChannelCreatedEventExistingKey indicating if the the channel was restored or a new channel was created.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAChannelCreatedEvent

    Swift

    let UAChannelCreatedEvent: String
  • NSNotification event when the channel is updated. The event will contain the channel ID under UAChannelUpdatedEventChannelKey

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAChannelUpdatedEvent

    Swift

    let UAChannelUpdatedEvent: String
  • Channel ID key for the channel created event.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAChannelCreatedEventChannelKey

    Swift

    let UAChannelCreatedEventChannelKey: String
  • Channel ID key for the channel updated event.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAChannelUpdatedEventChannelKey

    Swift

    let UAChannelUpdatedEventChannelKey: String
  • Channel existing key for the channel created event.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAChannelCreatedEventExistingKey

    Swift

    let UAChannelCreatedEventExistingKey: String
  • Notification option for notification type none. Not included in UANotificationOptions enum to maintain parity with UNAuthorizationOptions.

    Declaration

    Objective-C

    static const UANotificationOptions UANotificationOptionNone = 0

    Swift

    let UANotificationOptionNone: UANotificationOptions
  • 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
  • Max number of triggers a schedule can support.

    Declaration

    Objective-C

    extern const NSUInteger UAScheduleInfoMaxTriggers

    Swift

    let UAScheduleInfoMaxTriggers: 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
  • The takeOff method must be called on the main thread. Not doing so results in this exception being thrown.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAirshipTakeOffBackgroundThreadException

    Swift

    let UAirshipTakeOffBackgroundThreadException: String
  • Message identifier limit (100 characters).

    Declaration

    Objective-C

    extern const NSUInteger UAInAppMessageIDLimit

    Swift

    let UAInAppMessageIDLimit: UInt
  • 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
  • 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 button style in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAButtonStyleKey

    Swift

    let UAButtonStyleKey: 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
  • 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 additionalPadding in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAFullScreenAdditonalPaddingKey

    Swift

    let UAFullScreenAdditonalPaddingKey: 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
  • The key representing the media additionalPadding in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAMediaAdditionalPaddingKey

    Swift

    let UAMediaAdditionalPaddingKey: 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
  • JSON key for the schedule’s in-app message.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAScheduleInfoInAppMessageKey

    Swift

    let UAScheduleInfoInAppMessageKey: 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 UATextSpacingKey

    Swift

    let UATextSpacingKey: String
  • The key representing the padding in a style plist.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UALineSpacingKey

    Swift

    let UALineSpacingKey: String
  • NSNotification posted when the message list is about to update.

    Note: this notification is posted regardless of the type of update (retrieval, batch).

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAInboxMessageListWillUpdateNotification

    Swift

    static let UAInboxMessageListWillUpdate: NSNotification.Name
  • NSNotification posted when the message list is finished updating.

    Note: this notification is posted regardless of the type of update (retrieval, batch) and regardless of the success/failure of the underlying operation.

    Declaration

    Objective-C

    extern NSString *const _Nonnull UAInboxMessageListUpdatedNotification

    Swift

    static let UAInboxMessageListUpdated: NSNotification.Name
  • The URL key.

    Declaration

    Objective-C

    extern NSString *const UALandingPageURLKey
  • The height key.

    Declaration

    Objective-C

    extern NSString *const UALandingPageHeightKey
  • The width key.

    Declaration

    Objective-C

    extern NSString *const UALandingPageWidthKey
  • The aspect lock key.

    Declaration

    Objective-C

    extern NSString *const UALandingPageAspectLockKey
  • The fill constant.

    Declaration

    Objective-C

    extern NSString *const UALandingPageFill
  • The show link prompt key.

    Declaration

    Objective-C

    extern NSString *const UARateAppShowLinkPromptKey
  • The link prompt’s title key.

    Declaration

    Objective-C

    extern NSString *const UARateAppLinkPromptTitleKey
  • The link prompt’s body key.

    Declaration

    Objective-C

    extern NSString *const UARateAppLinkPromptBodyKey
  • The itunes ID key.

    Declaration

    Objective-C

    extern NSString *const UARateAppItunesIDKey