Interface MKConvivaAnalyticsCollectorConfig

Conviva Analytics Collector Config.

interface MKConvivaAnalyticsCollectorConfig {
    appName?: string;
    appVersion?: string;
    deviceMetadata?: {
        brand?: string;
        manufacturer?: string;
        model?: string;
        osName?: string;
        osVersion?: string;
        version?: string;
    };
    devMode?: boolean;
    key: string;
    viewerId?: string;
}

Properties

appName? appVersion? deviceMetadata? devMode? key viewerId?

Properties

OptionalappName

appName?: string

Your application name.

OptionalappVersion

appVersion?: string

Your application version.

OptionaldeviceMetadata

deviceMetadata?: {
    brand?: string;
    manufacturer?: string;
    model?: string;
    osName?: string;
    osVersion?: string;
    version?: string;
}

Option to override the Conviva Device Metadata.

(Default: Auto extract all options from User Agent string)

Type declaration

  • Optionalbrand?: string

    Option to override the Conviva Device Brand.

    (Default: Auto extract from User Agent string)

  • Optionalmanufacturer?: string

    Option to override the Conviva Device Manufacturer.

    (Default: Auto extract from User Agent string)

  • Optionalmodel?: string

    Option to override the Conviva Device Model.

    (Default: Auto extract from User Agent string)

  • OptionalosName?: string

    Option to override the Conviva Operating System Name

    (Default: Auto extract from User Agent string)

  • OptionalosVersion?: string

    Option to override the Conviva Operating System Version

    (Default: Auto extract from User Agent string)

  • Optionalversion?: string

    Option to override the Conviva Device Version.

    (Default: Auto extract from User Agent string)

OptionaldevMode

devMode?: boolean

Switch between development/debug and production mode.

Default is false, meaning production mode enabled unless this is set to true.

key

key: string

A unique key identifying a specific Conviva customer account.

Different keys shall be used for development/debug vs production environment.

Find your keys on the Conviva account page in Pulse: https://pulse.conviva.com/settings/account_summary

OptionalviewerId

viewerId?: string

Customer's unique identifier or viewer ID.

Could be an email or UUID which you can use to identify a given customer/user account.

Settings

Member Visibility

On This Page

Properties