IBaseProtocolHandler Interface
Packages > @fluidframework/container-loader > IBaseProtocolHandler
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/container-loader/legacy
.
For more information about our API support guarantees, see here .
Signature
export interface IProtocolHandler
Properties
Property | Alerts | Modifiers | Type | Description |
---|---|---|---|---|
attributes |
Alpha
|
readonly
|
IDocumentAttributes | |
quorum |
Alpha
|
readonly
|
IQuorum |
Methods
Method | Alerts | Return Type | Description |
---|---|---|---|
close() |
Alpha
|
void | |
getProtocolState() |
Alpha
|
IScribeProtocolState | |
processMessage(message, local) |
Alpha
|
IProcessMessageResult | |
setConnectionState(connected, clientId) |
Alpha
|
any | |
snapshot() |
Alpha
|
IQuorumSnapshot |
Property Details
attributes
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-loader/alpha
.
For more information about our API support guarantees, see here .
Signature
readonly attributes: IDocumentAttributes;
Type: IDocumentAttributes
quorum
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-loader/alpha
.
For more information about our API support guarantees, see here .
Signature
readonly quorum: IQuorum;
Type: IQuorum
Method Details
close
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-loader/alpha
.
For more information about our API support guarantees, see here .
Signature
close(): void;
getProtocolState
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-loader/alpha
.
For more information about our API support guarantees, see here .
Signature
getProtocolState(): IScribeProtocolState;
Returns
Return type: IScribeProtocolState
processMessage
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-loader/alpha
.
For more information about our API support guarantees, see here .
Signature
processMessage(message: ISequencedDocumentMessage, local: boolean): IProcessMessageResult;
Parameters
Parameter | Type | Description |
---|---|---|
message | ISequencedDocumentMessage | |
local | boolean |
Returns
Return type: IProcessMessageResult
setConnectionState
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-loader/alpha
.
For more information about our API support guarantees, see here .
Signature
setConnectionState(connected: boolean, clientId: string | undefined): any;
Parameters
Parameter | Type | Description |
---|---|---|
connected | boolean | |
clientId | string | undefined |
Returns
Return type: any
snapshot
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-loader/alpha
.
For more information about our API support guarantees, see here .
Signature
snapshot(): IQuorumSnapshot;
Returns
Return type: IQuorumSnapshot