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

Type Parameters

Parameter	Constraint	Description
T
K	string | number

Events

Property	Alerts	Type	Description
localItemRemoved	Beta	(removedItem: { key: K; }) => void	Raised when specific local item is removed.
localItemUpdated	Beta	(updatedItem: { value: DeepReadonly<JsonSerializable<T> & JsonDeserialized<T>>; key: K; }) => void	Raised when specific local item's value is updated.
remoteItemRemoved	Beta	(removedItem: LatestMapItemRemovedClientData<K>) => void	Raised when specific item of remote client is removed.
remoteItemUpdated	Beta	(updatedItem: LatestMapItemUpdatedClientData<T, K>) => void	Raised when specific item's value of remote client is updated.
remoteUpdated	Beta	(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 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

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 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

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 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

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 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

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 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: (updates: LatestMapClientData<T, K>) => void;

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

Remarks

The event does not include item removals.