IFluidHandleContext Interface

Describes a routing context from which other IFluidHandleContexts are defined.

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 IFluidHandleContext extends IProvideFluidHandleContext

Extends: IProvideFluidHandleContext

Properties

Property	Alerts	Modifiers	Type	Description
absolutePath	Alpha	readonly	string	The absolute path to the handle context from the root.
isAttached	Alpha	readonly	boolean	Flag indicating whether or not the entity has services attached.
routeContext	Alpha	optional, readonly	IFluidHandleContext	The parent IFluidHandleContext that has provided a route path to this IFluidHandleContext or undefined at the root.

Methods

Method	Alerts	Return Type	Description
attachGraph()	Alpha	void	Runs through the graph and attach the bounded handles.
resolveHandle(request)	Alpha	Promise<IResponse>

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

isAttached

Flag indicating whether or not the entity has services 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

readonly isAttached: boolean;

Type: boolean

routeContext

The parent IFluidHandleContext that has provided a route path to this IFluidHandleContext or undefined at 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 routeContext?: IFluidHandleContext;

Type: IFluidHandleContext

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;

resolveHandle

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

resolveHandle(request: IRequest): Promise<IResponse>;

Parameters

Parameter	Type	Description
request	IRequest

Returns

Return type: Promise<IResponse>