BootInfo interface

Package:

@microsoft/document-collaboration-sdk

Information returned by the Meeting and Document boot flows.

Properties

errorInfo	Optional. Error to be returned.
isBootSuccess	Required. Status of boot result.
joinInfo	Optional. For Meeting experiences, the start* APIs will return this joinInfo. This is a string which must be passed to the attendees for them to join the sharing session. This may contain sensitive user information, so this shouldn't be logged in telemetry or diagnostics.
powerPointMeetingActions	Optional. The PowerPoint Meeting experiences will return these callback actions.

Property Details

errorInfo

Optional. Error to be returned.

errorInfo?: ErrorInfo

Property Value

ErrorInfo

isBootSuccess

Required. Status of boot result.

isBootSuccess: boolean

Property Value

boolean

joinInfo

Optional. For Meeting experiences, the start* APIs will return this joinInfo. This is a string which must be passed to the attendees for them to join the sharing session. This may contain sensitive user information, so this shouldn't be logged in telemetry or diagnostics.

joinInfo?: string

Property Value

string

powerPointMeetingActions

Optional. The PowerPoint Meeting experiences will return these callback actions.

powerPointMeetingActions?: { setPrivateViewing: (isEnabled: { isEnabled: boolean }) => void, subscribeToAnnotationChangedEvent?: (callback: (data: AnnotationData) => void) => () => void, subscribeToMediaChangedEvent?: (callback: (data: MediaEventData) => void) => () => void, subscribeToOpticalZoomChangedEvent?: (callback: (data: OpticalZoomData) => void) => () => void, subscribeToSlideChanges?: (callback: (data: SlideChangeData) => void) => () => void, switchRole: (role: { role: "attendee" | "presenter" }) => void, annotationEventAction?(annotationData: AnnotationData) => void, mediaEventAction?(mediaData: MediaEventData) => void, navigateToSlide?(slideData: SlideChangeData) => void, opticalZoomEventAction?(opticalZoomData: OpticalZoomData) => void }

Property Value

{ setPrivateViewing: (isEnabled: { isEnabled: boolean }) => void, subscribeToAnnotationChangedEvent?: (callback: (data: AnnotationData) => void) => () => void, subscribeToMediaChangedEvent?: (callback: (data: MediaEventData) => void) => () => void, subscribeToOpticalZoomChangedEvent?: (callback: (data: OpticalZoomData) => void) => () => void, subscribeToSlideChanges?: (callback: (data: SlideChangeData) => void) => () => void, switchRole: (role: { role: "attendee" | "presenter" }) => void, annotationEventAction?(annotationData: AnnotationData) => void, mediaEventAction?(mediaData: MediaEventData) => void, navigateToSlide?(slideData: SlideChangeData) => void, opticalZoomEventAction?(opticalZoomData: OpticalZoomData) => void }