Skip to main content

LatestRawEvents Interface

This API is provided as a beta preview and may change without notice.

To use, import via @fluidframework/presence/beta.

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

/** @sealed */
export interface LatestRawEvents<T>

Type Parameters

Parameter Description
T

Events

Property Alerts Type Description
localUpdated Beta (update: { value: DeepReadonly<JsonSerializable<T> & JsonDeserialized<T>>; }) => void Raised when local client's value is updated, which may be the same value.
remoteUpdated Beta (update: LatestClientData<T>) => void Raised when remote client's value is updated, which may be the same value.

Event Details

localUpdated

Raised when local client's value is updated, which may be the same value.

This API is provided as a beta preview and may change without notice.

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature
localUpdated: (update: {
value: DeepReadonly<JsonSerializable<T> & JsonDeserialized<T>>;
}) => void;

Type: (update: { value: DeepReadonly<JsonSerializable<T> & JsonDeserialized<T>>; }) => void

remoteUpdated

Raised when remote client's value is updated, which may be the same value.

This API is provided as a beta preview and may change without notice.

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature
remoteUpdated: (update: LatestClientData<T>) => void;

Type: (update: LatestClientData<T>) => void