UARuntimeConfig

@interface UARuntimeConfig : NSObject

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

  • 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, atomic)
        BOOL automaticSetupEnabled;

    Swift

    var isAutomaticSetupEnabled: Bool { get }
  • An array of UAWhitelist entry strings. The whitelist used for validating URLs for landing pages, wallet action, open external URL action, deep link action (if delegate is not set), and HTML in-app messages.

    Note

    See UAWhitelist for pattern entry syntax.

    Declaration

    Objective-C

    @property (readonly, atomic) NSArray<NSString *> *_Nonnull whitelist;

    Swift

    var whitelist: [String] { get }
  • 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, atomic) BOOL analyticsEnabled;

    Swift

    var isAnalyticsEnabled: Bool { get }
  • The Airship device API url. This option is reserved for internal debugging.

    Declaration

    Objective-C

    @property (readonly, atomic) NSString *_Nonnull deviceAPIURL;

    Swift

    var deviceAPIURL: String { get }
  • The Airship analytics API url. This option is reserved for internal debugging.

    Declaration

    Objective-C

    @property (readonly, atomic) NSString *_Nonnull analyticsURL;

    Swift

    var analyticsURL: String { get }
  • The Airship remote data url. This option is reserved for internal debugging.

    Declaration

    Objective-C

    @property (readonly, atomic) NSString *_Nonnull remoteDataAPIURL;

    Swift

    var remoteDataAPIURL: String { get }
  • The Airship default message center style configuration file.

    Declaration

    Objective-C

    @property (readonly, atomic) NSString *_Nonnull messageCenterStyleConfig;

    Swift

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

    Declaration

    Objective-C

    @property (readonly, atomic) 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, atomic) 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, atomic) BOOL clearNamedUserOnAppRestore;

    Swift

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

    Defaults to YES.

    Declaration

    Objective-C

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

    Swift

    var isChannelCaptureEnabled: Bool { get }
  • Enables or disables whitelist checks at the scope UAWhitelistScopeOpenURL. If disabled, all whitelist checks for this scope will be allowed.

    Defaults to NO.

    Declaration

    Objective-C

    @property (readonly, getter=isOpenURLWhitelistingEnabled, atomic)
        BOOL openURLWhitelistingEnabled;

    Swift

    var isOpenURLWhitelistingEnabled: 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, atomic)
        BOOL channelCreationDelayEnabled;

    Swift

    var isChannelCreationDelayEnabled: 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, atomic) BOOL requestAuthorizationToUseNotifications;

    Swift

    var requestAuthorizationToUseNotifications: Bool { get }
  • The current app key (resolved using the inProduction flag).

    Declaration

    Objective-C

    @property (readonly, atomic, nonnull) NSString *appKey;

    Swift

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

    Declaration

    Objective-C

    @property (readonly, atomic, 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, atomic) 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, atomic) BOOL inProduction;

    Swift

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

    Declaration

    Objective-C

    @property (readonly, atomic) NSDictionary *_Nonnull customConfig;

    Swift

    var customConfig: [AnyHashable : Any] { get }