Skip to content 

FluidObjectHandle Class

Packages > @fluidframework/datastore > FluidObjectHandle

Signature:

export declare class FluidObjectHandle<T extends IFluidObject = IFluidObject> implements IFluidHandle 

Implements: IFluidHandle

Constructors

List of constructors for this class
Constructor Modifiers Description
(constructor)(value, path, routeContext) Creates a new FluidObjectHandle.

Properties

List of properties for this class
Property Modifiers Type Description
absolutePath string
IFluidHandle IFluidHandle
isAttached boolean
path string
routeContext IFluidHandleContext
value T

Methods

List of methods on this class
Method Modifiers Description
attachGraph()
bind(handle)
get()

Constructors

FluidObjectHandle.(constructor)

Creates a new FluidObjectHandle.

Signature:

constructor(value: T, path: string, routeContext: IFluidHandleContext);

Parameters

List of parameters
Parameter Type Description
value T The IFluidObject object this handle is for.
path string The path to this handle relative to the routeContext.
routeContext IFluidHandleContext The parent IFluidHandleContext that has a route to this handle.

Properties

absolutePath

Signature:

readonly absolutePath: string;

IFluidHandle

Signature:

get IFluidHandle(): IFluidHandle;

isAttached

Signature:

get isAttached(): boolean;

path

Signature:

readonly path: string;

routeContext

Signature:

readonly routeContext: IFluidHandleContext;

value

Signature:

protected readonly value: T;

Methods

attachGraph

Signature:

attachGraph(): void;

Returns:

void

bind

Signature:

bind(handle: IFluidHandle): void;

Parameters

List of parameters
Parameter Type Description
handle IFluidHandle

Returns:

void

get

Signature:

get(): Promise<any>;

Returns:

Promise<any>