Interface IScrollEngine<T>
Version: 3.4
Engine for scrolling.
Namespace: StylelabsStylelabs.MSdkStylelabs.M.Sdk.ContractsQuerying
Assembly: Stylelabs.M.Sdk.dll
Syntax
RequestResponse
public interface IScrollEngine<T> where T : class, IScrollResultType Parameters
| Name | Description |
|---|---|
| T |
The type of the scroll engine. |
Methods
ContinueScrollAsync(string, TimeSpan, IQueryLoadConfiguration, long)
Continues scrolling though an existing scroll.
Declaration
RequestResponse
Task<T> ContinueScrollAsync(string scrollId, TimeSpan scrollTime, IQueryLoadConfiguration loadConfiguration, long offset)Parameters
| Type | Name | Description |
|---|---|---|
| string | scrollId |
Id of the scroll. |
| TimeSpan | scrollTime |
The time to keep the scroll alive between requests. |
| IQueryLoadConfiguration | loadConfiguration |
The load configuration. |
| long | offset |
The current offset. |
Returns
| Type | Description |
|---|---|
| Task<> |
The scroll result. |
StartScrollAsync(Query, IQueryLoadConfiguration)
Does the initial setup of the scroll and returns the first batch.
Declaration
RequestResponse
Task<T> StartScrollAsync(Query query, IQueryLoadConfiguration queryLoadConfiguration)Parameters
| Type | Name | Description |
|---|---|---|
| Query | query |
The query used for scrolling. |
| IQueryLoadConfiguration | queryLoadConfiguration |
The load configuration. |
Returns
| Type | Description |
|---|---|
| Task<> |
The scroll result. |