Packages > @fluidframework/protocol-definitions

@fluidframework/protocol-definitions Package

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

Interfaces

Interface Description
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 Key value store of service configuration properties provided to the client as part of connection.
IClientDetails IClient connection / environment metadata.
IDocumentMessage Document-specific message.
IQuorumClients Interface for tracking clients in the Quorum.
ISequencedClient A IClient that has been acknowledged by the sequencer.
ISequencedDocumentMessage Sequenced message for a distributed document.
ISignalMessage Interface for signals sent by the server to clients.
ISignalMessageBase Common interface between incoming and outgoing signals.
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.
ISummaryHandle Path to a summary tree object from the last successful summary indicating the summary object hasn't changed since it was uploaded.
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

ITrace Messages to track latency trace.
IUser Base user definition. It is valid to extend this interface when adding new details to the user object.

Types

TypeAlias Description
ConnectionMode A client's connection mode - either view-only ("read") or allowing edits ("write").
SummaryObject Object representing a node within a 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.