Interface IScrollEngine

Engine for scrolling.

Namespace: StylelabsStylelabs.MSdkStylelabs.M.Sdk.ContractsQuerying

public interface IScrollEngine<T> where T : class, IScrollResult

Name	Description
T	The type of the scroll engine.

Continues scrolling though an existing scroll.

Task<T> ContinueScrollAsync(string scrollId, TimeSpan scrollTime, IQueryLoadConfiguration loadConfiguration, long offset)

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.

Type	Description
Task<>	The scroll result.

Does the initial setup of the scroll and returns the first batch.

Task<T> StartScrollAsync(Query query, IQueryLoadConfiguration queryLoadConfiguration)

Type	Name	Description
Query	query	The query used for scrolling.
IQueryLoadConfiguration	queryLoadConfiguration	The load configuration.

Type	Description
Task<>	The scroll result.

If you have suggestions for improving this article, let us know!