IFluidHandle Interface

Packages > @fluidframework/core-interfaces > IFluidHandle

Handle to a shared FluidObject

Signature:

export interface IFluidHandle<T = IFluidObject & IFluidLoadable> extends IProvideFluidHandle 

Extends: IProvideFluidHandle

Properties

List of properties of this interface
Property Type Description
absolutePath string The absolute path to the handle context from the root.
isAttached boolean Flag indicating whether or not the entity has services attached.

Methods

List of methods of this class
Method Description
attachGraph() Runs through the graph and attach the bounded handles.
bind(handle) Binds the given handle to this one or attach the given handle if this handle is attached. A bound handle will also be attached once this handle is attached.
get() Returns a promise to the Fluid Object referenced by the handle.

Events

absolutePath

The absolute path to the handle context from the root.

Signature:

absolutePath: string;

isAttached

Flag indicating whether or not the entity has services attached.

Signature:

isAttached: boolean;

Methods

attachGraph

Runs through the graph and attach the bounded handles.

Signature:

attachGraph(): void;

Returns:

void

bind

Binds the given handle to this one or attach the given handle if this handle is attached. A bound handle will also be attached once this handle is attached.

Signature:

bind(handle: IFluidHandle): void;

Parameters

List of parameters
Parameter Type Description
handle IFluidHandle

Returns:

void

get

Returns a promise to the Fluid Object referenced by the handle.

Signature:

get(): Promise<T>;

Returns:

Promise<T>