Skip to main content

ISharedObjectEvents Interface

Events emitted by ISharedObject.

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

To use, import via @fluidframework/shared-object-base/legacy.

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

Signature​

export interface ISharedObjectEvents extends IErrorEvent

Extends: IErrorEvent

Call Signatures​

CallSignature Alerts Description
(event: "pre-op", listener: (op: ISequencedDocumentMessage, local: boolean, target: IEventThisPlaceHolder) => void): any Alpha Fires before an incoming operation (op) is applied to the shared object.
(event: "op", listener: (op: ISequencedDocumentMessage, local: boolean, target: IEventThisPlaceHolder) => void): any Alpha Fires after an incoming op is applied to the shared object.

Call Signature Details​

(event: "pre-op", listener: (op: ISequencedDocumentMessage, local: boolean, target: IEventThisPlaceHolder) => void): any​

Fires before an incoming operation (op) is applied to the shared object.

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

To use, import via @fluidframework/shared-object-base/alpha.

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

Signature​

(event: "pre-op", listener: (op: ISequencedDocumentMessage, local: boolean, target: IEventThisPlaceHolder) => void): any;

Remarks​

Note: this should be considered an internal implementation detail. It is not recommended for external use.

(event: "op", listener: (op: ISequencedDocumentMessage, local: boolean, target: IEventThisPlaceHolder) => void): any​

Fires after an incoming op is applied to the shared object.

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

To use, import via @fluidframework/shared-object-base/alpha.

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

Signature​

(event: "op", listener: (op: ISequencedDocumentMessage, local: boolean, target: IEventThisPlaceHolder) => void): any;

Remarks​

Note: this should be considered an internal implementation detail. It is not recommended for external use.