Classes

The following classes are available globally.

  • An actions schedule.

    See more

    Declaration

    Objective-C

    @interface UAActionSchedule : UASchedule

    Swift

    class UAActionSchedule : UASchedule

  • Interface for accessing AirshipAutomation resources.

    See more

    Declaration

    Objective-C

    @interface UAAutomationResources : NSObject

    Swift

    class UAAutomationResources : NSObject

  • Action to cancel automation schedules.

    This action is registered under the names cancel_scheduled_actions and ^csa.

    Expected argument values: NSString with the value “all” or an NSDictionary with:

    • “groups”: A schedule group or an array of schedule groups.
    • “ids”: A schedule ID or an array of schedule IDs.

    Valid situations: UASituationBackgroundPush, UASituationForegroundPush UASituationWebViewInvocation, UASituationManualInvocation, and UASituationAutomation

    Result value: nil.

    Declaration

    Objective-C

    @interface UACancelSchedulesAction : UAAction

    Swift

    class UACancelSchedulesAction : UAAction

  • Provides a control interface for creating, canceling and executing in-app automations.

    See more

    Declaration

    Objective-C

    @interface UAInAppAutomation : UAComponent

    Swift

    class UAInAppAutomation : UAComponent

  • Builder class for UAInAppMessage.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageBuilder : NSObject

    Swift

    class UAInAppMessageBuilder : NSObject

  • Model object representing in-app message data.

    Note

    This object is built using UAInAppMessageBuilder.
    See more

    Declaration

    Objective-C

    @interface UAInAppMessage : NSObject

    Swift

    class UAInAppMessage : NSObject

  • Manages the preparation and caching of in-app message assets.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageAssetManager : NSObject

    Swift

    class UAInAppMessageAssetManager : NSObject

  • Banner in-app message display adapter.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageBannerAdapter
    : NSObject <UAInAppMessageAdapterProtocol>

    Swift

    class UAInAppMessageBannerAdapter : NSObject, UAInAppMessageAdapterProtocol

  • Builder class for UAInAppMessageBannerDisplayContent.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageBannerDisplayContentBuilder : NSObject

    Swift

    class UAInAppMessageBannerDisplayContentBuilder : NSObject

  • Display content for a banner in-app message.

    Note

    This object is built using UAInAppMessageBannerDisplayContentBuilder.
    See more

    Declaration

    Objective-C

    @interface UAInAppMessageBannerDisplayContent : UAInAppMessageDisplayContent

    Swift

    class UAInAppMessageBannerDisplayContent : UAInAppMessageDisplayContent

  • Model object representing a custom style to be applied to banner in-app message.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageBannerStyle : NSObject <UAInAppMessageStyleProtocol>

    Swift

    class UAInAppMessageBannerStyle : NSObject, UAInAppMessageStyleProtocol

  • Builder class for UAInAppMessageButtonInfo.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageButtonInfoBuilder : NSObject

    Swift

    class UAInAppMessageButtonInfoBuilder : NSObject

  • Defines an in-app message button.

    Note

    This object is built using UAInAppMessageButtonInfoBuilder.
    See more

    Declaration

    Objective-C

    @interface UAInAppMessageButtonInfo : NSObject

    Swift

    class UAInAppMessageButtonInfo : NSObject

  • Model object representing a custom style to be applied to an in-app message button component. Nil parameters are given default styling.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageButtonStyle : NSObject

    Swift

    class UAInAppMessageButtonStyle : NSObject

  • Display content for a custom in-app message.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageCustomDisplayContent : UAInAppMessageDisplayContent

    Swift

    class UAInAppMessageCustomDisplayContent : UAInAppMessageDisplayContent

  • A default implementation of the UAInAppMessageDisplayCoordinator protocol. Use this class as a reference implementation, or subclass for custom implementations or coordination behavior overrides.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageDefaultDisplayCoordinator
    : NSObject <UAInAppMessageDisplayCoordinator>

    Swift

    class UAInAppMessageDefaultDisplayCoordinator : NSObject, UAInAppMessageDisplayCoordinator

  • Display content for an in-app message.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageDisplayContent : NSObject

    Swift

    class UAInAppMessageDisplayContent : NSObject

  • Full screen in-app message display adapter.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageFullScreenAdapter
    : NSObject <UAInAppMessageAdapterProtocol>

    Swift

    class UAInAppMessageFullScreenAdapter : NSObject, UAInAppMessageAdapterProtocol

  • Builder class for UAInAppMessageFullScreenDisplayContent.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageFullScreenDisplayContentBuilder : NSObject

    Swift

    class UAInAppMessageFullScreenDisplayContentBuilder : NSObject

  • Display content for a full screen in-app message.

    Note

    This object is built using UAInAppMessageFullScreenDisplayContentBuilder.
    See more

    Declaration

    Objective-C

    @interface UAInAppMessageFullScreenDisplayContent : UAInAppMessageDisplayContent

    Swift

    class UAInAppMessageFullScreenDisplayContent : UAInAppMessageDisplayContent

  • Model object representing a custom style to be applied to full screen in-app message.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageFullScreenStyle
    : NSObject <UAInAppMessageStyleProtocol>

    Swift

    class UAInAppMessageFullScreenStyle : NSObject, UAInAppMessageStyleProtocol

  • HTML in-app message display adapter.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageHTMLAdapter : NSObject <UAInAppMessageAdapterProtocol>

    Swift

    class UAInAppMessageHTMLAdapter : NSObject, UAInAppMessageAdapterProtocol

  • Builder class for UAInAppMessageHTMLDisplayContent.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageHTMLDisplayContentBuilder : NSObject

    Swift

    class UAInAppMessageHTMLDisplayContentBuilder : NSObject

  • Display content for an HTML in-app message.

    Note

    This object is built using UAInAppMessageHTMLDisplayContentBuilder.
    See more

    Declaration

    Objective-C

    @interface UAInAppMessageHTMLDisplayContent : UAInAppMessageDisplayContent

    Swift

    class UAInAppMessageHTMLDisplayContent : UAInAppMessageDisplayContent

  • Model object representing a custom style to be applied to HTML in-app messages.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageHTMLStyle : NSObject <UAInAppMessageStyleProtocol>

    Swift

    class UAInAppMessageHTMLStyle : NSObject, UAInAppMessageStyleProtocol

  • An implementation of the UAInAppMessageDisplayCoordinator protocol that allows immediate display.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageImmediateDisplayCoordinator
    : NSObject <UAInAppMessageDisplayCoordinator>

    Swift

    class UAInAppMessageImmediateDisplayCoordinator : NSObject, UAInAppMessageDisplayCoordinator

  • Provides a control interface for creating, canceling and executing in-app message schedules.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageManager : NSObject

    Swift

    class UAInAppMessageManager : NSObject

  • Defines in-app message media content.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageMediaInfo : NSObject

    Swift

    class UAInAppMessageMediaInfo : NSObject

  • Model object representing a custom style to be applied to an in-app message media component. Nil parameters are given default styling.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageMediaStyle : NSObject

    Swift

    class UAInAppMessageMediaStyle : NSObject

  • Modal in-app message display adapter.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageModalAdapter : NSObject <UAInAppMessageAdapterProtocol>

    Swift

    class UAInAppMessageModalAdapter : NSObject, UAInAppMessageAdapterProtocol

  • Builder class for UAInAppMessageModalDisplayContent.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageModalDisplayContentBuilder : NSObject

    Swift

    class UAInAppMessageModalDisplayContentBuilder : NSObject

  • Display content for a modal in-app message.

    Note

    This object is built using UAInAppMessageModalDisplayContentBuilder.
    See more

    Declaration

    Objective-C

    @interface UAInAppMessageModalDisplayContent : UAInAppMessageDisplayContent

    Swift

    class UAInAppMessageModalDisplayContent : UAInAppMessageDisplayContent

  • Model object representing a custom style to be applied to modal in-app messages.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageModalStyle : NSObject <UAInAppMessageStyleProtocol>

    Swift

    class UAInAppMessageModalStyle : NSObject, UAInAppMessageStyleProtocol

  • In-app message resolution info.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageResolution : NSObject

    Swift

    class UAInAppMessageResolution : NSObject

  • Scene manager for in-app messages.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageSceneManager : NSObject

    Swift

    class UAInAppMessageSceneManager : NSObject

  • An in-app message schedule.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageSchedule : UASchedule

    Swift

    class UAInAppMessageSchedule : UASchedule

  • Builder class for UAInAppMessageTextInfo.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageTextInfoBuilder : NSObject

    Swift

    class UAInAppMessageTextInfoBuilder : NSObject

  • Defines the text that appears in an in-app message.

    Note

    This object is built using UAInAppMessageTextInfoBuilder.
    See more

    Declaration

    Objective-C

    @interface UAInAppMessageTextInfo : NSObject

    Swift

    class UAInAppMessageTextInfo : NSObject

  • Model object representing a custom style to be applied to an in-app message text component. Nil parameters are given default styling.

    See more

    Declaration

    Objective-C

    @interface UAInAppMessageTextStyle : NSObject

    Swift

    class UAInAppMessageTextStyle : NSObject

  • Schedules a landing page to display ASAP.

    This action is registered under the names landing_page_action and ^p.

    Expected argument values: url: NSString or NSURL. width: Optional Int or String. Width should be specified in points or as “fill” to fill current screen. Defaults to fill. height: Optional Int or String. Height should be specified in points or fill to fill current screen. Defaults to fill. aspect_lock: Optional Boolean. Determines if aspect ratio is maintained during resizing to fit screen size. Defaults to false.

    Valid situations: UASituationForegroundPush, UASituationLaunchedFromPush, UASituationWebViewInvocation, UASituationManualInvocation, UASituationForegroundInteractiveButton, and UASituationAutomation

    Result value: nil

    Fetch result: UAActionFetchResultNewData, or UAActionFetchResultFailed if the data could not be fetched.

    See more

    Declaration

    Objective-C

    @interface UALandingPageAction : UAAction

    Swift

    class UALandingPageAction : UAAction

  • Model object representing in-app message data.

    See more

    Declaration

    Objective-C

    @interface UALegacyInAppMessage : NSObject

    Swift

    class UALegacyInAppMessage : NSObject

  • Manager class for in-app messaging.

    See more

    Declaration

    Objective-C

    @interface UALegacyInAppMessaging
    : UAComponent <UALegacyInAppMessageFactoryDelegate>

    Swift

    class UALegacyInAppMessaging : UAComponent, UALegacyInAppMessageFactoryDelegate

  • Builder class for UASchedule.

    See more

    Declaration

    Objective-C

    @interface UAScheduleBuilder : NSObject

    Swift

    class UAScheduleBuilder : NSObject

  • Contains the schedule info and identifier.

    Note

    This object is built using UAScheduleBuilder.
    See more

    Declaration

    Objective-C

    @interface UASchedule : NSObject

    Swift

    class UASchedule : NSObject

  • Action to schedule other actions.

    This action is registered under the names schedule_actions and ^sa.

    Expected argument values: NSDictionary representing a schedule info JSON.

    Valid situations: UASituationBackgroundPush, UASituationForegroundPush UASituationWebViewInvocation, UASituationManualInvocation, and UASituationAutomation

    Result value: Schedule ID or nil if the schedule failed.

    Declaration

    Objective-C

    @interface UAScheduleAction : UAAction

    Swift

    class UAScheduleAction : UAAction

  • Builder class for UAScheduleAudience.

    See more

    Declaration

    Objective-C

    @interface UAScheduleAudienceBuilder : NSObject

    Swift

    class UAScheduleAudienceBuilder : NSObject

  • Model object for an in-app message audience constraint.

    Note

    This object is built using UAScheduleAudienceBuilder.
    See more

    Declaration

    Objective-C

    @interface UAScheduleAudience : NSObject

    Swift

    class UAScheduleAudience : NSObject

  • Builder class for UAScheduleDelay.

    See more

    Declaration

    Objective-C

    @interface UAScheduleDelayBuilder : NSObject

    Swift

    class UAScheduleDelayBuilder : NSObject

  • A delay defines an amount of time and/or app conditions that must be met before the actions are able to be executed. The delay occurs after one of the triggers hits its goals.

    Note

    This object is built using UAScheduleDelayBuilder.
    See more

    Declaration

    Objective-C

    @interface UAScheduleDelay : NSObject

    Swift

    class UAScheduleDelay : NSObject

  • Builder class for UAScheduleEdits.

    See more

    Declaration

    Objective-C

    @interface UAScheduleEditsBuilder : NSObject

    Swift

    class UAScheduleEditsBuilder : NSObject

  • Schedule edits.

    See more

    Declaration

    Objective-C

    @interface UAScheduleEdits : NSObject

    Swift

    class UAScheduleEdits : NSObject

  • Trigger defines a condition to execute actions or cancel a delayed execution of actions.

    See more

    Declaration

    Objective-C

    @interface UAScheduleTrigger : NSObject <NSSecureCoding>

    Swift

    class UAScheduleTrigger : NSObject, NSSecureCoding

  • Model object for an audience tag selector.

    See more

    Declaration

    Objective-C

    @interface UATagSelector : NSObject

    Swift

    class UATagSelector : NSObject

  • A UAAccountEventTemplate represents a custom account event template for the application.

    See more

    Declaration

    Objective-C

    @interface UAAccountEventTemplate : NSObject

    Swift

    class UAAccountEventTemplate : NSObject

  • Base class for actions, which defines a modular unit of work.

    See more

    Declaration

    Objective-C

    @interface UAAction : NSObject

    Swift

    class UAAction : NSObject

  • Contains the arguments passed into an action during execution.

    See more

    Declaration

    Objective-C

    @interface UAActionArguments : NSObject

    Swift

    class UAActionArguments : NSObject

  • This class is responsible for runtime-persisting actions and associating them with names and predicates.

    See more

    Declaration

    Objective-C

    @interface UAActionRegistry : NSObject

    Swift

    class UAActionRegistry : NSObject

  • An entry in the UAActionRegistry.

    See more

    Declaration

    Objective-C

    @interface UAActionRegistryEntry : NSObject

    Swift

    class UAActionRegistryEntry : NSObject

  • A class that holds the results of running an action, with optional metadata.

    See more

    Declaration

    Objective-C

    @interface UAActionResult : NSObject

    Swift

    class UAActionResult : NSObject

  • A helper class for running actions by name or by reference.

    See more

    Declaration

    Objective-C

    @interface UAActionRunner : NSObject

    Swift

    class UAActionRunner : NSObject

  • Wrapper around UIActivityViewController that takes an optional block that will fire after the view disappears.

    See more

    Declaration

    Objective-C

    
@interface UAActivityViewController
    : UIActivityViewController <UIPopoverPresentationControllerDelegate,
                                UIPopoverControllerDelegate>

    Swift

    class UAActivityViewController : UIActivityViewController, UIPopoverPresentationControllerDelegate, UIPopoverControllerDelegate

  • An action that adds a custom event.

    This action is registered under the name “add_custom_event_action”.

    Expected argument values: A dictionary of keys for the custom event. When a custom event action is triggered from a Message Center Rich Push Message, the interaction type and ID will automatically be filled for the message if they are left blank.

    Valid situations: UASituationForegroundPush, UASituationLaunchedFromPush, UASituationWebViewInvocation, UASituationManualInvocation, UASituationBackgroundPush, UASituationForegroundInteractiveButton, UASituationBackgroundInteractiveButton, and UASituationAutomation

    Result value: nil

    Fetch result: UAActionFetchResultNoData

    Default predicate: Only accepts UASituationWebViewInvocation and UASituationManualInvocation

    Declaration

    Objective-C

    @interface UAAddCustomEventAction : UAAction

    Swift

    class UAAddCustomEventAction : UAAction

  • Adds tags. This Action is registered under the names ^+t and “add_tags_action”.

    Expected argument values: NSString (single tag), NSArray (single or multiple tags), or NSDictionary (tag groups). An example tag group JSON payload: { “channel”: { “channel_tag_group”: [“channel_tag_1”, “channel_tag_2”], “other_channel_tag_group”: [“other_channel_tag_1”] }, “named_user”: { “named_user_tag_group”: [“named_user_tag_1”, “named_user_tag_2”], “other_named_user_tag_group”: [“other_named_user_tag_1”] }, “device”: [ “tag”, “another_tag”] }

    Valid situations: UASituationForegroundPush, UASituationLaunchedFromPush UASituationWebViewInvocation, UASituationForegroundInteractiveButton, UASituationBackgroundInteractiveButton, UASituationManualInvocation, and UASituationAutomation

    Default predicate: Rejects foreground pushes with visible display options

    Result value: nil

    Error: nil

    Fetch result: UAActionFetchResultNoData

    Declaration

    Objective-C

    @interface UAAddTagsAction : UAModifyTagsAction

    Swift

    class UAAddTagsAction : UAModifyTagsAction

  • Convenience class for aggregating and merging multiple UAActionResults.

    See more

    Declaration

    Objective-C

    @interface UAAggregateActionResult : UAActionResult

    Swift

    class UAAggregateActionResult : UAActionResult

  • The UAAnalytics object provides an interface to the Airship Analytics API.

    See more

    Declaration

    Objective-C

    @interface UAAnalytics : UAComponent

    Swift

    class UAAnalytics : UAComponent

  • Application hooks required by Airship. If automaticSetupEnabled is enabled (enabled by default), Airship will automatically integrate these calls into the application by swizzling methods. If automaticSetupEnabled is disabled, the application must call through to every method provided by this class.

    See more

    Declaration

    Objective-C

    @interface UAAppIntegration : NSObject

    Swift

    class UAAppIntegration : NSObject

  • The UAApplicationMetrics class keeps track of application-related metrics.

    See more

    Declaration

    Objective-C

    @interface UAApplicationMetrics : NSObject

    Swift

    class UAApplicationMetrics : NSObject

  • Defines analytics identifiers to be associated with the device.

    See more

    Declaration

    Objective-C

    @interface UAAssociatedIdentifiers : NSObject

    Swift

    class UAAssociatedIdentifiers : NSObject

  • Defines changes to perform on channel attributes.

    See more

    Declaration

    Objective-C

    @interface UAAttributeMutations : NSObject

    Swift

    class UAAttributeMutations : NSObject

  • A circle with an X in it, drawn to fill the frame.

    Declaration

    Objective-C

    @interface UABespokeCloseView : UIView

    Swift

    class UABespokeCloseView : UIView

  • An abstraction around a nicer looking loading indicator that embeds a UIActivityIndicatorView in a translucent black beveled rect.

    See more

    Declaration

    Objective-C

    @interface UABeveledLoadingIndicator : UIView

    Swift

    class UABeveledLoadingIndicator : UIView

  • This singleton provides an interface to the channel functionality provided by the Airship iOS Push API.

    See more

    Declaration

    Objective-C

    @interface UAChannel : UAComponent

    Swift

    class UAChannel : UAComponent

  • Channel Capture copies the channelId to the device clipboard after a specific number of knocks (app foregrounds) within a specific timeframe. Channel Capture can be enabled or disabled in Airship Config.

    See more

    Declaration

    Objective-C

    
@interface UAChannelCapture : NSObject

    Swift

    class UAChannelCapture : NSObject

  • A UACircularRegion defines a circular region with a radius, and latitude and longitude from its center.

    See more

    Declaration

    Objective-C

    @interface UACircularRegion : NSObject

    Swift

    class UACircularRegion : NSObject

  • A collection of utilities for converting UIColors to and from various string representations.

    See more

    Declaration

    Objective-C

    @interface UAColorUtils : NSObject

    Swift

    class UAColorUtils : NSObject

  • Base class for main SDK components.

    See more

    Declaration

    Objective-C

    @interface UAComponent : NSObject

    Swift

    class UAComponent : NSObject

  • The UAConfig object provides an interface for passing common configurable values to [UAirship takeOff]. The simplest way to use this class is to add an AirshipConfig.plist file in your app’s bundle and set the desired options. The plist keys use the same names as this class’s configuration options. Older, all-caps keys are still supported, but you should migrate your properties file to make use of a number of new options.

    See more

    Declaration

    Objective-C

    @interface UAConfig : NSObject <NSCopying>

    Swift

    class UAConfig : NSObject, NSCopying

  • A UACustomEvent captures information regarding a custom event for UAAnalytics.

    See more

    Declaration

    Objective-C

    @interface UACustomEvent : UAEvent

    Swift

    class UACustomEvent : UAEvent

  • Opens a deep link URL. This action is registered under the names ^d and deep_link_action.

    Expected argument values: NSString

    Valid situations: UASituationForegroundPush, UASituationLaunchedFromPush UASituationWebViewInvocation, UASituationForegroundInteractiveButton, UASituationManualInvocation, and UASituationAutomation

    Result value: An NSString representation of the input

    Error: UAOpenExternalURLActionErrorCodeURLFailedToOpen if the URL could not be opened

    Fetch result: UAActionFetchResultNoData

    Declaration

    Objective-C

    @interface UADeepLinkAction : UAOpenExternalURLAction

    Swift

    class UADeepLinkAction : UAOpenExternalURLAction

  • A convenience class for creating self-referencing cancellation tokens.

    Note

    It is left up to the creator to determine what is disposed of and under what circumstances. This includes threading and memory management concerns.
    See more

    Declaration

    Objective-C

    @interface UADisposable : NSObject

    Swift

    class UADisposable : NSObject

  • Enables an Airship feature.

    This action is registered under the names enable_feature and ^ef.

    Expected argument values:

    • “user_notifications”: To enable user notifications.
    • “location”: To enable location updates.
    • “background_location”: To enable location and allow background updates.

    Valid situations: UASituationForegroundPush, UASituationLaunchedFromPush, UASituationWebViewInvocation, UASituationManualInvocation, UASituationForegroundInteractiveButton, and UASituationAutomation

    Default predicate: Rejects foreground pushes with visible display options.

    Result value: Empty.

    Declaration

    Objective-C

    @interface UAEnableFeatureAction : UAAction

    Swift

    class UAEnableFeatureAction : UAAction

  • This base class encapsulates analytics events.

    See more

    Declaration

    Objective-C

    @interface UAEvent : NSObject

    Swift

    class UAEvent : NSObject

  • Fetches device info.

    This action is registered under the names fetch_device_info and ^fdi.

    Expected argument values: none.

    Valid situations: UASituationLaunchedFromPush, UASituationWebViewInvocation, UASituationManualInvocation, UASituationForegroundInteractiveButton, UASituationBackgroundInteractiveButton, and UASituationAutomation

    Result value: JSON payload containing the device’s channel ID, named user ID, push opt-in status, location enabled status, and tags. An example response as JSON: { “channel_id”: “9c36e8c7-5a73-47c0-9716-99fd3d4197d5”, “push_opt_in”: true, “location_enabled”: true, “named_user”: “cool_user”, “tags”: [“tag1”, “tag2, "tag3”] }

    Default Registration Predicate: Only accepts UASituationManualInvocation and UASituationWebViewInvocation

    Declaration

    Objective-C

    @interface UAFetchDeviceInfoAction : UAAction

    Swift

    class UAFetchDeviceInfoAction : UAAction

  • Event to track install attributions.

    See more

    Declaration

    Objective-C

    @interface UAInstallAttributionEvent : UAEvent

    Swift

    class UAInstallAttributionEvent : UAEvent

  • Matcher for a JSON payload.

    See more

    Declaration

    Objective-C

    @interface UAJSONMatcher : NSObject

    Swift

    class UAJSONMatcher : NSObject

  • Predicate for JSON payloads.

    See more

    Declaration

    Objective-C

    @interface UAJSONPredicate : NSObject

    Swift

    class UAJSONPredicate : NSObject

  • Defines a JSON value matcher.

    See more

    Declaration

    Objective-C

    @interface UAJSONValueMatcher : NSObject

    Swift

    class UAJSONValueMatcher : NSObject

  • Model object for holding data associated with JS delegate calls

    See more

    Declaration

    Objective-C

    
@interface UAJavaScriptCommand : NSObject

    Swift

    class UAJavaScriptCommand : NSObject

  • The JavaScript environment builder that is used by the native bridge.

    See more

    Declaration

    Objective-C

    
@interface UAJavaScriptEnvironment : NSObject

    Swift

    class UAJavaScriptEnvironment : NSObject

  • A UAMediaEventTemplate represents a custom media event template for the application.

    See more

    Declaration

    Objective-C

    @interface UAMediaEventTemplate : NSObject

    Swift

    class UAMediaEventTemplate : NSObject

  • Modifies attributes This Action is registered under the names ^a and “modify_attributes_action”.

    An example JSON payload:

    { “channel”: { set: [{“key”: value}, …], remove: [“attribute”, ….] }, “named_user”: { set: [{“key”: value}, …], remove: [“attribute”, ….] } }

    Valid situations: UASituationForegroundPush, UASituationLaunchedFromPush UASituationWebViewInvocation, UASituationForegroundInteractiveButton, UASituationBackgroundInteractiveButton, UASituationManualInvocation, and UASituationAutomation

    Default predicate: Rejects foreground pushes with visible display options

    Result value: nil

    Error: nil

    Fetch result: UAActionFetchResultNoData

    Declaration

    Objective-C

    @interface UAModifyAttributesAction : UAAction

    Swift

    class UAModifyAttributesAction : UAAction

  • This is the base class for UAAddTagsAction and UARemoveTagsAction.

    See more

    Declaration

    Objective-C

    @interface UAModifyTagsAction : UAAction

    Swift

    class UAModifyTagsAction : UAAction

  • The named user is an alternate method of identifying the device. Once a named user is associated to the device, it can be used to send push notifications to the device.

    See more

    Declaration

    Objective-C

    @interface UANamedUser : UAComponent

    Swift

    class UANamedUser : UAComponent

  • The native bridge will automatically loads the Airship JavaScript environment into whitlelisted sites. The native bridge must be assigned as the navigation delegate on a WKWebView in order to function.

    See more

    Declaration

    Objective-C

    
@interface UANativeBridge : NSObject <WKNavigationDelegate>

    Swift

    class UANativeBridge : NSObject, WKNavigationDelegate

  • iOS version-independent wrapper for UNNotificationAction.

    See more

    Declaration

    Objective-C

    @interface UANotificationAction : NSObject

    Swift

    class UANotificationAction : NSObject

  • Utility methods to create categories from plist files or NSDictionaries.

    See more

    Declaration

    Objective-C

    @interface UANotificationCategories : NSObject

    Swift

    class UANotificationCategories : NSObject

  • iOS version-independent wrapper for UNNotificationCategory.

    See more

    Declaration

    Objective-C

    @interface UANotificationCategory : NSObject

    Swift

    class UANotificationCategory : NSObject

  • iOS version-independent wrapper for UNNotificationContent. Contains convenient accessors to the notification’s content.

    See more

    Declaration

    Objective-C

    @interface UANotificationContent : NSObject

    Swift

    class UANotificationContent : NSObject

  • iOS version-independent wrapper for UNNotificationResponse. Contains the user’s reponse to a notification.

    See more

    Declaration

    Objective-C

    @interface UANotificationResponse : NSObject

    Swift

    class UANotificationResponse : NSObject

  • Opens a URL, either in safari or using custom URL schemes. This action is registered under the names ^u and open_external_url_action.

    Expected argument values: NSString

    Valid situations: UASituationForegroundPush, UASituationLaunchedFromPush UASituationWebViewInvocation, UASituationForegroundInteractiveButton, UASituationManualInvocation, and UASituationAutomation

    Result value: An NSString representation of the input

    Error: UAOpenExternalURLActionErrorCodeURLFailedToOpen if the URL could not be opened

    Fetch result: UAActionFetchResultNoData

    See more

    Declaration

    Objective-C

    @interface UAOpenExternalURLAction : UAAction

    Swift

    class UAOpenExternalURLAction : UAAction

  • Padding adds constant values to a view’s top, bottom, trailing or leading constraints within its parent view.

    See more

    Declaration

    Objective-C

    @interface UAPadding : NSObject

    Swift

    class UAPadding : NSObject

  • Sets the pasteboard’s string.

    This action is registered under the names clipboard_action and ^c.

    Expected argument values: NSString or an NSDictionary with the pasteboard’s string under the ‘text’ key.

    Valid situations: UASituationLaunchedFromPush, UASituationWebViewInvocation, UASituationManualInvocation, UASituationForegroundInteractiveButton, UASituationBackgroundInteractiveButton, and UASituationAutomation

    Result value: The arguments value.

    Declaration

    Objective-C

    
@interface UAPasteboardAction : UAAction

    Swift

    class UAPasteboardAction : UAAction

  • A UAProximityRegion defines a proximity region with an identifier, major and minor.

    See more

    Declaration

    Objective-C

    @interface UAProximityRegion : NSObject

    Swift

    class UAProximityRegion : NSObject

  • This singleton provides an interface to the functionality provided by the Airship iOS Push API.

    See more

    Declaration

    Objective-C

    @interface UAPush : UAComponent

    Swift

    class UAPush : UAComponent

  • A UARegion event captures information regarding a region event for UAAnalytics.

    See more

    Declaration

    Objective-C

    @interface UARegionEvent : UAEvent

    Swift

    class UARegionEvent : UAEvent

  • Removes tags. This Action is registered under the names ^-t and “remove_tags_action”.

    Expected argument values: NSString (single tag), NSArray (single or multiple tags), or NSDictionary (tag groups). An example tag group JSON payload: { “channel”: { “channel_tag_group”: [“channel_tag_1”, “channel_tag_2”], “other_channel_tag_group”: [“other_channel_tag_1”] }, “named_user”: { “named_user_tag_group”: [“named_user_tag_1”, “named_user_tag_2”], “other_named_user_tag_group”: [“other_named_user_tag_1”] }, “device”: [ “tag”, “another_tag”] }

    Valid situations: UASituationForegroundPush, UASituationLaunchedFromPush UASituationWebViewInvocation, UASituationForegroundInteractiveButton, UASituationBackgroundInteractiveButton, UASituationManualInvocation and UASituationAutomation

    Default predicate: Rejects foreground pushes with visible display options

    Result value: nil

    Error: nil

    Fetch result: UAActionFetchResultNoData

    Declaration

    Objective-C

    @interface UARemoveTagsAction : UAModifyTagsAction

    Swift

    class UARemoveTagsAction : UAModifyTagsAction

  • A UARetailEventTemplate represents a custom retail event template for the application.

    See more

    Declaration

    Objective-C

    @interface UARetailEventTemplate : NSObject

    Swift

    class UARetailEventTemplate : NSObject

  • Airship config needed for runtime. Generated from UAConfig during takeOff.

    See more

    Declaration

    Objective-C

    @interface UARuntimeConfig : NSObject

    Swift

    class UARuntimeConfig : NSObject

  • A UASearchEventTemplate represents a custom search event template for the application.

    See more

    Declaration

    Objective-C

    @interface UASearchEventTemplate : NSObject

    Swift

    class UASearchEventTemplate : NSObject

  • Shares text using UAActivityViewController.

    This action is registered under the names share_action and ^s.

    Expected argument value is an NSString.

    Valid situations: UASituationForegroundPush, UASituationLaunchedFromPush, UASituationWebViewInvocation, UASituationManualInvocation, UASituationForegroundInteractiveButton, and UASituationAutomation

    Default predicate: Rejects situation UASituationForegroundPush.

    Result value: nil

    Declaration

    Objective-C

    
@interface UAShareAction : UAAction

    Swift

    class UAShareAction : UAAction

  • iOS version-independent wrapper for UNTextInputNotificationAction.

    See more

    Declaration

    Objective-C

    @interface UATextInputNotificationAction : UANotificationAction

    Swift

    class UATextInputNotificationAction : UANotificationAction

  • Class for accepting and verifying webview URLs.

    URL allow list entries are written as URL patterns with optional wildcard matching:

     \<scheme\> := \<any char combination, '\*' are treated as wildcards\>

 \<host\> := '\*' | '\*.'\<any char combination except '/' and '\*'\> | \<any char combination except '/' and '\*'\>

 \<path\> := \<any char combination, '\*' are treated as wildcards\>

 \<pattern\> := '\*' | \<scheme\>://\<host\>\<path\> | \<scheme\>://\<host\> | \<scheme\>:/\<path\> | \<scheme\>:///\<path\>

    A single wildcard will match any URI. Wildcards in the scheme pattern will match any characters, and a single wildcard in the scheme will match any scheme. The wildcard in a host pattern “*.mydomain.com” will match anything within the mydomain.com domain. Wildcards in the path pattern will match any characters, including subdirectories.

    Note that NSURL does not support internationalized domains containing non-ASCII characters. All URL allow list entries for internationalized domains must be in ASCII IDNA format as specified in https://tools.ietf.org/html/rfc3490

    See more

    Declaration

    Objective-C

    @interface UAURLAllowList : NSObject

    Swift

    class UAURLAllowList : NSObject

  • The UAUtils object provides an interface for utility methods.

    See more

    Declaration

    Objective-C

    @interface UAUtils : NSObject

    Swift

    class UAUtils : NSObject

  • Version matcher.

    See more

    Declaration

    Objective-C

    @interface UAVersionMatcher : NSObject

    Swift

    class UAVersionMatcher : NSObject

  • Opens a wallet URL, either in safari or using custom URL schemes. This action is registered under the names ^w and wallet_action.

    Expected argument values: NSString

    Valid situations: UASituationForegroundPush, UASituationLaunchedFromPush UASituationWebViewInvocation, UASituationForegroundInteractiveButton, UASituationManualInvocation, and UASituationAutomation

    Result value: An NSString representation of the input

    Error: UAOpenExternalURLActionErrorCodeURLFailedToOpen if the URL could not be opened

    Fetch result: UAActionFetchResultNoData

    Declaration

    Objective-C

    
@interface UAWalletAction : UAOpenExternalURLAction

    Swift

    class UAWalletAction : UAOpenExternalURLAction

  • UAirship manages the shared state for all Airship services. [UAirship takeOff:] should be called from within your application delegate’s application:didFinishLaunchingWithOptions: method to initialize the shared instance.

    See more

    Declaration

    Objective-C

    @interface UAirship : NSObject

    Swift

    class UAirship : NSObject

  • Interface for accessing AirshipCore resources.

    See more

    Declaration

    Objective-C

    @interface UAirshipCoreResources : NSObject

    Swift

    class UAirshipCoreResources : NSObject

  • Airship Version.

    See more

    Declaration

    Objective-C

    @interface UAirshipVersion : NSObject

    Swift

    class UAirshipVersion : NSObject

  • Interface for accessing AirshipExtendedActions resources.

    See more

    Declaration

    Objective-C

    @interface UAExtendedActionsResources : NSObject

    Swift

    class UAExtendedActionsResources : NSObject

  • Links directly to app store review page or opens an app rating prompt.

    This action is registered under the names rate_app_action and ^ra.

    The rate app action requires your application to provide an itunes ID as an argument value, or have it set on the UARuntimeConfig instance used for takeoff. The itunes ID can be set on the UARuntimeConfig instance directly via UARuntimeConfig’s itunesID property, or by setting the itunesID as an NSString value in the AirshipConfig.plist under the key itunesID.

    Expected argument values: show_link_prompt:Required Boolean. If NO action will link directly to the iTunes app review page, if YES action will display a rating prompt. Defaults to NO if nil. link_prompt_title: Optional String. String to override the link prompt’s title. Title over 24 characters will be rejected. Header defaults to “Enjoying ?” if nil. link_prompt_body: Optional String. String to override the link prompt’s body. Bodies over 50 characters will be rejected. Body defaults to “Tap Rate App to rate it on the App Store.” if nil. itunes_id: Optional String. The iTunes ID for the application to be rated.

    Valid situations: UASituationForegroundPush, UASituationLaunchedFromPush, UASituationWebViewInvocation UASituationManualInvocation, UASituationForegroundInteractiveButton, and UASituationAutomation

    Result value: nil

    See more

    Declaration

    Objective-C

    @interface UARateAppAction : UAAction

    Swift

    class UARateAppAction : UAAction

  • Default implementation of a list-style Message Center UI.

    See more

    Declaration

    Objective-C

    @interface UADefaultMessageCenterListViewController
    : UIViewController <UITableViewDelegate, UITableViewDataSource,
                        UIScrollViewDelegate>

    Swift

    class UADefaultMessageCenterListViewController : UIViewController, UITableViewDelegate, UITableViewDataSource, UIScrollViewDelegate

  • Default implementation of a view controller for reading Message Center messages.

    See more

    Declaration

    Objective-C

    @interface UADefaultMessageCenterMessageViewController : UIViewController

    Swift

    class UADefaultMessageCenterMessageViewController : UIViewController

  • Default implementation of an adaptive message center controller.

    See more

    Declaration

    Objective-C

    @interface UADefaultMessageCenterSplitViewController
    : UISplitViewController <UAMessageCenterListViewDelegate,
                             UAMessageCenterMessageViewDelegate>

    Swift

    class UADefaultMessageCenterSplitViewController : UISplitViewController, UAMessageCenterListViewDelegate, UAMessageCenterMessageViewDelegate

  • Default implementation of UISplitViewControllerDelegate for use with UAMessageCenterSplitViewController.

    Declaration

    Objective-C

    @interface UADefaultMessageCenterSplitViewDelegate
    : NSObject <UISplitViewControllerDelegate>

    Swift

    class UADefaultMessageCenterSplitViewDelegate : NSObject, UISplitViewControllerDelegate

  • Default message center UI.

    See more

    Declaration

    Objective-C

    @interface UADefaultMessageCenterUI : NSObject <UAMessageCenterDisplayDelegate>

    Swift

    class UADefaultMessageCenterUI : NSObject, UAMessageCenterDisplayDelegate

  • This class represents a Rich Push Inbox message. It contains all the available information about a message, including the URLs where the message can be retrieved.

    See more

    Declaration

    Objective-C

    @interface UAInboxMessage : NSObject

    Swift

    class UAInboxMessage : NSObject

  • The primary interface to the contents of the inbox. Use this class to asychronously retrieve messges from the server, delete or mark messages as read, retrieve individual messages from the list.

    See more

    Declaration

    Objective-C

    @interface UAInboxMessageList : NSObject

    Swift

    class UAInboxMessageList : NSObject

  • Rich Push helper methods.

    See more

    Declaration

    Objective-C

    @interface UAInboxUtils : NSObject

    Swift

    class UAInboxUtils : NSObject

  • The UAMessageCenter class provides a default implementation of a message center, as well as a high-level interface for its configuration and display.

    See more

    Declaration

    Objective-C

    @interface UAMessageCenter : UAComponent

    Swift

    class UAMessageCenter : UAComponent

  • Requests the inbox be displayed.

    The action will call the UAMessageCenterDisplayDelegate displayMessageCenterForMessageID:animated: or displayMessageCenterAnimated: depending on whether the message ID is available or not.

    This action is registered under the name _uamid.

    Expected argument value is an inbox message ID as an NSString, or nil.

    Valid situations: UASituationLaunchedFromPush, UASituationWebViewInvocation, UASituationManualInvocation, UASituationForegroundInteractiveButton, and UASituationAutomation

    Result value: nil

    Declaration

    Objective-C

    @interface UAMessageCenterAction : UAAction

    Swift

    class UAMessageCenterAction : UAAction

  • Utility for getting relative date within the message center.

    See more

    Declaration

    Objective-C

    @interface UAMessageCenterDateUtils : NSObject

    Swift

    class UAMessageCenterDateUtils : NSObject

  • The UITableViewCell subclass used by the default message center.

    See more

    Declaration

    Objective-C

    @interface UAMessageCenterListCell : UITableViewCell

    Swift

    class UAMessageCenterListCell : UITableViewCell

  • Message Center module loader.

    Declaration

    Objective-C

    @interface UAMessageCenterModuleLoader
    : NSObject <UAModuleLoader, UAMessageCenterModuleLoaderFactory>

    Swift

    class UAMessageCenterModuleLoader : NSObject, UAModuleLoader, UAMessageCenterModuleLoaderFactory

  • Message Center native bridge extension.

    Declaration

    Objective-C

    @interface UAMessageCenterNativeBridgeExtension
    : NSObject <UANativeBridgeExtensionDelegate>

    Swift

    class UAMessageCenterNativeBridgeExtension : NSObject, UANativeBridgeExtensionDelegate

  • Interface for accessing AirshipMessageCenter resources.

    See more

    Declaration

    Objective-C

    @interface UAMessageCenterResources : NSObject

    Swift

    class UAMessageCenterResources : NSObject

  • Model object representing a custom style to be applied to the default message center.

    Note: the customizations exposed in this class are “a la carte”. Unless otherwise noted, unspecified properties will be overridden by the default message center at display time.

    See more

    Declaration

    Objective-C

    @interface UAMessageCenterStyle : NSObject

    Swift

    class UAMessageCenterStyle : NSObject

  • Primary interface for working with the application’s associated Airship user.

    See more

    Declaration

    Objective-C

    @interface UAUser : NSObject

    Swift

    class UAUser : NSObject

  • Model object for holding user data.

    See more

    Declaration

    Objective-C

    @interface UAUserData : NSObject

    Swift

    class UAUserData : NSObject