 | Pages |
This is preliminary documentation and is subject to change.
List all pages using a given page property.
Inheritance HierarchySystemObject
WikiClientLibrary.Generators.PrimitiveWikiListPagesWithPropResultItem
WikiClientLibrary.Generators.PrimitiveWikiPageGeneratorPagesWithPropResultItem
WikiClientLibrary.GeneratorsPagesWithPropGenerator
WikiClientLibrary.Generators.PrimitiveWikiListPagesWithPropResultItem
WikiClientLibrary.Generators.PrimitiveWikiPageGeneratorPagesWithPropResultItem
WikiClientLibrary.GeneratorsPagesWithPropGenerator
Namespace: WikiClientLibrary.Generators
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.9.0-int.2+447d1d590e6726b7881f750a0a0e42908f3e417e
SyntaxThe PagesWithPropGenerator type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PagesWithPropGenerator | Initializes a new instance of the PagesWithPropGenerator class |
Properties| Name | Description | |
|---|---|---|
 | CompatibilityOptions |
Gets/sets the compatibility options used with this list.
(Inherited from WikiListT) |
 | DistinctGeneratedPages |
When using the default implementation of EnumPagesAsync(IWikiPageQueryProvider),
determines whether to remove duplicate page results generated from generator results.
This property does not affect the behavior of EnumItemsAsync(CancellationToken).
(Inherited from WikiPageGeneratorTItem) |
| GeneratorName |
The name of generator, used as the value of generator parameter in action=query request.
(Inherited from WikiPageGeneratorTItem) |
| ListName | (Overrides WikiListTListName) |
| OrderDescending | Gets/sets a value that indicates whether the links should be listed in the descending order. (MediaWiki 1.19+) |
| PaginationSize |
Gets/sets maximum items returned per MediaWiki API invocation.
(Inherited from WikiListT) |
| PropertyName | Page property for which to enumerate pages. |
| Site | Gets the MediaWiki site this instance applies to. (Inherited from WikiListT) |
Methods| Name | Description | |
|---|---|---|
| EnumGeneratorParameters |
Fills generator parameters for action=query&generator= request.
(Inherited from WikiPageGeneratorTItem) |
| EnumItemsAsync |
Asynchronously enumerates all the items in the list.
(Inherited from WikiListT) |
| EnumListParameters | (Overrides WikiListTEnumListParameters) |
| EnumPagesAsync |
Asynchronously generates the sequence of pages.
(Inherited from WikiPageGeneratorTItem) |
| EnumPagesAsync(IWikiPageQueryProvider) |
Asynchronously generates the sequence of pages.
(Inherited from WikiPageGeneratorTItem) |
| EnumPagesAsync(PageQueryOptions) |
Asynchronously generates the sequence of pages.
(Inherited from WikiPageGeneratorTItem) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| ItemFromJson | (Overrides WikiListTItemFromJson(JsonNode)) |
| ItemsFromResponse |
From the given MediaWiki API response of the MediaWiki list request,
locates the array of items whose items will be processed by ItemFromJson(JsonNode).
(Inherited from WikiListT) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnEnumItemsFailed |
When overriden, called when there is exception raised when
executing the asynchronous generator function inside EnumItemsAsync(CancellationToken).
(Inherited from WikiListT) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
See Also