FileDocumentService Class

Packages > @fluidframework/file-driver > FileDocumentService

The DocumentService manages the different endpoints for connecting to underlying storage for file document service.

Signature:

export declare class FileDocumentService implements api.IDocumentService 

Implements: api.IDocumentService

Constructors

List of constructors for this class
Constructor Modifiers Description
(constructor)(storage, deltaStorage, deltaConnection) Constructs a new instance of the FileDocumentService class

Properties

List of properties for this class
Property Modifiers Type Description
resolvedUrl api.IResolvedUrl

Methods

List of methods on this class
Method Modifiers Description
connectToDeltaStorage()
connectToDeltaStream(client) Connects to a delta storage endpoint of provided documentService to get ops and then replaying them so as to mimic a delta stream endpoint.
connectToStorage()
getErrorTrackingService()

Constructors

FileDocumentService.(constructor)

Constructs a new instance of the FileDocumentService class

Signature:

constructor(storage: api.IDocumentStorageService, deltaStorage: FileDeltaStorageService, deltaConnection: api.IDocumentDeltaConnection);

Parameters

List of parameters
Parameter Type Description
storage api.IDocumentStorageService
deltaStorage FileDeltaStorageService
deltaConnection api.IDocumentDeltaConnection

Properties

resolvedUrl

Signature:

get resolvedUrl(): api.IResolvedUrl;

Methods

connectToDeltaStorage

Signature:

connectToDeltaStorage(): Promise<api.IDocumentDeltaStorageService>;

Returns:

Promise<api.IDocumentDeltaStorageService>

connectToDeltaStream

Connects to a delta storage endpoint of provided documentService to get ops and then replaying them so as to mimic a delta stream endpoint.

Signature:

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

Parameters

List of parameters
Parameter Type Description
client IClient Client that connects to socket.

Returns:

Promise<api.IDocumentDeltaConnection>

returns the delta stream service.

connectToStorage

Signature:

connectToStorage(): Promise<api.IDocumentStorageService>;

Returns:

Promise<api.IDocumentStorageService>

getErrorTrackingService

Signature:

getErrorTrackingService(): null;

Returns:

null