Click or drag to resize

WikiListTEnumItemsAsync Method

This is preliminary documentation and is subject to change.

Asynchronously enumerates all the items in the list.

Namespace: WikiClientLibrary.Generators.Primitive
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.8.0+bba8b7a48c3412988f4331f41f4164c670d73663
Syntax
public IAsyncEnumerable<T> EnumItemsAsync(
	CancellationToken cancellationToken = default
)

Parameters

cancellationToken  CancellationToken  (Optional)

[Missing <param name="cancellationToken"/> documentation for "M:WikiClientLibrary.Generators.Primitive.WikiList`1.EnumItemsAsync(System.Threading.CancellationToken)"]

Return Value

IAsyncEnumerableT

Implements

IWikiListTEnumItemsAsync(CancellationToken)
Exceptions
ExceptionCondition
OperationFailedException (When enumerating) There is any MediaWiki API failure during the operation.
Exception (When enumerating) There can be other types of errors thrown. See the respective OnEnumItemsFailed(Exception) override documentations in the implementation classes.
Remarks
In most cases, the whole sequence will be very long. To take only the top n results from the sequence, chain the returned IAsyncEnumerableT with Take``1(IAsyncEnumerableUMP, Int32) extension method.
See Also