IDocumentService Interface
Packages > @fluidframework/driver-definitions > IDocumentService
Signature:
export interface IDocumentService
Properties
| Property | Type | Description |
|---|---|---|
| resolvedUrl | IResolvedUrl |
Methods
| Method | Description |
|---|---|
| branch() | Creates a branch of the document with the given ID. Returns the new ID. |
| 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
resolvedUrl
Signature:
resolvedUrl: IResolvedUrl;
Methods
branch
Creates a branch of the document with the given ID. Returns the new ID.
Signature:
branch(): Promise<string>;
Returns:
Promise<string>
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
| 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