Class LoadingQueryIteratorBase<T>

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

Base implementation for Query iterators that support loading of entities.

Inheritance
System.Object
LoadingQueryIteratorBase<T>
Implements
Namespace: Stylelabs.M.Sdk.Models.Querying
Assembly: Stylelabs.M.Sdk.dll
Syntax
public abstract class LoadingQueryIteratorBase<T> : object, IQueryIterator<T>, IIterator where T : class, IQueryResult
Type Parameters
NameDescription
T

The type result returned by the iterator.

Constructors

LoadingQueryIteratorBase(Query, IEntityLoadConfiguration)

Initializes a new instance of the class. Optionally, you can pass a current result, and the iterator will continue from that point on.

Declaration
protected LoadingQueryIteratorBase(Query query, IEntityLoadConfiguration loadConfiguration)
Parameters
TypeNameDescription
Queryquery

The 'request' query.

IEntityLoadConfigurationloadConfiguration

LoadingQueryIteratorBase(Query, IEntityLoadConfiguration, T)

Declaration
protected LoadingQueryIteratorBase(Query query, IEntityLoadConfiguration loadConfiguration, T result)
Parameters
TypeNameDescription
Queryquery
IEntityLoadConfigurationloadConfiguration
Tresult

Properties

Current

Get the current result during iteration.

Declaration
public T Current { get; }
Property Value
TypeDescription
T

Methods

CanMoveNext()

Checks if the iterator can move further through the results.

Declaration
public bool CanMoveNext()
Returns
TypeDescription
System.Boolean

true if there more results.

CanMovePrevious()

Checks if the iterator can move backwards through the results.

Declaration
public bool CanMovePrevious()
Returns
TypeDescription
System.Boolean

true if there move backwards.

GetResultAsync(Query, IEntityLoadConfiguration)

Declaration
protected abstract Task<T> GetResultAsync(Query query, IEntityLoadConfiguration loadConfiguration)
Parameters
TypeNameDescription
Queryquery
IEntityLoadConfigurationloadConfiguration
Returns
TypeDescription
Task<T>

MoveNextAsync()

Advances the enumerator to the next page/batch of the collection. The result will be available in Current.

Declaration
public Task<bool> MoveNextAsync()
Returns
TypeDescription
Task<System.Boolean>

true if the enumerator was successfully advanced to the next page; false if the enumerator has passed the end of the collection.

MovePreviousAsync()

Moves the enumerator backwards, to the previous page/batch of the collection. The result will be available in Current.

Declaration
public Task<bool> MovePreviousAsync()
Returns
TypeDescription
Task<System.Boolean>

true if the enumerator was successfully advanced to the previous page; false if the enumerator has passed the start of the collection.

Reset()

Resets the iterator to start before the first result again.

Declaration
public void Reset()

Explicit Interface Implementations

IIterator.Current

The current result. This is initially null. Use MoveNextAsync() first.

Declaration
object IIterator.Current { get; }
Returns
TypeDescription
System.Object

Implements

この記事を改善するための提案がある場合は、 お知らせください!