Interface NavigatorContext

The NavigatorContext interface represents the context of the browser client.

interface NavigatorContext {
    capture?: boolean;
    clientId: string;
    location: null | string;
    referrer: null | string;
    userAgent: null | string;
}

Properties

capture? clientId location referrer userAgent

Properties

Optionalcapture

capture?: boolean

Whether to capture analytics events.

Must be left undefined or set to false if the clientId is an empty string, otherwise requests will fail.

clientId

clientId: string

The unique identifier of the browser client in a Coveo-powered page. See clientId.

location

location: null | string

The URL of the current page.

referrer

referrer: null | string

The URL of the page that referred the user to the current page. See Referer

userAgent

userAgent: null | string

The user agent string of the browser that made the request. See User-Agent

Settings

Member Visibility

On This Page

Properties