@ua/react-native-airship
    Preparing search index...

    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[];
    }
    Index

    Properties

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

    Properties

    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.

    autoPauseInAppAutomationOnLaunch?: boolean

    Pauses In-App Automation on launch.

    default?: ConfigEnvironment

    Default environment.

    development?: ConfigEnvironment

    Development environment. Overrides default environment if inProduction is false.

    enabledFeatures?: Feature[]

    Enabled features. Defaults to all.

    initialConfigUrl?: string

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

    inProduction?: boolean

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

    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.

    isChannelCaptureEnabled?: boolean

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

    isChannelCreationDelayEnabled?: boolean

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

    production?: ConfigEnvironment

    Production environment. Overrides default environment if inProduction is true.

    site?: Site

    Cloud site.

    suppressAllowListError?: boolean

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

    urlAllowList?: string[]

    URL allow list.

    urlAllowListScopeJavaScriptInterface?: string[]

    URL allow list for JS bridge injection.

    urlAllowListScopeOpenUrl?: string[]

    URL allow list for open URL scope.

    Settings

    Member Visibility

    On This Page

    Properties