LatestEvents Interface
Events from LatestRaw.
To use, import via @fluidframework/presence/beta.
For more information about our API support guarantees, see here.
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 LatestEvents<T, TRemoteValueAccessor extends ValueAccessor<T> = ProxiedValueAccessor<T>>
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| T | |||
| TRemoteValueAccessor | ValueAccessor<T> | ProxiedValueAccessor<T> |
Events
| Property | Alerts | Type | Description |
|---|---|---|---|
| localUpdated | Beta | (update: { value: DeepReadonly<JsonSerializable<T>>; }) => void | Raised when local client's value is updated, which may be the same value. |
| remoteUpdated | Beta | (update: LatestClientData<T, TRemoteValueAccessor>) => 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.
For more information about our API support guarantees, see here.
Signature
localUpdated: (update: {
value: DeepReadonly<JsonSerializable<T>>;
}) => void;
Type: (update: { value: DeepReadonly<JsonSerializable<T>>; }) => void
remoteUpdated
Raised when remote client's value is updated, which may be the same value.
For more information about our API support guarantees, see here.
Signature
remoteUpdated: (update: LatestClientData<T, TRemoteValueAccessor>) => void;
Type: (update: LatestClientData<T, TRemoteValueAccessor>) => void