| WikiListTEnumItemsAsync Method |
This is preliminary documentation and is subject to change.
Asynchronously enumerates all the items in the list.
Namespace: WikiClientLibrary.Generators.PrimitiveAssembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.8.0+bba8b7a48c3412988f4331f41f4164c670d73663
Syntax public IAsyncEnumerable<T> EnumItemsAsync(
CancellationToken cancellationToken = default
)
Public Function EnumItemsAsync (
Optional cancellationToken As CancellationToken = Nothing
) As IAsyncEnumerable(Of T)
Dim instance As WikiList
Dim cancellationToken As CancellationToken
Dim returnValue As IAsyncEnumerable(Of T)
returnValue = instance.EnumItemsAsync(cancellationToken)
public:
virtual IAsyncEnumerable<T>^ EnumItemsAsync(
CancellationToken cancellationToken = CancellationToken()
) sealed
abstract EnumItemsAsync :
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> IAsyncEnumerable<'T>
override EnumItemsAsync :
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> IAsyncEnumerable<'T>
Parameters
- cancellationToken CancellationToken (Optional)
[Missing <param name="cancellationToken"/> documentation for "M:WikiClientLibrary.Generators.Primitive.WikiList`1.EnumItemsAsync(System.Threading.CancellationToken)"]
Return Value
IAsyncEnumerableTImplements
IWikiListTEnumItemsAsync(CancellationToken)Exceptions Exception | Condition |
---|
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