IDocumentDeltaStorageService Interface
Interface to provide access to stored deltas for a shared object
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/driver-definitions/legacy.
For more information about our API support guarantees, see here.
Signature
export interface IDocumentDeltaStorageService
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| fetchMessages(from, to, abortSignal, cachedOnly, fetchReason) | Beta | IStream<ISequencedDocumentMessage[]> | Retrieves all the delta operations within the exclusive sequence number range |
Method Details
fetchMessages
Retrieves all the delta operations within the exclusive sequence number range
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
fetchMessages(from: number, to: number | undefined, abortSignal?: AbortSignal, cachedOnly?: boolean, fetchReason?: string): IStream<ISequencedDocumentMessage[]>;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| from | number | first op to retrieve (inclusive) | |
| to | number | undefined | first op not to retrieve (exclusive end) | |
| abortSignal | optional | AbortSignal | signal that aborts operation |
| cachedOnly | optional | boolean | return only cached ops, i.e. ops available locally on client. |
| fetchReason | optional | string | Reason for fetching the messages, for logging. Example, gap between seq number of Op on wire and known seq number. It can be logged by spo which could help in debugging sessions if any issue occurs. |
Returns
Return type: IStream<ISequencedDocumentMessage[]>