Skip to main content

LatestArguments Interface

Arguments that are passed to the StateFactory.latest function.

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.

Signature

export interface LatestArguments<T extends object | null>

Type Parameters

Parameter Constraint Description
T object | null

Properties

Property Alerts Modifiers Type Description
local Beta JsonSerializable<T> & JsonDeserialized<T> & (object | null) The initial value of the local state.
settings Beta optional BroadcastControlSettings | undefined See BroadcastControlSettings.

Property Details

local

The initial value of the local state.

This API is provided as a beta preview and may change without notice.

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

Signature
local: JsonSerializable<T> & JsonDeserialized<T> & (object | null);

Type: JsonSerializable<T> & JsonDeserialized<T> & (object | null)

settings

See BroadcastControlSettings.

This API is provided as a beta preview and may change without notice.

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

Signature
settings?: BroadcastControlSettings | undefined;

Type: BroadcastControlSettings | undefined