WikiClientLibrary.Generators Namespace

This is preliminary documentation and is subject to change.

This namespace contains the implementations for various MediaWiki lists and generators.

Classes

	Class	Description
	AllCategoriesGenerator	Generates all the categories with or without description pages.
	AllPagesGenerator	Generates all the pages in a specific namespace.
	BacklinksGenerator	Generates all the pages that links to the specified title (not transclusion). (aka. what-links-here)
	CategoriesGenerator	Gets a list of all categories used on the provided pages. (mw:API:Categories, MediaWiki 1.11+)
	CategoryMembersGenerator	List of pages that belong to a given category, ordered by page sort title.
	FilesGenerator	Generates pages from all used files on the provided page. (mw:API:Links, MediaWiki 1.11+)
	FileUsageGenerator	Generates all the pages that transclude the specified file.
	GeoSearchGenerator	Searches for articles around the given point (determined either by coordinates or by article name). (mw:Extension:GeoData#prop=coordinates)
	GeoSearchResultItem	An item in the GeoSearch result.
	LinksGenerator	Generates pages from all links on the provided page. (mw:API:Links, MediaWiki 1.11+)
	LogActions	Predefined Log Action values used in Action.
	LogEventItem	Represents an MediaWiki log event entry.
	LogEventsList	Get a list of all logged events, à la Special:Log.
	LogParameterCollection	A collection of extensible log parameters.
	LogTypes	Predefined Log Type values used in Type.
	MyWatchlistGenerator	Get all pages on the current user's watchlist.
	MyWatchlistResultItem
	PagesWithPropGenerator	List all pages using a given page property. The list of available properties can be found at action=query&list=pagepropnames.
	PagesWithPropResultItem
	QueryPageGenerator	Get a list provided by a QueryPage-based special page. (MediaWiki 1.18)
	QueryPageResultInfo	Contains the basic information of a specific MediaWiki query page result set.
	QueryPageResultItem
	RandomPageGenerator	Gets random pages in a specific namespace. (mw:API:Random, MediaWiki 1.12+)
	RecentChangeItem	Represents MediaWiki recent change entry.
	RecentChangesGenerator	Generates all recent changes to the wiki, à la Special:Recentchanges.
	RevisionsGenerator	Enumerates the sequence of revisions on a specific MediaWiki page. (mw:API:Revisions, MediaWiki 1.8+)
	SearchGenerator	Search for the pages matching the specific keywords in titles and text. (mw:API:Search, MediaWiki 1.11+)
	SearchResultItem	Represents an item in the search result.
	TranscludedInGenerator	Generates all the pages that transclude the specified title.
	TransclusionsGenerator	Generates pages from all pages (typically templates) transcluded in the provided page. (mw:API:Templates, MediaWiki 1.11+)
	WikiPageExtensions	Extension method for constructing generators from WikiPage.

Enumerations

	Enumeration	Description
	CategoryMemberTypes	Types of category members.
	LogEventHiddenFields	Represents a possible set of fields that can be hidden by "suppress" or "oversight" group.
	PatrolStatus	Values indicating whether the specific change has been patrolled.
	PropertyFilterOption	Determines whether a page with/without certain specific property should be included in the list.
	RecentChangesFilterTypes	Types of recent changes. Used in RecentChangesGenerator.
	RecentChangesType	Types of recent changes. Used in RecentChangeItem.
	SearchableField	Used in MatchingField.

Remarks

MediaWiki lists and generators allows you to enumerate through all the pages or other item sequence, with pagination support. In Wiki Client Library, these functionalities are implemented using IAsyncEnumerableT from Ix.Async package.

For basic concepts on MediaWiki lists and generators, see mw:API:Lists and mw:API:Generator.

The inheritance diagram of generator classes in this namespace is as follows