Interface IScrollEngine<T>

Current version: 4.0

Engine for scrolling.

Namespace: StylelabsStylelabs.MSdkStylelabs.M.Sdk.ContractsQuerying
Assembly: Stylelabs.M.Sdk.dll
Syntax
RequestResponse
public interface IScrollEngine<T> where T : class, IScrollResult
Type Parameters
NameDescription
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
TypeNameDescription
stringscrollId

Id of the scroll.

TimeSpanscrollTime

The time to keep the scroll alive between requests.

IQueryLoadConfigurationloadConfiguration

The load configuration.

longoffset

The current offset.

Returns
TypeDescription
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
TypeNameDescription
Queryquery

The query used for scrolling.

IQueryLoadConfigurationqueryLoadConfiguration

The load configuration.

Returns
TypeDescription
Task<>

The scroll result.

Do you have some feedback for us?

If you have suggestions for improving this article,