DocumentInfo interface

Package:

@microsoft/document-collaboration-sdk

Information about the document.

Properties

action	Optional. See definition of the Action enum for available actions. Default option is used if no action is provided.
clickTime	Optional. Timestamp of when the user clicks a document. This will be used to measure end-to-end user experience time. Example: new Date().getTime()
dataCulture
documentIdentifier	Optional. Information to uniquely identify the document.
documentType	Required. Type of document to be opened.
sessionOrigin	Optional. The platform (desktop, web, mobile, iOS, etc.) the session is originating from.
shareUrl	Optional. Share link provided by the UI host to open the document.
uiCulture

Property Details

action

Optional. See definition of the Action enum for available actions. Default option is used if no action is provided.

action?: Action

Property Value

Action

clickTime

Optional. Timestamp of when the user clicks a document. This will be used to measure end-to-end user experience time. Example: new Date().getTime()

clickTime?: number

Property Value

number

dataCulture

Warning

This API is now deprecated.

Use the SessionInfo.localeInfo.dataCulture property instead. Optional. Document content locale preferred for this session.

dataCulture?: string

Property Value

string

documentIdentifier

Optional. Information to uniquely identify the document.

documentIdentifier?: DocumentIdentifier

Property Value

DocumentIdentifier

documentType

Required. Type of document to be opened.

documentType: DocumentType

Property Value

DocumentType

sessionOrigin

Optional. The platform (desktop, web, mobile, iOS, etc.) the session is originating from.

sessionOrigin?: string

Property Value

string

shareUrl

Optional. Share link provided by the UI host to open the document.

shareUrl?: string

Property Value

string

uiCulture

Warning

This API is now deprecated.

Use the SessionInfo.localeInfo.uiCulture property instead. Optional. UI locale of the current application.

uiCulture?: string

Property Value

string