IDeltaStorageService Interface

Interface to provide access to stored deltas for a shared object

Signature

export interface IDeltaStorageService

Methods

Method	Return Type	Description
get(tenantId, id, from, to, fetchReason)	Promise<IDeltasFetchResult>	Retrieves all the delta operations within the inclusive sequence number range

Method Details

get

Retrieves all the delta operations within the inclusive sequence number range

Signature

get(tenantId: string, id: string, from: number, // inclusive
    to: number, // exclusive
    fetchReason?: string): Promise<IDeltasFetchResult>;

Parameters

Parameter	Modifiers	Type	Description
tenantId		string	Id of the tenant.
id		string	document id.
from		number	first op to retrieve (inclusive)
to		number	first op not to retrieve (exclusive end)
fetchReason	optional	string	Reason for fetching the messages. Example, gap between seq number of Op on wire and known seq number. It should not contain any PII. It can be logged by spo which could help in debugging sessions if any issue occurs.

Returns

Return type: Promise<IDeltasFetchResult>