Packages > @fluid-experimental/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.
WARNING: This API is provided as a beta preview and may change without notice. Use at your own risk.
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) (BETA)
Constructs a new instance of the OdspClient
class
WARNING: This API is provided as a beta preview and may change without notice. Use at your own risk.
Signature
constructor(properties: OdspClientProps);
Parameters
Parameter | Type | Description |
---|---|---|
properties | OdspClientProps |
Method Details
createContainer (BETA)
WARNING: This API is provided as a beta preview and may change without notice. Use at your own risk.
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 (BETA)
WARNING: This API is provided as a beta preview and may change without notice. Use at your own risk.
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 ; }>