OdspClient Class
OdspClient provides the ability to have a Fluid object backed by the ODSP service within the context of Microsoft 365 (M365) tenants.
To use, import via @fluidframework/odsp-client/beta.
For more information about our API support guarantees, see here.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
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: IOdspFluidContainer<T>; services: IOdspContainerServices; }> | |
| getContainer(id, containerSchema) | Beta | Promise<{ container: IOdspFluidContainer<T>; services: IOdspContainerServices; }> |
Constructor Details
(constructor)
Constructs a new instance of the OdspClient class
For more information about our API support guarantees, see here.
Signature
constructor(properties: OdspClientProps);
Parameters
| Parameter | Type | Description |
|---|---|---|
| properties | OdspClientProps |
Method Details
createContainer
For more information about our API support guarantees, see here.
Signature
createContainer<T extends ContainerSchema>(containerSchema: T): Promise<{
container: IOdspFluidContainer<T>;
services: IOdspContainerServices;
}>;
Type Parameters
| Parameter | Constraint | Description |
|---|---|---|
| T | ContainerSchema |
Parameters
| Parameter | Type | Description |
|---|---|---|
| containerSchema | T |
Returns
Return type: Promise<{ container: IOdspFluidContainer<T>; services: IOdspContainerServices; }>
getContainer
For more information about our API support guarantees, see here.
Signature
getContainer<T extends ContainerSchema>(id: string, containerSchema: T): Promise<{
container: IOdspFluidContainer<T>;
services: IOdspContainerServices;
}>;
Type Parameters
| Parameter | Constraint | Description |
|---|---|---|
| T | ContainerSchema |
Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | |
| containerSchema | T |
Returns
Return type: Promise<{ container: IOdspFluidContainer<T>; services: IOdspContainerServices; }>