FluidObjectHandle Class
Packages > @fluidframework/datastore > FluidObjectHandle
Signature:
export declare class FluidObjectHandle<T extends IFluidObject = IFluidObject> implements IFluidHandle
Implements: IFluidHandle
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(value, path, routeContext) | Creates a new FluidObjectHandle. |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
absolutePath | string | ||
IFluidHandle | IFluidHandle | ||
isAttached | boolean | ||
path | string | ||
routeContext | IFluidHandleContext | ||
value | T |
Methods
Method | Modifiers | Description |
---|---|---|
attachGraph() | ||
bind(handle) | ||
get() |
Constructors
FluidObjectHandle.(constructor)
Creates a new FluidObjectHandle.
Signature:
constructor(value: T, path: string, routeContext: IFluidHandleContext);
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
Parameter | Type | Description |
---|---|---|
handle | IFluidHandle |
Returns:
void
get
Signature:
get(): Promise<any>;
Returns:
Promise<any>