Skip to main content

FluidObjectHandle Class

Handle for a shared FluidObject. \

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

To use, import via @fluidframework/datastore/legacy.

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

Signature​

export declare class FluidObjectHandle<T extends FluidObject = FluidObject> extends FluidHandleBase<T>

Extends: FluidHandleBase<T>

Type Parameters​

Parameter Constraint Default Description
T FluidObject FluidObject

Constructors​

Constructor Alerts Description
(constructor)(value, path, routeContext) Beta Creates a new FluidObjectHandle.

Properties​

Property Alerts Modifiers Type Description
absolutePath Beta readonly string
isAttached Beta readonly boolean
path Beta readonly string
routeContext Beta readonly IFluidHandleContext
value Beta readonly T | Promise<T>

Methods​

Method Alerts Return Type Description
attachGraph() Beta void
get() Beta Promise<any>

Constructor Details​

(constructor)​

Creates a new FluidObjectHandle.

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

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

Signature​
constructor(value: T | Promise<T>, path: string, routeContext: IFluidHandleContext);

Parameters​

Parameter Type Description
value T | Promise<T> The FluidObject object this handle is for.
path string The path to this handle relative to the routeContext.
routeContext IFluidHandleContext The parent @fluidframework/core-interfaces#IFluidHandleContext that has a route to this handle.

Property Details​

absolutePath​

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

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

Signature​
readonly absolutePath: string;

Type: string

isAttached​

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

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

Signature​
get isAttached(): boolean;

Type: boolean

path​

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

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

Signature​
readonly path: string;

Type: string

routeContext​

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

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

Signature​
readonly routeContext: IFluidHandleContext;

Type: IFluidHandleContext

value​

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

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

Signature​
protected readonly value: T | Promise<T>;

Type: T | Promise<T>

Method Details​

attachGraph​

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

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

Signature​
attachGraph(): void;

get​

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

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

Signature​
get(): Promise<any>;

Returns​

Return type: Promise<any>