Packages > @fluidframework/odsp-client

@fluidframework/odsp-client Package

The odsp-client package provides a simple and powerful way to consume collaborative Fluid data with OneDrive/SharePoint (ODSP) storage.


Please note that odsp-client is currently an experimental package. We’d love for you to try it out and provide feedback but it is not yet recommended or supported for production scenarios.


Interface Alerts Description
IOdspTokenProvider Beta Abstracts the token fetching mechanism for a hosting application. The hosting application is responsible for providing an implementation.
OdspClientProps Beta
OdspConnectionConfig Beta Defines the necessary properties that will be applied to all containers created by an OdspClient instance. This includes callbacks for the authentication tokens required for ODSP.
OdspContainerServices Beta OdspContainerServices is returned by the OdspClient alongside a FluidContainer. It holds the functionality specifically tied to the ODSP service, and how the data stored in the FluidContainer is persisted in the backend and consumed by users. Any functionality regarding how the data is handled within the FluidContainer itself, i.e. which data objects or DDSes to use, will not be included here but rather on the FluidContainer class itself.
OdspMember Beta Since ODSP provides user names and email for all of its members, we extend the IMember interface to include this service-specific value. It will be returned for all audience members connected.
TokenResponse Beta Represents token response


Class Alerts Modifiers Description
OdspClient Beta sealed OdspClient provides the ability to have a Fluid object backed by the ODSP service within the context of Microsoft 365 (M365) tenants.


TypeAlias Alerts Description
IOdspAudience Beta Audience object for ODSP containers