Skip to main content

LatestMapValueManagerEvents 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 LatestMapValueManagerEvents<T, K extends string | number>

Type Parameters​

Parameter Constraint Description
T
K string | number

Events​

Property Alerts Type Description
itemRemoved Alpha (removedItem: LatestMapItemRemovedClientData<K>) => void Raised when specific item of remote client is removed.
itemUpdated Alpha (updatedItem: LatestMapItemValueClientData<T, K>) => void Raised when specific item's value of remote client is updated.
localItemRemoved Alpha (removedItem: { key: K; }) => void Raised when specific local item is removed.
localItemUpdated Alpha (updatedItem: { value: InternalUtilityTypes.FullyReadonly<JsonSerializable<T> & JsonDeserialized<T>>; key: K; }) => void Raised when specific local item's value is updated.
updated Alpha (updates: LatestMapValueClientData<T, K>) => void Raised when any item's value for remote client is updated.

Event Details​

itemRemoved​

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​

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

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

itemUpdated​

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​

itemUpdated: (updatedItem: LatestMapItemValueClientData<T, K>) => void;

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

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: InternalUtilityTypes.FullyReadonly<JsonSerializable<T> & JsonDeserialized<T>>;
        key: K;
    }) => void;

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

updated​

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​

updated: (updates: LatestMapValueClientData<T, K>) => void;

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

Remarks​

The event does not include item removals.