@fluidframework/protocol-definitions Package

Packages > @fluidframework/protocol-definitions

Core set of Fluid protocol interfaces shared between services and clients. These interfaces must always be back and forward compatible.

Interfaces

Interface Alerts Description
IAttachment Alpha
IBlob Alpha Raw blob stored within the tree.
IBranchOrigin Branch origin information.
ICapabilities Capabilities of a Client. In particular, whether or not the client is interactive.
IClient Represents a client connected to a Fluid service, including associated user details, permissions, and connection mode.
IClientConfiguration Alpha Key value store of service configuration properties provided to the client as part of connection.
IClientDetails IClient connection / environment metadata.
IConnect Alpha Message sent to connect to the given document.
IConnected Alpha Message sent to indicate a client has connected to the server.
ICreateBlobResponse Alpha
IDocumentAttributes Alpha
IDocumentMessage Alpha Document-specific message.
INack Alpha
INackContent Alpha Interface for nack content.
IProcessMessageResult Alpha
IProposal Alpha Proposal to set the given key/value pair.
IQuorum Alpha Interface combining tracking of clients as well as proposals in the Quorum.
IQuorumClients Interface for tracking clients in the Quorum.
IQuorumProposals Alpha Interface for tracking proposals in the Quorum.
ISequencedClient A IClient that has been acknowledged by the sequencer.
ISequencedDocumentMessage Sequenced message for a distributed document.
ISignalClient Alpha
ISignalMessage Interface for signals sent by the server to clients.
ISignalMessageBase Common interface between incoming and outgoing signals.
ISnapshotTree Alpha
ISummaryAck Alpha Contents of summary ack expected from the server.
ISummaryAttachment Unique identifier for blobs uploaded outside of the summary.
ISummaryBlob String or Binary data to be uploaded to the server as part of the container's Summary.
ISummaryContent Alpha
ISummaryHandle Path to a summary tree object from the last successful summary indicating the summary object hasn't changed since it was uploaded.
ISummaryNack Alpha Contents of summary nack expected from the server.
ISummaryProposal Alpha Data about the original proposed summary message.
ISummaryTree Tree Node data structure with children that are nodes of SummaryObject type: Blob, Handle, Attachment or another Tree.
ITokenClaims Alpha

JSON Web Token (JWT) Claims

See https://datatracker.ietf.org/doc/html/rfc7519#section-4
ITrace Messages to track latency trace.
ITree Alpha
IUploadedSummaryDetails Alpha
IUser Base user definition. It is valid to extend this interface when adding new details to the user object.
IVersion Alpha Represents a version of the snapshot of a data store.

Enumerations

Enum Alerts Description
FileMode Alpha
MessageType Alpha
NackErrorType Alpha Type of the nack.
ScopeType Alpha Defines scope access for a Container/Document.
TreeEntry Alpha Type of entries that can be stored in a tree.

Types

TypeAlias Alerts Description
ConnectionMode A client's connection mode - either view-only ("read") or allowing edits ("write").
IApprovedProposal Alpha Adds the sequence number at which the message was approved to an ISequencedProposal.
ICommittedProposal Alpha Adds the sequence number at which the message was committed to an IApprovedProposal.
ISequencedProposal Alpha Similar to IProposal except it also includes the sequence number when it was made.
IsoDate Alpha ISO 8601 format date: YYYY-MM-DDTHH:MM:SSZ.
ITreeEntry Alpha A tree entry wraps a path with a type of node.
SummaryObject Object representing a node within a summary tree.
SummaryTree Alpha The root of the summary tree.
SummaryType Type tag used to distinguish different types of nodes in a ISummaryTree.
SummaryTypeNoHandle Summary type that ISummaryHandle points to.

Namespaces

Namespace Description
SummaryType Type tag used to distinguish different types of nodes in a ISummaryTree.