IFluidHandle Interface

Handle to a shared FluidObject

Signature

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

Extends: IProvideFluidHandle

Type Parameters

Parameter	Default	Description
T	FluidObject & IFluidLoadable

Properties

Property	Alerts	Type	Description
absolutePath	Deprecated	string
isAttached		boolean	Flag indicating whether or not the entity has services attached.

Methods

Method	Return Type	Description
attachGraph()	void	Runs through the graph and attach the bounded handles.
bind(handle)	void	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()	Promise<T>	Returns a promise to the Fluid Object referenced by the handle.

Property Details

absolutePath

This API is deprecated and will be removed in a future release.

• Do not use handle's path for routing. Use get to get the underlying object.

The absolute path to the handle context from the root.

Signature

readonly absolutePath: string;

Type: string

isAttached

Flag indicating whether or not the entity has services attached.

Signature

readonly isAttached: boolean;

Type: boolean

Method Details

attachGraph

Runs through the graph and attach the bounded handles.

Signature

attachGraph(): 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

Parameter	Type	Description
handle	IFluidHandle

get

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

Signature

get(): Promise<T>;

Returns

Return type: Promise<T>