Protocols

The following protocols are available globally.

  • An internal protocol that provides event add updates.

    See more

    Declaration

    Objective-C

    @protocol UAAnalyticsEventConsumerProtocol

    Swift

    protocol UAAnalyticsEventConsumerProtocol
  • A standard protocol for accessing native Objective-C functionality from webview content.

    UADefaultJSDelegate is a reference implementation of this protocol.

    See more

    Declaration

    Objective-C

    @protocol UAJavaScriptDelegate <NSObject>

    Swift

    protocol UAJavaScriptDelegate : NSObjectProtocol
  • Protocol for bridging location providers with the SDK.

    See more

    Declaration

    Objective-C

    @protocol UALocationProviderDelegate <NSObject>

    Swift

    protocol UALocationProviderDelegate : NSObjectProtocol
  • Implement this protocol and add as a [UAPush registrationDelegate] to receive registration success and failure callbacks.

    See more

    Declaration

    Objective-C

    @protocol UARegistrationDelegate <NSObject>

    Swift

    protocol UARegistrationDelegate : NSObjectProtocol
  • Protocol to be implemented by push notification clients. All methods are optional.

    See more

    Declaration

    Objective-C

    @protocol UAPushNotificationDelegate <NSObject>

    Swift

    protocol UAPushNotificationDelegate : NSObjectProtocol
  • Protocol for bridging push provider functionality with the SDK.

    See more

    Declaration

    Objective-C

    @protocol UAPushProviderDelegate <NSObject>

    Swift

    protocol UAPushProviderDelegate : NSObjectProtocol
  • Delegate protocol for accepting and rejecting white-listed URLs.

    See more

    Declaration

    Objective-C

    @protocol UAWhitelistDelegate <NSObject>

    Swift

    protocol UAWhitelistDelegate : NSObjectProtocol
  • Protocol to be implemented by deep link handlers.

    See more

    Declaration

    Objective-C

    @protocol UADeepLinkDelegate <NSObject>

    Swift

    protocol UADeepLinkDelegate : NSObjectProtocol
  • In-app message adapter protocol. An adapter is responsible for displaying a particular type of in-app message.

    See more

    Declaration

    Objective-C

    @protocol UAInAppMessageAdapterProtocol <NSObject>

    Swift

    protocol UAInAppMessageAdapterProtocol : NSObjectProtocol
  • Protocol for coordinating the display of in-app messages with the in-app message manager. Useful for putting time or count-based back pressure on message display, or for overriding the default coordination behavior for particular message types.

    See more

    Declaration

    Objective-C

    @protocol UAInAppMessageDisplayCoordinator <NSObject>

    Swift

    protocol UAInAppMessageDisplayCoordinator : NSObjectProtocol
  • Delegate protocol for receiving in-app messaging related callbacks.

    See more

    Declaration

    Objective-C

    @protocol UAInAppMessagingDelegate <NSObject>

    Swift

    protocol UAInAppMessagingDelegate : NSObjectProtocol
  • Delegate protocol for receiving in-app scene related callbacks.

    See more

    Declaration

    Objective-C

    @protocol UAInAppMessageSceneDelegate <NSObject>

    Swift

    protocol UAInAppMessageSceneDelegate : NSObjectProtocol
  • The in-app message style protocol.

    See more

    Declaration

    Objective-C

    @protocol UAInAppMessageStyleProtocol <NSObject>

    Swift

    protocol UAInAppMessageStyleProtocol : NSObjectProtocol
  • Delegate protocol for receiving callbacks related to Rich Push message delivery and display.

    See more

    Declaration

    Objective-C

    @protocol UAInboxDelegate <NSObject>

    Swift

    protocol UAInboxDelegate : NSObjectProtocol
  • A protocol for extending the default conversion between legacy landing pages and scheduled HTML message landing pages.

    See more

    Declaration

    Objective-C

    @protocol UALandingPageBuilderExtender <NSObject>

    Swift

    protocol UALandingPageBuilderExtender : NSObjectProtocol
  • A delegate protocol for bridging legacy in-app messages with the v2 infrastructure.

    See more

    Declaration

    Objective-C

    @protocol UALegacyInAppMessageFactoryDelegate <NSObject>

    Swift

    protocol UALegacyInAppMessageFactoryDelegate : NSObjectProtocol
  • A protocol for extending the default conversion between legacy in-app messages and v2 scheduled messages.

    See more

    Declaration

    Objective-C

    @protocol UALegacyInAppMessageBuilderExtender <NSObject>

    Swift

    protocol UALegacyInAppMessageBuilderExtender : NSObjectProtocol
  • Protocol to be implemented by internal message center message view controllers.

    See more

    Declaration

    Objective-C

    @protocol UAMessageCenterMessageViewProtocol

    Swift

    protocol UAMessageCenterMessageViewProtocol
  • WKNavigationDelegate protocol extension to handle uairship://close URL and UAirship.close()

    See more

    Declaration

    Objective-C

    @protocol UAWKWebViewDelegate <WKNavigationDelegate>

    Swift

    protocol UAWKWebViewDelegate : WKNavigationDelegate