| WikiPageExtensionsPurgeAsync(IEnumerableWikiPage, PagePurgeOptions, CancellationToken) Method |
This is preliminary documentation and is subject to change.
Asynchronously purges a sequence of pages with the given options.
Namespace: WikiClientLibrary.PagesAssembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.9.0-int.2+447d1d590e6726b7881f750a0a0e42908f3e417e
Syntax public static Task<IReadOnlyCollection<PurgeFailureInfo>> PurgeAsync(
this IEnumerable<WikiPage> pages,
PagePurgeOptions options,
CancellationToken cancellationToken
)
<ExtensionAttribute>
Public Shared Function PurgeAsync (
pages As IEnumerable(Of WikiPage),
options As PagePurgeOptions,
cancellationToken As CancellationToken
) As Task(Of IReadOnlyCollection(Of PurgeFailureInfo))
Dim pages As IEnumerable(Of WikiPage)
Dim options As PagePurgeOptions
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of IReadOnlyCollection(Of PurgeFailureInfo))
returnValue = pages.PurgeAsync(options,
cancellationToken)
public:
[ExtensionAttribute]
static Task<IReadOnlyCollection<PurgeFailureInfo^>^>^ PurgeAsync(
IEnumerable<WikiPage^>^ pages,
PagePurgeOptions options,
CancellationToken cancellationToken
)
[<ExtensionAttribute>]
static member PurgeAsync :
pages : IEnumerable<WikiPage> *
options : PagePurgeOptions *
cancellationToken : CancellationToken -> Task<IReadOnlyCollection<PurgeFailureInfo>>
Parameters
- pages IEnumerableWikiPage
[Missing <param name="pages"/> documentation for "M:WikiClientLibrary.Pages.WikiPageExtensions.PurgeAsync(System.Collections.Generic.IEnumerable{WikiClientLibrary.Pages.WikiPage},WikiClientLibrary.Pages.PagePurgeOptions,System.Threading.CancellationToken)"]
- options PagePurgeOptions
[Missing <param name="options"/> documentation for "M:WikiClientLibrary.Pages.WikiPageExtensions.PurgeAsync(System.Collections.Generic.IEnumerable{WikiClientLibrary.Pages.WikiPage},WikiClientLibrary.Pages.PagePurgeOptions,System.Threading.CancellationToken)"]
- cancellationToken CancellationToken
[Missing <param name="cancellationToken"/> documentation for "M:WikiClientLibrary.Pages.WikiPageExtensions.PurgeAsync(System.Collections.Generic.IEnumerable{WikiClientLibrary.Pages.WikiPage},WikiClientLibrary.Pages.PagePurgeOptions,System.Threading.CancellationToken)"]
Return Value
TaskIReadOnlyCollectionPurgeFailureInfoA collection of pages that haven't been successfully purged, because of either missing or invalid titles.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
IEnumerableWikiPage. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
See Also