BootDocumentParams interface

Package:

@microsoft/document-collaboration-sdk

Defines the input type for the launch function.

Extends

BaseBootParams

Properties

documentInfo

Required. Information about the document. See definition of DocumentInfo for details.

Inherited Properties

container	Required. The HTML element for the document to be viewed in.
eventHandlers	Optional. Callback for event handling.
fetchAccessToken	Required. Callback used to provide an access token for accessing the document.
sessionInfo	Required. Information about the session. See definition of SessionInfo for details.

Property Details

documentInfo

Required. Information about the document. See definition of DocumentInfo for details.

documentInfo: DocumentInfo

Property Value

DocumentInfo

Inherited Property Details

container

Required. The HTML element for the document to be viewed in.

container: HTMLElement

Property Value

HTMLElement

Inherited From BaseBootParams.container

eventHandlers

Optional. Callback for event handling.

eventHandlers?: UiHostEventHandlers

Property Value

UiHostEventHandlers

Inherited From BaseBootParams.eventHandlers

fetchAccessToken

Required. Callback used to provide an access token for accessing the document.

fetchAccessToken: (resourceUrl: string, claim?: string[]) => Promise<string>

Property Value

(resourceUrl: string, claim?: string[]) => Promise<string>

Inherited From BaseBootParams.fetchAccessToken

sessionInfo

Required. Information about the session. See definition of SessionInfo for details.

sessionInfo: SessionInfo

Property Value

SessionInfo

Inherited From BaseBootParams.sessionInfo