DocumentService2 Class

Packages > @fluidframework/routerlicious-driver > DocumentService2

The DocumentService manages the Socket.IO connection and manages routing requests to connected clients

Signature:

export declare class DocumentService2 extends DocumentService 

Extends: DocumentService

Constructors

List of constructors for this class
Constructor Modifiers Description
(constructor)(resolvedUrl, ordererUrl, deltaStorageUrl, gitUrl, errorTracking, disableCache, historianApi, directCredentials, tokenProvider, tenantId, documentId) Constructs a new instance of the DocumentService2 class

Methods

List of methods on this class
Method Modifiers Description
connectToDeltaStream(client) Connects to a delta stream endpoint of provided documentService so as to fire ops.

Constructors

DocumentService2.(constructor)

Constructs a new instance of the DocumentService2 class

Signature:

constructor(resolvedUrl: IResolvedUrl, ordererUrl: string, deltaStorageUrl: string, gitUrl: string, errorTracking: api.IErrorTrackingService, disableCache: boolean, historianApi: boolean, directCredentials: ICredentials | undefined, tokenProvider: ITokenProvider, tenantId: string, documentId: string);

Parameters

List of parameters
Parameter Type Description
resolvedUrl IResolvedUrl
ordererUrl string
deltaStorageUrl string
gitUrl string
errorTracking api.IErrorTrackingService
disableCache boolean
historianApi boolean
directCredentials ICredentials | undefined
tokenProvider ITokenProvider
tenantId string
documentId string

Methods

connectToDeltaStream

Connects to a delta stream endpoint of provided documentService so as to fire ops.

Signature:

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

Parameters

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

Returns:

Promise<IDocumentDeltaConnection>

returns the delta stream service.