Batch SDK - Web
    Preparing search index...

    Interface ISDKConfiguration

    interface ISDKConfiguration {
        apiKey: string;
        authKey: string;
        defaultDataCollection?: ISDKDefaultDataCollectionConfiguration;
        enableHashFeatures?: boolean;
        migrations?: ISDKMigrationsConfiguration;
        push?: false | ISDKPushModuleConfiguration | null;
    }
    Index
    apiKey authKey defaultDataCollection? enableHashFeatures? migrations? push?
    apiKey: string
    authKey: string
    defaultDataCollection?: ISDKDefaultDataCollectionConfiguration

    Default data collection related configuration

    enableHashFeatures?: boolean

    Enable features triggered using a hash in the URL (default: false).

    migrations?: ISDKMigrationsConfiguration

    Migrations related configuration

    push?: false | ISDKPushModuleConfiguration | null

    Push subscription and service worker module. Each module carries its own configuration object at the root of the config.

    Pass a configuration object to enable it (all fields optional), or false / null to disable it. Omitting the key keeps push enabled with its defaults, so existing integrations are unaffected. Disabling it skips its prerequisites (for example a Data-Collect-only integration can set push: false and run without a vapidPublicKey).

    Settings
    Member Visibility

    On This Page
    Properties