Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AirshipConfig

Airship config

Hierarchy

  • AirshipConfig

Index

Properties

Optional android

android: undefined | { appStoreUri?: undefined | string; fcmFirebaseAppName?: undefined | string; notificationConfig?: NotificationConfigAndroid }

Android config.

Optional chat

chat: undefined | { url: string; webSocketUrl: string }

Chat config. Only needed with the chat module.

Optional default

Default environment.

Optional development

development: ConfigEnvironment

Development environment. Overrides default environment if inProduction is false.

Optional enabledFeatures

enabledFeatures: Feature[]

Enabled features. Defaults to all.

Optional inProduction

inProduction: undefined | false | true

Switches the environment from development or production. If the value is not set, Airship will determine the value at runtime.

Optional initialConfigUrl

initialConfigUrl: String

Initial config URL for custom Airship domains. The URL should also be added to the urlAllowList.

Optional ios

ios: undefined | { itunesId?: undefined | string }

iOS config.

Optional isChannelCaptureEnabled

isChannelCaptureEnabled: undefined | false | true

Enables channel capture feature. This config is enabled by default.

Optional isChannelCreationDelayEnabled

isChannelCreationDelayEnabled: undefined | false | true

Enables delayed channel creation.

Optional production

production: ConfigEnvironment

Production environment. Overrides default environment if inProduction is true.

Optional requireInitialRemoteConfigEnabled

requireInitialRemoteConfigEnabled: undefined | false | true

Enables/disables requiring initial remote config fetch before creating a channel.

deprecated

This config is enabled by default.

Optional site

site: Site

Cloud site.

Optional suppressAllowListError

suppressAllowListError: undefined | false | true

Whether to suppress console error messages about missing allow list entries during takeOff. This config is disabled by default.

Optional urlAllowList

urlAllowList: string[]

URL allow list.

Optional urlAllowListScopeJavaScriptInterface

urlAllowListScopeJavaScriptInterface: string[]

URL allow list for JS bridge injection.

Optional urlAllowListScopeOpenUrl

urlAllowListScopeOpenUrl: string[]

URL allow list for open URL scope.

Generated using TypeDoc