UARuntimeConfig

Objective-C

@interface UARuntimeConfig : NSObject

Swift

class UARuntimeConfig : NSObject

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

Configuration Options

  • If enabled, the Airship library automatically registers for remote notifications when push is enabled and intercepts incoming notifications in both the foreground and upon launch.

    Defaults to YES. If this is disabled, you will need to register for remote notifications in application:didFinishLaunchingWithOptions: and forward all notification-related app delegate calls to UAPush and UAInbox.

    Declaration

    Objective-C

    @property (readonly, getter=isAutomaticSetupEnabled) BOOL automaticSetupEnabled;

    Swift

    var isAutomaticSetupEnabled: Bool { get }
  • An array of UAURLAllowList entry strings. This url allow list is used for validating which URLs can be opened or load the JavaScript native bridge. It affects landing pages, the open external URL and wallet actions, deep link actions (if a delegate is not set), and HTML in-app messages.

    Note

    See UAURLAllowList for pattern entry syntax.

    Declaration

    Objective-C

    @property (readonly) NSArray<NSString *> *_Nonnull URLAllowList;

    Swift

    var urlAllowList: [String] { get }
  • An array of UAURLAllowList entry strings. This url allow list is used for validating which URLs can load the JavaScript native bridge. It affects Landing Pages, Message Center and HTML In-App Messages.

    Note

    See UAURLAllowList for pattern entry syntax.

    Declaration

    Objective-C

    @property (readonly) NSArray<NSString *> *_Nonnull URLAllowListScopeJavaScriptInterface;

    Swift

    var urlAllowListScopeJavaScriptInterface: [String] { get }
  • An array of UAURLAllowList entry strings. This url allow list is used for validating which URLs can be opened. It affects landing pages, the open external URL and wallet actions, deep link actions (if a delegate is not set), and HTML in-app messages.

    Note

    See UAURLAllowList for pattern entry syntax.

    Declaration

    Objective-C

    @property (readonly) NSArray<NSString *> *_Nonnull URLAllowListScopeOpenURL;

    Swift

    var urlAllowListScopeOpenURL: [String] { get }
  • Whether to suppress console error messages about missing allow list entries during takeOff.

    Defaults to NO.

    Declaration

    Objective-C

    @property (readonly) BOOL suppressAllowListError;

    Swift

    var suppressAllowListError: Bool { get }

Advanced Configuration Options

  • Toggles Airship analytics. Defaults to YES. If set to NO, many Airship features will not be available to this application.

    Declaration

    Objective-C

    @property (readonly, getter=isAnalyticsEnabled) BOOL analyticsEnabled;

    Swift

    var isAnalyticsEnabled: Bool { get }
  • The Airship default message center style configuration file.

    Declaration

    Objective-C

    @property (readonly) NSString *_Nonnull messageCenterStyleConfig;

    Swift

    var messageCenterStyleConfig: String { get }
  • The iTunes ID used for Rate App Actions.

    Declaration

    Objective-C

    @property (readonly) NSString *_Nonnull itunesID;

    Swift

    var itunesID: String { get }
  • If set to YES, the Airship user will be cleared if the application is restored on a different device from an encrypted backup.

    Defaults to NO.

    Declaration

    Objective-C

    @property (readonly) BOOL clearUserOnAppRestore;

    Swift

    var clearUserOnAppRestore: Bool { get }
  • If set to YES, the application will clear the previous named user ID on a re-install. Defaults to NO.

    Declaration

    Objective-C

    @property (readonly) BOOL clearNamedUserOnAppRestore;

    Swift

    var clearNamedUserOnAppRestore: Bool { get }
  • Flag indicating whether channel capture feature is enabled or not.

    Defaults to NO.

    Declaration

    Objective-C

    @property (readonly, getter=isChannelCaptureEnabled) BOOL channelCaptureEnabled;

    Swift

    var isChannelCaptureEnabled: Bool { get }
  • Flag indicating whether delayed channel creation is enabled. If set to YES channel creation will not occur until channel creation is manually enabled.

    Defaults to NO.

    Declaration

    Objective-C

    @property (readonly, getter=isChannelCreationDelayEnabled) BOOL channelCreationDelayEnabled;

    Swift

    var isChannelCreationDelayEnabled: Bool { get }
  • Flag indicating whether extended broadcasts are enabled. If set to YES the AirshipReady NSNotification will contain additional data: the channel identifier and the app key.

    Defaults to NO.

    Declaration

    Objective-C

    @property (readonly, getter=isExtendedBroadcastsEnabled) BOOL extendedBroadcastsEnabled;

    Swift

    var isExtendedBroadcastsEnabled: Bool { get }
  • If set to ‘YES’, the Airship SDK will request authorization to use notifications from the user. Apps that set this flag to NO are required to request authorization themselves.

    Defaults to YES.

    Declaration

    Objective-C

    @property (readonly) BOOL requestAuthorizationToUseNotifications;

    Swift

    var requestAuthorizationToUseNotifications: Bool { get }
  • If set to YES, the SDK will wait for an initial remote config instead of falling back on default API URLs.

    Defaults to NO.

    Declaration

    Objective-C

    @property (readonly) BOOL requireInitialRemoteConfigEnabled;

    Swift

    var requireInitialRemoteConfigEnabled: Bool { get }
  • Flag indicating whether data collection needs to be opted in with UAirship.dataCollectionEnabled. This flag will only take affect on first run. If previously not enabled, the device will still have data collection enabled until disabled with UAirship.dataCollectionEnabled.

    Declaration

    Objective-C

    @property (readonly, getter=isDataCollectionOptInEnabled) BOOL dataCollectionOptInEnabled;

    Swift

    var isDataCollectionOptInEnabled: Bool { get }

Resolved Options

  • The current app key (resolved using the inProduction flag).

    Declaration

    Objective-C

    @property (readonly, nonnull) NSString *appKey;

    Swift

    var appKey: String { get }
  • The current app secret (resolved using the inProduction flag).

    Declaration

    Objective-C

    @property (readonly, nonnull) NSString *appSecret;

    Swift

    var appSecret: String { get }
  • The current log level for the library’s UA_L macros (resolved using the inProduction flag).

    Declaration

    Objective-C

    @property (readonly) UALogLevel logLevel;

    Swift

    var logLevel: UALogLevel { get }
  • The production status of this application. This may be set directly, or it may be determined automatically if the detectProvisioningMode flag is set to YES.

    Declaration

    Objective-C

    @property (readonly, getter=isInProduction) BOOL inProduction;

    Swift

    var isInProduction: Bool { get }
  • Dictionary of custom config values.

    Declaration

    Objective-C

    @property (readonly) NSDictionary *_Nonnull customConfig;

    Swift

    var customConfig: [AnyHashable : Any] { get }