@fluidframework/protocol-definitions Package
Interfaces
| Interface | Alerts | Description |
|---|---|---|
| IActorClient | ||
| IAttachment | ||
| IBlob | Raw blob stored within the tree | |
| IBranchOrigin | Branch origin information | |
| ICapabilities | ||
| IClient | ||
| IClientConfiguration | Key value store of service configuration properties provided to the client as part of connection | |
| IClientDetails | ||
| IClientJoin | Contents sent with a ClientJoin message | |
| IConnect | Message sent to connect to the given document | |
| IConnected | Message sent to indicate a client has connected to the server | |
| ICreateBlobResponse | ||
| IDocumentAttributes | ||
| IDocumentMessage | Document specific message | |
| IDocumentSystemMessage | Document Message with optional system level data field. | |
| IHelpMessage | Represents a message containing tasks. | |
| INack | ||
| INackContent | Interface for nack content. | |
| IProcessMessageResult | ||
| IProposal | Proposal to set the given key/value pair. Consensus on the proposal is achieved if the MSN is >= the sequence number at which the proposal is made and no client within the collaboration window rejects the proposal. | |
| IProtocolState | ||
| IQueueMessage | Represents a message in task queue to be processed. | |
| IQuorum | Interface combining tracking of clients as well as proposals in the Quorum. | |
| IQuorumClients | Interface for tracking clients in the Quorum. | |
| IQuorumClientsEvents | Events fired by a Quorum in response to client tracking. | |
| IQuorumProposals | Interface for tracking proposals in the Quorum. | |
| IQuorumProposalsEvents | Events fired by a Quorum in response to proposal tracking. | |
| ISequencedClient | ||
| ISequencedDocumentAugmentedMessage | ||
| ISequencedDocumentMessage | Sequenced message for a distributed document | |
| ISequencedDocumentSystemMessage | ||
| IServerError | General errors returned from the server. May want to add error code or something similar in the future. | |
| ISignalClient | ||
| ISignalMessage | ||
| ISnapshotTree | ||
| ISnapshotTreeEx | ||
| ISummaryAck | Contents of summary ack expected from the server. | |
| ISummaryAttachment | Unique identifier for blobs uploaded outside of the summary. Attachment Blobs are uploaded and downloaded separately and do not take part of the snapshot payload. The id gets returned from the backend after the attachment has been uploaded. Additional information can be found here: https://github.com/microsoft/FluidFramework/issues/6374 Ex. "id": "bQAQKARDdMdTgqICmBa_ZB86YXwGP" | |
| ISummaryAuthor | Deprecated | |
| ISummaryBlob | String or Binary data to be uploaded to the server as part of the container's Summary. Note: Already uploaded blobs would be referenced by a ISummaryAttachment. Additional information can be found here: https://github.com/microsoft/FluidFramework/issues/6568 Ex. "content": "{ "pkg":"[\"OfficeRootComponent\",\"LastEditedComponent\"]", "summaryFormatVersion":2,"isRootDataStore":false }" | |
| ISummaryCommitter | Deprecated | |
| ISummaryConfiguration | ||
| ISummaryContent | ||
| ISummaryHandle | Path to a summary tree object from the last successful summary indicating the summary object hasn't changed since it was uploaded. To illustrate, if a DataStore did not change since last summary, the framework runtime will use a handle for the entire DataStore instead of re-sending the entire subtree. The same concept applies for a DDS. An example of handle would be: '//'. | |
| ISummaryNack | Contents of summary nack expected from the server. | |
| ISummaryProposal | Data about the original proposed summary op. | |
| ISummaryTokenClaims | ||
| ISummaryTree | Tree Node data structure with children that are nodes of SummaryObject type: Blob, Handle, Attachment or another Tree. | |
| ITokenClaims | JSON Web Token (JWT) Claims See https://datatracker.ietf.org/doc/html/rfc7519\#section\-4 | |
| ITokenProvider | ||
| ITokenService | The ITokenService abstracts the discovery of claims contained within a token | |
| ITrace | Messages to track latency trace | |
| ITree | ||
| IUploadedSummaryDetails | ||
| IUser | Base user definition. It is valid to extend this interface when adding new details to the user object. | |
| IVersion | Represents a version of the snapshot of a data store |
Enumerations
| Enum | Description |
|---|---|
| FileMode | |
| MessageType | |
| NackErrorType | Type of the Nack. InvalidScopeError: Client's token is not valid for the intended op. ThrottlingError: Retryable after retryAfter number. BadRequestError: Clients op is invalid and should retry immediately with a valid op. LimitExceededError: Service is having issues. Client should not retry. |
| ScopeType | Defines scope access for a Container/Document |
| TreeEntry | Type of entries that can be stored in a tree |
Types
| TypeAlias | Description |
|---|---|
| ConnectionMode | |
| IApprovedProposal | Adds the sequence number at which the message was approved to an ISequencedProposal |
| ICommittedProposal | Adds the sequence number at which the message was committed to an IApprovedProposal |
| IQuorumEvents | All events fired by an IQuorum, both client tracking and proposal tracking. |
| ISequencedProposal | Similar to IProposal except includes the sequence number when it was made in addition to the fields on IProposal |
| ITreeEntry | A tree entry wraps a path with a type of node |
| SummaryObject | |
| SummaryTree | |
| SummaryType | |
| SummaryTypeNoHandle |
Namespaces
| Namespace | Description |
|---|---|
| SummaryType | Type tag used to distinguish different types of nodes in a ISummaryTree. |