Interface AirshipConfig

Airship config

interface AirshipConfig {
    android?: {
        appStoreUri?: string;
        fcmFirebaseAppName?: string;
        logPrivacyLevel?: "private" | "public";
        notificationConfig?: NotificationConfig;
    };
    autoPauseInAppAutomationOnLaunch?: boolean;
    default?: ConfigEnvironment;
    development?: ConfigEnvironment;
    enabledFeatures?: Feature[];
    initialConfigUrl?: string;
    inProduction?: boolean;
    ios?: {
        isWebViewInspectionEnabled?: boolean;
        itunesId?: string;
        useUserPreferredLocale?: boolean;
    };
    isChannelCaptureEnabled?: boolean;
    isChannelCreationDelayEnabled?: boolean;
    production?: ConfigEnvironment;
    site?: Site;
    suppressAllowListError?: boolean;
    urlAllowList?: string[];
    urlAllowListScopeJavaScriptInterface?: string[];
    urlAllowListScopeOpenUrl?: string[];
}

Properties

android? autoPauseInAppAutomationOnLaunch? default? development? enabledFeatures? initialConfigUrl? inProduction? ios? isChannelCaptureEnabled? isChannelCreationDelayEnabled? production? site? suppressAllowListError? urlAllowList? urlAllowListScopeJavaScriptInterface? urlAllowListScopeOpenUrl?

Properties

Optionalandroid

android?: {
    appStoreUri?: string;
    fcmFirebaseAppName?: string;
    logPrivacyLevel?: "private" | "public";
    notificationConfig?: NotificationConfig;
}

Android config.

Type declaration

  • OptionalappStoreUri?: string

    App store URI

  • OptionalfcmFirebaseAppName?: string

    Fcm app name if using multiple FCM projects.

  • OptionallogPrivacyLevel?: "private" | "public"

    Log privacy level. By default it logs at private, not logging anything lower than info to the console and redacting logs with string interpolation. public will log all configured log levels to the console without redacting any of the log lines.

  • OptionalnotificationConfig?: NotificationConfig

    Notification config.

OptionalautoPauseInAppAutomationOnLaunch

autoPauseInAppAutomationOnLaunch?: boolean

Pauses In-App Automation on launch.

Optionaldefault

default?: ConfigEnvironment

Default environment.

Optionaldevelopment

development?: ConfigEnvironment

Development environment. Overrides default environment if inProduction is false.

OptionalenabledFeatures

enabledFeatures?: Feature[]

Enabled features. Defaults to all.

OptionalinitialConfigUrl

initialConfigUrl?: string

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

OptionalinProduction

inProduction?: boolean

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

Optionalios

ios?: {
    isWebViewInspectionEnabled?: boolean;
    itunesId?: string;
    useUserPreferredLocale?: boolean;
}

iOS config.

Type declaration

  • OptionalisWebViewInspectionEnabled?: boolean

    Allows the WebViews to be inspected in Safari.

  • OptionalitunesId?: string

    itunesId for rate app and app store deep links.

  • OptionaluseUserPreferredLocale?: boolean

    If set to true, the SDK will use the preferred locale. Otherwise it will use the app's locale.

OptionalisChannelCaptureEnabled

isChannelCaptureEnabled?: boolean

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

OptionalisChannelCreationDelayEnabled

isChannelCreationDelayEnabled?: boolean

Enables delayed channel creation. Deprecated. Use the Private Manager to disable all features instead.

Optionalproduction

production?: ConfigEnvironment

Production environment. Overrides default environment if inProduction is true.

Optionalsite

site?: Site

Cloud site.

OptionalsuppressAllowListError

suppressAllowListError?: boolean

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

OptionalurlAllowList

urlAllowList?: string[]

URL allow list.

OptionalurlAllowListScopeJavaScriptInterface

urlAllowListScopeJavaScriptInterface?: string[]

URL allow list for JS bridge injection.

OptionalurlAllowListScopeOpenUrl

urlAllowListScopeOpenUrl?: string[]

URL allow list for open URL scope.

Settings

Member Visibility

On This Page

Properties