StartCollaborationParams interface

Package:

@microsoft/document-collaboration-sdk

Defines the input type for the startCollaboration function.

Extends

JoinCollaborationParams

Inherited Properties

container	Required. The HTML element for the document to be viewed in.
documentInfo	Required. Information about the document. See definition of DocumentInfo for details.
eventHandlers	Optional. Callback for event handling.
fetchAccessToken	Required. Callback used to provide an access token for accessing the document.
meetingInfo	Required. Information about the collaboration meeting. See definition of MeetingInfo for details.
sessionInfo	Required. Information about the session. See definition of SessionInfo for details.
userInfo	Required. Information about a collaboration meeting attendee. See definition of UserInfo for details.

Inherited Property Details

container

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

container: HTMLElement

Property Value

HTMLElement

Inherited From JoinCollaborationParams.container

documentInfo

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

documentInfo: DocumentInfo

Property Value

DocumentInfo

Inherited From JoinCollaborationParams.documentInfo

eventHandlers

Optional. Callback for event handling.

eventHandlers?: UiHostEventHandlers

Property Value

UiHostEventHandlers

Inherited From JoinCollaborationParams.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 JoinCollaborationParams.fetchAccessToken

meetingInfo

Required. Information about the collaboration meeting. See definition of MeetingInfo for details.

meetingInfo: MeetingInfo

Property Value

MeetingInfo

Inherited From JoinCollaborationParams.meetingInfo

sessionInfo

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

sessionInfo: SessionInfo

Property Value

SessionInfo

Inherited From JoinCollaborationParams.sessionInfo

userInfo

Required. Information about a collaboration meeting attendee. See definition of UserInfo for details.

userInfo: UserInfo

Property Value

UserInfo

Inherited From JoinCollaborationParams.userInfo