LatestValueControls Interface
Common controls for the Latest* Value Managers.
To use, import via @fluidframework/presence/alpha.
For more information about our API support guarantees, see here.
Signature
export interface LatestValueControls
Properties
| Property | Alerts | Default Value | Type | Description |
|---|---|---|---|---|
| allowableUpdateLatency | Alpha |
number | Maximum time in milliseconds that a local value update is allowed to remain pending before it must be broadcast. | |
| forcedRefreshInterval | Alpha |
0 | number | Target time in milliseconds between oldest changed local state has been broadcast and forced rebroadcast of all local values. A value of less than 10 disables forced refresh. |
Property Details
allowableUpdateLatency
Maximum time in milliseconds that a local value update is allowed to remain pending before it must be broadcast.
To use, import via @fluidframework/presence/alpha.
For more information about our API support guarantees, see here.
Signature
allowableUpdateLatency: number;
Type: number
Remarks
There is no guarantee of broadcast within time allowed as other conditions such as disconnect or service throttling may cause a delay.
forcedRefreshInterval
Target time in milliseconds between oldest changed local state has been broadcast and forced rebroadcast of all local values. A value of less than 10 disables forced refresh.
To use, import via @fluidframework/presence/alpha.
For more information about our API support guarantees, see here.
Signature
forcedRefreshInterval: number;
Type: number