Interface IIterator
Base interface for iterators.
Namespace: StylelabsStylelabs.MSdkStylelabs.M.Sdk.ContractsBase
Assembly: Stylelabs.M.Sdk.dll
Syntax
Properties
Current
Gets the current result. This is initially null. Use MoveNextAsync() first.
Declaration
Property Value
| Type | Description |
|---|---|
| object |
Methods
CanMoveNext()
Checks if the iterator can move further through the results.
Declaration
Returns
| Type | Description |
|---|---|
| bool | true if there more results. |
CanMovePrevious()
Checks if the iterator can move backwards through the results.
Declaration
Returns
| Type | Description |
|---|---|
| bool | true if there move backwards. |
MoveNextAsync()
Advances the enumerator to the next page/batch of the collection. The result will be available in Current.
Declaration
Returns
| Type | Description |
|---|---|
| Task<>bool | 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
Returns
| Type | Description |
|---|---|
| Task<>bool | 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
If you have suggestions for improving this article, let us know!