Classes

The following classes are available globally.

  • An actions schedule.

    See more

    Declaration

    Objective-C

    
@interface UAActionSchedule : UASchedule

    Swift

    class ActionSchedule : UASchedule

  • Interface for accessing AirshipAutomation resources.

    See more

    Declaration

    Objective-C

    
@interface UAAutomationResources : NSObject

    Swift

    class AutomationResources : 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 : NSObject <UAAction>

    Swift

    class CancelSchedulesAction : NSObject, Action

  • A deferred schedule.

    See more

    Declaration

    Objective-C

    
@interface UADeferredSchedule : UASchedule

    Swift

    class DeferredSchedule : UASchedule

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

    See more

    Declaration

    Objective-C

    
@interface UAInAppAutomation : NSObject <UAComponent>

    Swift

    class InAppAutomation : NSObject, Component

  • 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 InAppMessage : NSObject

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

    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageAssetManager : NSObject

    Swift

    class InAppMessageAssetManager : NSObject

  • Banner in-app message display adapter.

    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageBannerAdapter
    : NSObject <UAInAppMessageAdapterProtocol>

    Swift

    class InAppMessageBannerAdapter : NSObject, InAppMessageAdapterProtocol

  • Builder class for UAInAppMessageBannerDisplayContent.

    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageBannerDisplayContentBuilder : NSObject

    Swift

    class InAppMessageBannerDisplayContentBuilder : 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 InAppMessageBannerDisplayContent : InAppMessageDisplayContent

  • 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 InAppMessageBannerStyle : NSObject, InAppMessageStyleProtocol

  • Builder class for UAInAppMessageButtonInfo.

    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageButtonInfoBuilder : NSObject

    Swift

    class InAppMessageButtonInfoBuilder : NSObject

  • Defines an in-app message button.

    Note

    This object is built using UAInAppMessageButtonInfoBuilder.
    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageButtonInfo : NSObject

    Swift

    class InAppMessageButtonInfo : 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 InAppMessageButtonStyle : NSObject

  • Display content for a custom in-app message.

    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageCustomDisplayContent : UAInAppMessageDisplayContent

    Swift

    class InAppMessageCustomDisplayContent : InAppMessageDisplayContent

  • 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 InAppMessageDefaultDisplayCoordinator : NSObject, InAppMessageDisplayCoordinator

  • Display content for an in-app message.

    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageDisplayContent : NSObject

    Swift

    class InAppMessageDisplayContent : NSObject

  • Full screen in-app message display adapter.

    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageFullScreenAdapter
    : NSObject <UAInAppMessageAdapterProtocol>

    Swift

    class InAppMessageFullScreenAdapter : NSObject, InAppMessageAdapterProtocol

  • Builder class for UAInAppMessageFullScreenDisplayContent.

    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageFullScreenDisplayContentBuilder : NSObject

    Swift

    class InAppMessageFullScreenDisplayContentBuilder : 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 InAppMessageFullScreenDisplayContent : InAppMessageDisplayContent

  • 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 InAppMessageFullScreenStyle : NSObject, InAppMessageStyleProtocol

  • HTML in-app message display adapter.

    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageHTMLAdapter : NSObject <UAInAppMessageAdapterProtocol>

    Swift

    class InAppMessageHTMLAdapter : NSObject, InAppMessageAdapterProtocol

  • Builder class for UAInAppMessageHTMLDisplayContent.

    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageHTMLDisplayContentBuilder : NSObject

    Swift

    class InAppMessageHTMLDisplayContentBuilder : 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 InAppMessageHTMLDisplayContent : InAppMessageDisplayContent

  • 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 InAppMessageHTMLStyle : NSObject, InAppMessageStyleProtocol

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

    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageImmediateDisplayCoordinator
    : NSObject <UAInAppMessageDisplayCoordinator>

    Swift

    class InAppMessageImmediateDisplayCoordinator : NSObject, InAppMessageDisplayCoordinator

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

    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageManager : NSObject

    Swift

    class InAppMessageManager : NSObject

  • Defines in-app message media content.

    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageMediaInfo : NSObject

    Swift

    class InAppMessageMediaInfo : 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 InAppMessageMediaStyle : NSObject

  • Modal in-app message display adapter.

    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageModalAdapter : NSObject <UAInAppMessageAdapterProtocol>

    Swift

    class InAppMessageModalAdapter : NSObject, InAppMessageAdapterProtocol

  • Builder class for UAInAppMessageModalDisplayContent.

    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageModalDisplayContentBuilder : NSObject

    Swift

    class InAppMessageModalDisplayContentBuilder : 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 InAppMessageModalDisplayContent : InAppMessageDisplayContent

  • 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 InAppMessageModalStyle : NSObject, InAppMessageStyleProtocol

  • In-app message resolution info.

    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageResolution : NSObject

    Swift

    class InAppMessageResolution : NSObject

  • Scene manager for in-app messages.

    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageSceneManager : NSObject

    Swift

    class InAppMessageSceneManager : NSObject

  • An in-app message schedule.

    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageSchedule : UASchedule

    Swift

    class InAppMessageSchedule : UASchedule

  • Builder class for UAInAppMessageTextInfo.

    See more

    Declaration

    Objective-C

    
@interface UAInAppMessageTextInfoBuilder : NSObject

    Swift

    class InAppMessageTextInfoBuilder : 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 InAppMessageTextInfo : 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 InAppMessageTextStyle : 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 : NSObject <UAAction>

    Swift

    class LandingPageAction : NSObject, Action

  • Model object representing in-app message data.

    See more

    Declaration

    Objective-C

    
@interface UALegacyInAppMessage : NSObject

    Swift

    class LegacyInAppMessage : NSObject

  • Manager class for in-app messaging.

    See more

    Declaration

    Objective-C

    
@interface UALegacyInAppMessaging
    : NSObject <UAComponent, UALegacyInAppMessageFactoryDelegate>

    Swift

    class LegacyInAppMessaging : NSObject, Component, LegacyInAppMessageFactoryDelegate

  • Builder class for UASchedule.

    See more

    Declaration

    Objective-C

    
@interface UAScheduleBuilder : NSObject

    Swift

    class ScheduleBuilder : 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 : NSObject <UAAction>

    Swift

    class ScheduleAction : NSObject, Action

  • Builder class for UAScheduleAudience.

    See more

    Declaration

    Objective-C

    
@interface UAScheduleAudienceBuilder : NSObject

    Swift

    class ScheduleAudienceBuilder : 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 ScheduleAudience : NSObject

  • Deferred schedule data.

    See more

    Declaration

    Objective-C

    
@interface UAScheduleDeferredData : NSObject

    Swift

    class ScheduleDeferredData : NSObject

  • Builder class for UAScheduleDelay.

    See more

    Declaration

    Objective-C

    
@interface UAScheduleDelayBuilder : NSObject

    Swift

    class ScheduleDelayBuilder : 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 ScheduleDelay : NSObject

  • Builder class for UAScheduleEdits.

    See more

    Declaration

    Objective-C

    
@interface UAScheduleEditsBuilder : NSObject

    Swift

    class ScheduleEditsBuilder : NSObject

  • Schedule edits.

    See more

    Declaration

    Objective-C

    
@interface UAScheduleEdits : NSObject

    Swift

    class ScheduleEdits : 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 ScheduleTrigger : NSObject, NSSecureCoding

  • Model object for an audience tag selector.

    See more

    Declaration

    Objective-C

    
@interface UATagSelector : NSObject

    Swift

    class TagSelector : NSObject

  • Contains the arguments passed into an action during execution.

    See more

    Declaration

    Objective-C

    
@interface UAActionArguments : NSObject

    Swift

    class ActionArguments : NSObject

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

    See more

    Declaration

    Objective-C

    
@interface UAActionResult : NSObject

    Swift

    class ActionResult : NSObject

  • 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 Disposable : NSObject

  • Model object for holding data associated with JS delegate calls

    See more

    Declaration

    Objective-C

    
@interface UAJavaScriptCommand : NSObject

    Swift

    class JavaScriptCommand : NSObject

  • 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 Padding : NSObject