Container Class

Constructors

Container.(constructor)

Constructs a new instance of the Container class

Signature:

constructor(options: any, scope: IFluidObject, codeLoader: ICodeLoader, loader: ILoader, serviceFactory: IDocumentServiceFactory, urlResolver: IUrlResolver, config: IContainerConfig, logger: ITelemetryBaseLogger | undefined);

Parameters

Properties

attachState

Signature:

get attachState(): AttachState;

audience

Retrieves the audience associated with the document

Signature:

get audience(): IAudience;

canReconnect

Signature:

get canReconnect(): boolean;

chaincodePackage

Signature:

get chaincodePackage(): IFluidCodeDetails | undefined;

clientDetails

Signature:

get clientDetails(): IClientDetails;

clientId

The server provided id of the client. Set once this.connected is true, otherwise undefined

Signature:

get clientId(): string | undefined;

closed

Signature:

get closed(): boolean;

connected

Signature:

get connected(): boolean;

connectionState

Signature:

get connectionState(): ConnectionState;

deltaManager

Signature:

get deltaManager(): IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;

existing

Flag indicating whether the document already existed at the time of load

Signature:

get existing(): boolean | undefined;

id

Signature:

get id(): string;

IFluidRouter

Signature:

get IFluidRouter(): IFluidRouter;

loadedFromVersion

Signature:

get loadedFromVersion(): IVersion | undefined;

options

Signature:

readonly options: any;

parentBranch

Returns the parent branch for this document

Signature:

get parentBranch(): string | null;

readonly

Tells if container is in read-only mode. Data stores should listen for “readonly” notifications and disallow user making changes to data stores. Readonly state can be because of no storage write permission, or due to host forcing readonly mode for container. It is undefined if we have not yet established websocket connection and do not know if user has write access to a file.

Signature:

get readonly(): boolean | undefined;

readonlyPermissions

Tells if user has no write permissions for file in storage It is undefined if we have not yet established websocket connection and do not know if user has write access to a file.

Signature:

get readonlyPermissions(): boolean | undefined;

resolvedUrl

Signature:

get resolvedUrl(): IResolvedUrl | undefined;

scopes

The server provided claims of the client. Set once this.connected is true, otherwise undefined

Signature:

get scopes(): string[] | undefined;

serviceConfiguration

Service configuration details. If running in offline mode will be undefined otherwise will contain service configuration details returned as part of the initial connection.

Signature:

get serviceConfiguration(): IServiceConfiguration | undefined;

storage

Signature:

get storage(): IDocumentStorageService | undefined;

subLogger

Signature:

subLogger: TelemetryLogger;

version

Signature:

static version: string;

Methods

attach

Signature:

attach(request: IRequest): Promise<void>;

Parameters

Returns:

Promise<void>

close

Signature:

close(error?: ICriticalContainerError): void;

Parameters

Returns:

void

create

Signature:

static create(codeLoader: ICodeLoader, options: any, scope: IFluidObject, loader: Loader, source: DetachedContainerSource, serviceFactory: IDocumentServiceFactory, urlResolver: IUrlResolver, logger?: ITelemetryBaseLogger): Promise<Container>;

Parameters

Returns:

Promise<Container>

forceReadonly

Signature:

forceReadonly(readonly: boolean): void;

Parameters

Returns:

void

getAbsoluteUrl

Signature:

getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;

Parameters

Returns:

Promise<string | undefined>

getQuorum

Retrieves the quorum associated with the document

Signature:

getQuorum(): IQuorum;

Returns:

IQuorum

hasNullRuntime

Signature:

hasNullRuntime(): boolean;

Returns:

boolean

load

Load container.

Signature:

static load(id: string, serviceFactory: IDocumentServiceFactory, codeLoader: ICodeLoader, options: any, scope: IFluidObject, loader: ILoader, request: IRequest, resolvedUrl: IFluidResolvedUrl, urlResolver: IUrlResolver, logger?: ITelemetryBaseLogger): Promise<Container>;

Parameters

Returns:

Promise<Container>

raiseContainerWarning

Raise non-critical error to host. Calling this API will not close container. For critical errors, please call Container.close(error).

Signature:

raiseContainerWarning(warning: ContainerWarning): void;

Parameters

Returns:

void

reloadContext

Signature:

reloadContext(): Promise<void>;

Returns:

Promise<void>

request

Signature:

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

Parameters

Returns:

Promise<IResponse>

resume

Signature:

resume(): void;

Returns:

void

resumeInternal

Signature:

protected resumeInternal(args?: IConnectionArgs): void;

Parameters

Returns:

void

serialize

Signature:

serialize(): string;

Returns:

string

setAutoReconnect

Signature:

setAutoReconnect(reconnect: boolean): void;

Parameters

Returns:

void

snapshot

Signature:

snapshot(tagMessage: string, fullTree?: boolean): Promise<void>;

Parameters

Returns:

Promise<void>