logo
logo
  • Interface IScrollEngine<T>

    Engine for scrolling.

    Namespace: Stylelabs.M.Sdk.Contracts.Querying
    Assembly: Stylelabs.M.Sdk.dll
    Syntax
    public interface IScrollEngine<T>
    
        where T : class, IScrollResult
    Type Parameters
    Name Description
    T

    Methods

    ContinueScrollAsync(String, TimeSpan, IQueryLoadConfiguration, Int64)

    Continues scrolling though an existing scroll.

    Declaration
    Task<T> ContinueScrollAsync(string scrollId, TimeSpan scrollTime, IQueryLoadConfiguration loadConfiguration, long offset)
    Parameters
    Type Name Description
    System.String scrollId

    Id of the scroll.

    TimeSpan scrollTime

    The time to keep the scroll alive between requests.

    IQueryLoadConfiguration loadConfiguration
    System.Int64 offset

    The current offset.

    Returns
    Type Description
    Task<T>

    The scroll result

    StartScrollAsync(Query, IQueryLoadConfiguration)

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

    Declaration
    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<T>

    The scroll result

    Can we improve this article ? Provide feedback