Skip to main content

IDocumentServiceEvents Interface

Events emitted by IDocumentService.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/driver-definitions/legacy.

For more information about our API support guarantees, see here.

Signature​

export interface IDocumentServiceEvents extends IEvent

Extends: IEvent

Call Signatures​

CallSignature Alerts Description
(event: "metadataUpdate", listener: (metadata: Record<string, string>) => void): any Alpha This event is used to communicate any metadata related to the container. We might have received metadata from the service. Read more info on this event from here IContainer.containerMetadata.

Call Signature Details​

(event: "metadataUpdate", listener: (metadata: Record<string, string>) => void): any​

This event is used to communicate any metadata related to the container. We might have received metadata from the service. Read more info on this event from here IContainer.containerMetadata.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature​

(event: "metadataUpdate", listener: (metadata: Record<string, string>) => void): any;