1. @sitecore-cloudsdk/search/browser

BrowserData

Version:

Type

Interface

Import path

@sitecore-cloudsdk/search/browser

Data about the site visitor's web browser.

Signature

export interface BrowserData {
  userAgent: string;
  appType?: string;
  device?: string;
}

Properties

Name

Type

Description

Value

userAgent

string

Required.

The user agent of the site visitor's navigator.

Set the value to a string that follows the industry standards for describing user agents.

Sitecore Search uses this value to infer appType and device.

"Mozilla/5.0 (Android; Tablet; rv:40.0) Gecko/40.0 Firefox/40.0"

appType

string

Optional.

The application type the site visitor uses to interact with your app.

Sitecore Search infers this value automatically from userAgent.

To override the inferred value, specify the value manually.

Must be one of:

  • "browser"

  • "webview"

  • "native"

device

string

Optional.

The site visitor's device.

Sitecore Search infers this value automatically from userAgent.

To override the inferred value, specify the value manually.

Must be one of:

  • "mobile"

  • "pc"

  • "tablet"

If you have suggestions for improving this article, let us know!