CML
    Preparing search index...

    Type Alias CmcdEventReportConfig

    CmcdEventReportConfig: CmcdReportConfig & {
        batchSize?: number;
        events?: CmcdEventType[];
        interval?: number;
        url: string;
        version?: typeof CMCD_V2;
    }

    Configuration for a CMCD event report.

    Type Declaration

    • OptionalbatchSize?: number

      The number of events to batch before sending the report.

      1

    • Optionalevents?: CmcdEventType[]

      The events to report. If no events are provided, the event target will be effectively disabled.

      undefined

    • Optionalinterval?: number

      When the time interval event is sent, the interval at which the events should be reported as a number of seconds.

      CMCD_DEFAULT_TIME_INTERVAL

    • url: string

      The URL to which the CMCD event should be sent.

    • Optionalversion?: typeof CMCD_V2

      The version of the CMCD protocol to use. Must be version 2 or higher for event reporting.

      CMCD_V2