Latest Interface
State that provides the latest known value from this client to others and read access to their values. All participant clients must provide a value.
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 Latest<T, TRemoteAccessor extends ValueAccessor<T> = ProxiedValueAccessor<T>>
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| T | |||
| TRemoteAccessor | ValueAccessor<T> | ProxiedValueAccessor<T> |
Remarks
Create using StateFactory.latest registered to StatesWorkspace.
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| controls | Beta | readonly | BroadcastControls | Controls for management of sending updates. |
| events | Beta | readonly | Listenable<LatestEvents<T, TRemoteAccessor>> | Events for LatestRaw. |
| local | Beta | DeepReadonly<JsonDeserialized<T>> | Current state for this client. State for this client that will be transmitted to all other connected clients. | |
| presence | Beta | readonly | Presence | Containing Presence |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| getRemote(attendee) | Beta | LatestData<T, TRemoteAccessor> | Access to a specific attendee's value. |
| getRemotes() | Beta | IterableIterator<LatestClientData<T, TRemoteAccessor>> | Iterable access to remote clients' values. |
| getStateAttendees() | Beta | Attendee[] | Array of Attendees that have provided states. |
Property Details
controls
Controls for management of sending updates.
For more information about our API support guarantees, see here.
Signature
readonly controls: BroadcastControls;
Type: BroadcastControls
events
Events for LatestRaw.
For more information about our API support guarantees, see here.
Signature
readonly events: Listenable<LatestEvents<T, TRemoteAccessor>>;
Type: Listenable<LatestEvents<T, TRemoteAccessor>>
local
Current state for this client. State for this client that will be transmitted to all other connected clients.
For more information about our API support guarantees, see here.
Signature
get local(): DeepReadonly<JsonDeserialized<T>>;
set local(value: JsonSerializable<T>);
Type: DeepReadonly<JsonDeserialized<T>>
Remarks
Manager assumes ownership of the value and its references. Make a deep clone before setting, if needed. No comparison is done to detect changes; all sets are transmitted.
presence
Containing Presence
For more information about our API support guarantees, see here.
Signature
readonly presence: Presence;
Type: Presence
Method Details
getRemote
Access to a specific attendee's value.
For more information about our API support guarantees, see here.
Signature
getRemote(attendee: Attendee): LatestData<T, TRemoteAccessor>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| attendee | Attendee |
Returns
Return type: LatestData<T, TRemoteAccessor>
getRemotes
Iterable access to remote clients' values.
For more information about our API support guarantees, see here.
Signature
getRemotes(): IterableIterator<LatestClientData<T, TRemoteAccessor>>;
Returns
Return type: IterableIterator<LatestClientData<T, TRemoteAccessor>>
getStateAttendees
Array of Attendees that have provided states.
For more information about our API support guarantees, see here.
Signature
getStateAttendees(): Attendee[];
Returns
Return type: Attendee[]