IOdspFluidContainer Interface

ODSP version of the IFluidContainer interface.

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

export interface IOdspFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema> extends IFluidContainer<TContainerSchema>

Extends: IFluidContainer<TContainerSchema>

Type Parameters

Parameter	Constraint	Default	Description
TContainerSchema	ContainerSchema	ContainerSchema

Methods

Method	Alerts	Return Type	Description
attach(props)	Beta	Promise<string>	A newly created container starts detached from the collaborative service. Calling attach() uploads the new container to the service and connects to the collaborative service. This function is the same as the IFluidContainer.attach function, but has ODSP specific function signatures.
uploadBlob(blob)	Beta	Promise<IFluidHandle<ArrayBufferLike>>	Upload a blob of data.

Method Details

attach

A newly created container starts detached from the collaborative service. Calling attach() uploads the new container to the service and connects to the collaborative service.

This function is the same as the IFluidContainer.attach function, but has ODSP specific function signatures.

This API is provided as a beta preview and may change without notice.

For more information about our API support guarantees, see here.

Signature

attach(props?: ContainerAttachProps<OdspContainerAttachProps>): Promise<string>;

Parameters

Parameter	Modifiers	Type	Description
props	optional	ContainerAttachProps<OdspContainerAttachProps>	Optional properties to pass to the attach function.

Returns

A promise which resolves when the attach is complete, with the string identifier of the container.

Return type: Promise<string>

uploadBlob

Upload a blob of data.

This API is provided as a beta preview and may change without notice.

For more information about our API support guarantees, see here.

Signature

uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;

Parameters

Parameter	Type	Description
blob	ArrayBufferLike	The blob to upload to the ODSP service.

Returns

Return type: Promise<IFluidHandle<ArrayBufferLike>>