 | Categories |
This is preliminary documentation and is subject to change.
Gets a list of all categories used on the provided pages.
(mw:API:Categories, MediaWiki 1.11+)
Inheritance HierarchySystemObject
WikiClientLibrary.Generators.PrimitiveWikiPagePropertyListWikiPageCategoryInfo
WikiClientLibrary.Generators.PrimitiveWikiPagePropertyGeneratorWikiPageCategoryInfo
WikiClientLibrary.GeneratorsCategoriesGenerator
WikiClientLibrary.Generators.PrimitiveWikiPagePropertyListWikiPageCategoryInfo
WikiClientLibrary.Generators.PrimitiveWikiPagePropertyGeneratorWikiPageCategoryInfo
WikiClientLibrary.GeneratorsCategoriesGenerator
Namespace: WikiClientLibrary.Generators
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.8.0-int.8+f07259cca53448109bd542f6a3e53c54ddd48d58
SyntaxThe CategoriesGenerator type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CategoriesGenerator(WikiSite) | Initializes a new instance of the CategoriesGenerator class |
| CategoriesGenerator(WikiSite, WikiPageStub) | Initializes a new instance of the CategoriesGenerator class |
Properties| Name | Description | |
|---|---|---|
 | CategorySelection | Only list these categories. Useful for checking whether a certain page is in a certain category. |
 | DistinctGeneratedPages |
When using the default implementation of EnumPagesAsync(IWikiPageQueryProvider),
determines whether to remove duplicate page results generated from generator results.
(Inherited from WikiPagePropertyGeneratorTItem) |
| GeneratorName | (Inherited from WikiPagePropertyGeneratorTItem) |
| HiddenCategoryFilter | Whether to include hidden categories in the returned list. |
| PageId |
Gets/sets the page ID from which to get the list-like property value.
(Inherited from WikiPagePropertyListT) |
| PageTitle |
Gets/sets the page title from which to get the list-like property value.
(Inherited from WikiPagePropertyListT) |
| PaginationSize |
Gets/sets maximum items returned per MediaWiki API invocation.
(Inherited from WikiPagePropertyListT) |
| PropertyName |
Gets the name of the property, used as the value of prop parameter in action=query request.
(Overrides WikiPagePropertyListTPropertyName) |
| Site | Gets the MediaWiki site this instance applies to. (Inherited from WikiPagePropertyListT) |
Methods| Name | Description | |
|---|---|---|
| EnumGeneratorParameters |
Fills generator parameters for action=query&generator= request.
(Inherited from WikiPagePropertyGeneratorTItem) |
| EnumItemsAsync |
Asynchronously enumerates all the items in the list.
(Inherited from WikiPagePropertyListT) |
| EnumListParameters |
When overridden, fills generator parameters for action=query&prop={PropertyName} request.
(Overrides WikiPagePropertyListTEnumListParameters) |
| EnumPagesAsync |
Asynchronously generate the sequence of pages.
(Inherited from WikiPagePropertyGeneratorTItem) |
| EnumPagesAsync(IWikiPageQueryProvider) |
Asynchronously generates the sequence of pages.
(Inherited from WikiPagePropertyGeneratorTItem) |
| EnumPagesAsync(PageQueryOptions) |
Asynchronously generates the sequence of pages.
(Inherited from WikiPagePropertyGeneratorTItem) |
| 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 |
Parses an item contained in the action=query&prop={PropertyName} JSON response.
(Overrides WikiPagePropertyListTItemFromJson(JToken, JObject)) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from WikiPagePropertyListT) |
See Also