Skip to main content

IFluidHandleInternal Interface

Handle to a shared FluidObject.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/core-interfaces/legacy.

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

Signature​

export interface IFluidHandleInternal<out T = unknown> extends IFluidHandle<T>, IProvideFluidHandle

Extends: IFluidHandle<T>, IProvideFluidHandle

Type Parameters​

Parameter Default Description
T unknown

Properties​

Property Alerts Modifiers Type Description
absolutePath Alpha readonly string The absolute path to the handle context from the root.

Methods​

Method Alerts Return Type Description
attachGraph() Alpha void Runs through the graph and attach the bounded handles.
bind(handle) Alpha 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.

Property Details​

absolutePath​

The absolute path to the handle context from the root.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/core-interfaces/alpha.

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

Signature​

readonly absolutePath: string;

Type: string

Method Details​

attachGraph​

Runs through the graph and attach the bounded handles.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/core-interfaces/alpha.

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

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.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/core-interfaces/alpha.

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

Signature​

bind(handle: IFluidHandleInternal): void;

Parameters​

Parameter Type Description
handle IFluidHandleInternal