IDocumentService Interface

Packages > @fluidframework/driver-definitions > IDocumentService

Signature:

export interface IDocumentService 

Properties

List of properties of this interface
Property Type Description
policies IDocumentServicePolicies Policies implemented/instructed by driver.
resolvedUrl IResolvedUrl

Methods

List of methods of this class
Method Description
connectToDeltaStorage() Access to delta storage associated with the document
connectToDeltaStream(client) Subscribes to the document delta stream
connectToStorage() Access to storage associated with the document...
getErrorTrackingService() Returns the error tracking service

Events

policies

Policies implemented/instructed by driver.

Signature:

policies?: IDocumentServicePolicies;

resolvedUrl

Signature:

resolvedUrl: IResolvedUrl;

Methods

connectToDeltaStorage

Access to delta storage associated with the document

Signature:

connectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;

Returns:

Promise<IDocumentDeltaStorageService>

connectToDeltaStream

Subscribes to the document delta stream

Signature:

connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;

Parameters

List of parameters
Parameter Type Description
client IClient

Returns:

Promise<IDocumentDeltaConnection>

connectToStorage

Access to storage associated with the document…

Signature:

connectToStorage(): Promise<IDocumentStorageService>;

Returns:

Promise<IDocumentStorageService>

getErrorTrackingService

Returns the error tracking service

Signature:

getErrorTrackingService(): IErrorTrackingService | null;

Returns:

IErrorTrackingService | null