BlobHandle Class

Packages > @fluidframework/aqueduct > BlobHandle

This class represents blob (long string) This object is used only when creating (writing) new blob and serialization purposes. De-serialization process goes through FluidObjectHandle and request flow: DataObject.request() recognizes requests in the form of /blobs/<id> and loads blob.

Signature:

export declare class BlobHandle implements IFluidHandle

Implements: IFluidHandle

Constructors

List of constructors for this class
Constructor Modifiers Description
(constructor)(path, directory, routeContext) Constructs a new instance of the BlobHandle class

Properties

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

Methods

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

Constructors

BlobHandle.(constructor)

Constructs a new instance of the BlobHandle class

Signature:

constructor(path: string, directory: ISharedDirectory, routeContext: IFluidHandleContext);

Parameters

List of parameters
Parameter Type Description
path string
directory ISharedDirectory
routeContext IFluidHandleContext

Properties

absolutePath

Signature:

readonly absolutePath: string;

IFluidHandle

Signature:

get IFluidHandle(): IFluidHandle;

IFluidRouter

Signature:

get IFluidRouter(): IFluidRouter;

isAttached

Signature:

get isAttached(): boolean;

routeContext

Signature:

readonly routeContext: IFluidHandleContext;

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>

request

Signature:

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

Parameters

List of parameters
Parameter Type Description
request IRequest

Returns:

Promise<IResponse>