CategoryMembersGenerator Class

This is preliminary documentation and is subject to change.

List of pages that belong to a given category, ordered by page sort title.

Inheritance Hierarchy

SystemObject
  WikiClientLibrary.Generators.PrimitiveWikiListWikiPageStub
    WikiClientLibrary.Generators.PrimitiveWikiPageGeneratorWikiPageStub
      WikiClientLibrary.Generators.PrimitiveWikiPageGenerator
        WikiClientLibrary.GeneratorsCategoryMembersGenerator

Namespace: WikiClientLibrary.Generators
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.9.0-int.2+447d1d590e6726b7881f750a0a0e42908f3e417e

Syntax

C++

Copy

public class CategoryMembersGenerator : WikiPageGenerator

Public Class CategoryMembersGenerator
	Inherits WikiPageGenerator

Dim instance As CategoryMembersGenerator

public ref class CategoryMembersGenerator : public WikiPageGenerator

type CategoryMembersGenerator = 
    class
        inherit WikiPageGenerator
    end

The CategoryMembersGenerator type exposes the following members.

Constructors

	Name	Description
	CategoryMembersGenerator(WikiPage)	Initializes CategoryTitle from specified WikiPage .
	CategoryMembersGenerator(WikiSite)	Initializes a new instance of the CategoryMembersGenerator class
	CategoryMembersGenerator(WikiSite, String)	Initializes a new instance of the CategoryMembersGenerator class

Top

Properties

	Name	Description
	CategoryTitle	The category to enumerate (required unless cmpageid is used). Must include "Category:" prefix. Cannot be used together with cmpageid.
	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	The name of list, used as the value of list parameter in action=query request. (Overrides WikiListTListName)
	MemberTypes	Type of category members to include. Ignored when cmsort=timestamp is set.
	NamespaceIds	Only list pages in these namespaces.
	PaginationSize	Gets/sets maximum items returned per MediaWiki API invocation. (Inherited from WikiListT)
	Site	Gets the MediaWiki site this instance applies to. (Inherited from WikiListT)

Top

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	When overridden, fills generator parameters for action=query&list={ListName} request. (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	Parses an item contained in the action=query&list= JSON response. (Inherited from WikiPageGenerator)
	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)

Top

Reference

WikiClientLibrary.Generators Namespace