THEOplayer React Native Connectors
    Preparing search index...

    Interface AdobeEdgeWebConfig

    interface AdobeEdgeWebConfig {
        autoCollectPropositionInteractions?: {
            AJO?: AutoCollect;
            TGT?: AutoCollect;
        };
        clickCollection?: {
            downloadLinkEnabled?: boolean;
            eventGroupingEnabled?: boolean;
            externalLinkEnabled?: boolean;
            filterClickDetails?: (content: object) => void;
            internalLinkEnabled?: boolean;
            sessionStorageEnabled?: boolean;
        };
        clickCollectionEnabled?: boolean;
        context?: Context[];
        datastreamId: string;
        debugEnabled?: boolean;
        defaultConsent?: Consent;
        downloadLinkQualifier?: string;
        edgeBasePath: string;
        edgeConfigOverrides?: object;
        edgeDomain?: string;
        idMigrationEnabled?: boolean;
        onBeforeEventSend?: (content: object) => void;
        orgId: string;
        prehidingStyle?: string;
        pushNotifications?: {
            applicationId: string;
            trackingDatasetId: string;
            vapidPublicKey: string;
        };
        streamingMedia?: {
            adPingInterval?: number;
            appVersion?: string;
            channel?: string;
            mainPingInterval?: number;
            playerName?: string;
        };
        targetMigrationEnabled?: boolean;
        thirdPartyCookiesEnabled?: boolean;
    }
    Index

    Properties

    autoCollectPropositionInteractions? clickCollection? clickCollectionEnabled? context? datastreamId debugEnabled? defaultConsent? downloadLinkQualifier? edgeBasePath edgeConfigOverrides? edgeDomain? idMigrationEnabled? onBeforeEventSend? orgId prehidingStyle? pushNotifications? streamingMedia? targetMigrationEnabled? thirdPartyCookiesEnabled?

    Properties

    autoCollectPropositionInteractions?: { AJO?: AutoCollect; TGT?: AutoCollect }

    The autoCollectPropositionInteractions property is an optional setting that determines if the SDK automatically collects proposition interactions. https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/configure/autocollectpropositioninteractions

    Type Declaration

    clickCollection?: {
        downloadLinkEnabled?: boolean;
        eventGroupingEnabled?: boolean;
        externalLinkEnabled?: boolean;
        filterClickDetails?: (content: object) => void;
        internalLinkEnabled?: boolean;
        sessionStorageEnabled?: boolean;
    }

    The clickCollection object contains several variables that help you control automatically collected link data. https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/configure/clickcollection

    Type Declaration

    • OptionaldownloadLinkEnabled?: boolean

      Determines if the library tracks links that qualify as downloads based on the downloadLinkQualifier property.

    • OptionaleventGroupingEnabled?: boolean

      Determines if the library waits until the next “page view” event to send link tracking data.

    • OptionalexternalLinkEnabled?: boolean

      Determines if links to external domains are automatically tracked.

    • OptionalfilterClickDetails?: (content: object) => void

      A callback function that provides full controls over link tracking data that you collect.

    • OptionalinternalLinkEnabled?: boolean

      Determines if links within the current domain are automatically tracked.

    • OptionalsessionStorageEnabled?: boolean

      Determines if link tracking data is stored in session storage instead of local variables.

    clickCollectionEnabled?: boolean

    The clickCollectionEnabled property is a boolean that determines if the SDK automatically collects link data. https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/configure/clickcollectionenabled

    true.

    context?: Context[]

    The context property is an array of strings that determines what the SDK can automatically collect.

    datastreamId: string

    The datastreamId property is a string that determines which datastream in Adobe Experience Platform you want to send data to. https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/configure/datastreamid

    debugEnabled?: boolean

    The debugEnabled property allows you to enable or disable debugging using SDK code. https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/configure/debugenabled

    false.

    defaultConsent?: Consent

    The defaultConsent property determines how you handle data collection consent before you call the setConsent command. https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/configure/defaultconsent

    in.

    downloadLinkQualifier?: string

    If you enable automatic link tracking using clickCollectionEnabled, the downloadLinkQualifier property helps determine the criteria for a URL to be considered a download link. https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/configure/downloadlinkqualifier

    '\.(exe|zip|wav|mp3|mov|mpg|avi|wmv|pdf|doc|docx|xls|xlsx|ppt|pptx)$'.

    edgeBasePath: string

    The edgeBasePath property alters the destination path when you interact with Adobe services. https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/configure/edgebasepath

    edgeConfigOverrides?: object

    The edgeConfigOverrides object allows you to override configuration settings for commands run on the current page. https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/configure/edgeconfigoverrides

    edgeDomain?: string

    The edgeDomain property allows you to change the domain where the SDK sends data. https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/configure/edgedomain

    'edge.adobedc.net'.

    idMigrationEnabled?: boolean

    The idMigrationEnabled property allows the SDK to read AMCV cookies set by previous Adobe Experience Cloud implementations. https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/configure/idmigrationenabled

    true.

    onBeforeEventSend?: (content: object) => void

    The onBeforeEventSend callback allows you to register a JavaScript function that can alter the data you send just before that data is sent to Adobe. https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/configure/onbeforeeventsend

    orgId: string

    The orgId property is a string that tells Adobe which organization that data is sent to. This property is required for all data sent using the SDK. https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/configure/orgid

    prehidingStyle?: string

    The prehidingStyle property allows you to define a CSS selector to hide personalized content until it loads. https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/configure/prehidingstyle

    pushNotifications?: {
        applicationId: string;
        trackingDatasetId: string;
        vapidPublicKey: string;
    }

    The pushNotifications property lets you configure push notifications for web applications. https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/configure/pushnotifications

    Type Declaration

    • applicationId: string

      The application ID associated with the VAPID public key.

    • trackingDatasetId: string

      The system dataset ID used for push notification tracking.

    • vapidPublicKey: string

      The VAPID public key used for push subscriptions. Must be a Base64-encoded string.

    streamingMedia?: {
        adPingInterval?: number;
        appVersion?: string;
        channel?: string;
        mainPingInterval?: number;
        playerName?: string;
    }

    The streamingMedia component helps you collect data related to media sessions on your website. https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/configure/streamingmedia

    Type Declaration

    • OptionaladPingInterval?: number

      Frequency of pings for ad content, in seconds.

      10.

    • OptionalappVersion?: string

      The version of the media player application.

    • Optionalchannel?: string

      The name of the channel where streaming media collection occurs.

    • OptionalmainPingInterval?: number

      Frequency of pings for main content, in seconds.

      10.

    • OptionalplayerName?: string

      The name of the media player.

    targetMigrationEnabled?: boolean

    The targetMigrationEnabled property is a boolean that allows the SDK to read and write the mbox and mboxEdgeCluster cookies that the Adobe Target 1.x and 2.x libraries use. https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/configure/targetmigrationenabled

    false.

    thirdPartyCookiesEnabled?: boolean

    The thirdPartyCookiesEnabled property is a boolean that determines if the SDK sets cookies in a third-party context. https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/configure/thirdpartycookiesenabled

    true.

    Settings

    Member Visibility

    On This Page

    Properties