ISerializedElection Interface
Packages > @fluidframework/container-runtime > ISerializedElection
Serialized state of IOrderedClientElection.
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/container-runtime/legacy.
For more information about our API support guarantees, see here .
Signature
export interface ISerializedElection
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| electedClientId | Alpha |
readonly |
string | undefined |
Most recently elected client id. This is either: 1. the interactive elected parent client, in which case electedClientId === electedParentId, and the SummaryManager on the elected client will spawn a summarizer client, or 2. the non-interactive summarizer client itself. |
| electedParentId | Alpha |
readonly |
string | undefined | Most recently elected parent client id. This is always an interactive client. |
| electionSequenceNumber | Alpha |
readonly |
number | Sequence number at the time of the latest election. |
Property Details
electedClientId
Most recently elected client id. This is either:
-
the interactive elected parent client, in which case electedClientId === electedParentId, and the SummaryManager on the elected client will spawn a summarizer client, or
-
the non-interactive summarizer client itself.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime/alpha.
For more information about our API support guarantees, see here .
Signature
readonly electedClientId: string | undefined;
Type: string | undefined
electedParentId
Most recently elected parent client id. This is always an interactive client.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime/alpha.
For more information about our API support guarantees, see here .
Signature
readonly electedParentId: string | undefined;
Type: string | undefined
electionSequenceNumber
Sequence number at the time of the latest election.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime/alpha.
For more information about our API support guarantees, see here .
Signature
readonly electionSequenceNumber: number;
Type: number