Packages > @fluidframework/core-interfaces > IFluidHandle
IFluidHandle Interface
Handle to a shared FluidObject .
Signature
export interface IFluidHandle<out T = FluidObject & IFluidLoadable> extends IProvideFluidHandle
Extends: IProvideFluidHandle
Type Parameters
| Parameter | Default | Description |
|---|---|---|
| T | FluidObject & IFluidLoadable |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| absolutePath |
DEPRECATED
|
readonly
|
string | |
| isAttached |
readonly
|
boolean | Flag indicating whether or not the entity has services attached. |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| attachGraph() |
DEPRECATED
|
void | |
| bind(handle) |
DEPRECATED
|
void | |
| get() | Promise<T> | Returns a promise to the Fluid Object referenced by the handle. |
Property Details
absolutePath
API This
Do not use handle’s path for routing. Use get to get the underlying object.
The absolute path to the handle context from the root.
Signature
readonly absolutePath: string;
isAttached
Flag indicating whether or not the entity has services attached.
Signature
readonly isAttached: boolean;
Method Details
attachGraph
API This
To be removed. This is part of an internal API surface and should not be called.
Runs through the graph and attach the bounded handles.
Signature
attachGraph(): void;
bind
API This
To be removed. This is part of an internal API surface and should not be called.
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.
Signature
bind(handle: IFluidHandle): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| handle | IFluidHandle |
get
Returns a promise to the Fluid Object referenced by the handle.
Signature
get(): Promise<T>;
Returns
Return type: Promise<T>