Skip to main content

LatestMapRawEvents Interface

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

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

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

Signature​

/** @sealed */
export interface LatestMapRawEvents<T, K extends string | number>

Type Parameters​

Parameter Constraint Description
T
K string | number

Events​

Property Alerts Type Description
localItemRemoved Alpha (removedItem: { key: K; }) => void Raised when specific local item is removed.
localItemUpdated Alpha (updatedItem: { value: DeepReadonly<JsonSerializable<T> & JsonDeserialized<T>>; key: K; }) => void Raised when specific local item's value is updated.
remoteItemRemoved Alpha (removedItem: LatestMapItemRemovedClientData<K>) => void Raised when specific item of remote client is removed.
remoteItemUpdated Alpha (updatedItem: LatestMapItemUpdatedClientData<T, K>) => void Raised when specific item's value of remote client is updated.
remoteUpdated Alpha (updates: LatestMapClientData<T, K>) => void Raised when any item's value for remote client is updated.

Event Details​

localItemRemoved​

Raised when specific local item is removed.

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

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

Signature​

localItemRemoved: (removedItem: {
        key: K;
    }) => void;

Type: (removedItem: { key: K; }) => void

localItemUpdated​

Raised when specific local item's value is updated.

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

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

Signature​

localItemUpdated: (updatedItem: {
        value: DeepReadonly<JsonSerializable<T> & JsonDeserialized<T>>;
        key: K;
    }) => void;

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

remoteItemRemoved​

Raised when specific item of remote client is removed.

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

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

Signature​

remoteItemRemoved: (removedItem: LatestMapItemRemovedClientData<K>) => void;

Type: (removedItem: LatestMapItemRemovedClientData<K>) => void

remoteItemUpdated​

Raised when specific item's value of remote client is updated.

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

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

Signature​

remoteItemUpdated: (updatedItem: LatestMapItemUpdatedClientData<T, K>) => void;

Type: (updatedItem: LatestMapItemUpdatedClientData<T, K>) => void

remoteUpdated​

Raised when any item's value for remote client is updated.

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

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

Signature​

remoteUpdated: (updates: LatestMapClientData<T, K>) => void;

Type: (updates: LatestMapClientData<T, K>) => void

Remarks​

The event does not include item removals.