SessionInfo interface

Package:

@microsoft/document-collaboration-sdk

Information about the session.

Properties

highContrastMode	Optional. High contrast mode preferred for this session. Supported values for this field are: undefined invert
hostCorrelationId	Required. Unique ID for this session. This will be logged to Microsoft diagnostics, so it must not contain any user personal data. This field should be provided for live site investigation. Supported characters are alphanumeric and hyphen.
isSynthetic	Optional. Indicates if the session is a test session.
localeInfo	Optional. Locale information of the session. See definition of LocaleInfo for details.

Property Details

highContrastMode

Optional. High contrast mode preferred for this session.

Supported values for this field are:

• undefined

• invert

highContrastMode?: string

Property Value

string

hostCorrelationId

Required. Unique ID for this session. This will be logged to Microsoft diagnostics, so it must not contain any user personal data. This field should be provided for live site investigation. Supported characters are alphanumeric and hyphen.

hostCorrelationId: string

Property Value

string

isSynthetic

Optional. Indicates if the session is a test session.

isSynthetic?: boolean

Property Value

boolean

localeInfo

Optional. Locale information of the session. See definition of LocaleInfo for details.

localeInfo?: LocaleInfo

Property Value

LocaleInfo