Packages > @fluidframework/odsp-client > OdspClient
OdspClient Class
OdspClient provides the ability to have a Fluid object backed by the ODSP service within the context of Microsoft 365 (M365) tenants.
This API is provided as a beta preview and may change without notice.
To use, import via @fluidframework/odsp-client/beta.
For more information about our API support guarantees, see here .
Signature
/** @sealed */
export declare class OdspClient
Constructors
| Constructor | Alerts | Description |
|---|---|---|
| (constructor)(properties) |
Beta
|
Constructs a new instance of the OdspClient class
|
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| createContainer(containerSchema) |
Beta
|
Promise<{ container: IFluidContainer<T>; services: OdspContainerServices; }> | |
| getContainer(id, containerSchema) |
Beta
|
Promise<{ container: IFluidContainer<T>; services: OdspContainerServices; }> |
Constructor Details
(constructor)
Constructs a new instance of the OdspClient class
This API is provided as a beta preview and may change without notice.
To use, import via @fluidframework/odsp-client/beta.
For more information about our API support guarantees, see here .
Signature
constructor(properties: OdspClientProps);
Parameters
| Parameter | Type | Description |
|---|---|---|
| properties | OdspClientProps |
Method Details
createContainer
This API is provided as a beta preview and may change without notice.
To use, import via @fluidframework/odsp-client/beta.
For more information about our API support guarantees, see here .
Signature
createContainer<T extends ContainerSchema>(containerSchema: T): Promise<{
container: IFluidContainer<T>;
services: OdspContainerServices;
}>;
Type Parameters
| Parameter | Constraint | Description |
|---|---|---|
| T | ContainerSchema |
Parameters
| Parameter | Type | Description |
|---|---|---|
| containerSchema | T |
Returns
Return type: Promise<{ container: IFluidContainer <T>; services: OdspContainerServices ; }>
getContainer
This API is provided as a beta preview and may change without notice.
To use, import via @fluidframework/odsp-client/beta.
For more information about our API support guarantees, see here .
Signature
getContainer<T extends ContainerSchema>(id: string, containerSchema: T): Promise<{
container: IFluidContainer<T>;
services: OdspContainerServices;
}>;
Type Parameters
| Parameter | Constraint | Description |
|---|---|---|
| T | ContainerSchema |
Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | |
| containerSchema | T |
Returns
Return type: Promise<{ container: IFluidContainer <T>; services: OdspContainerServices ; }>