QueryPageGenerator Class

This is preliminary documentation and is subject to change.

Get a list provided by a QueryPage-based special page. (MediaWiki 1.18)

Inheritance Hierarchy

SystemObject
  WikiClientLibrary.Generators.PrimitiveWikiListQueryPageResultItem
    WikiClientLibrary.Generators.PrimitiveWikiPageGeneratorQueryPageResultItem
      WikiClientLibrary.GeneratorsQueryPageGenerator

Namespace: WikiClientLibrary.Generators
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.8.0-int.8+f07259cca53448109bd542f6a3e53c54ddd48d58

Syntax

C++

Copy

public class QueryPageGenerator : WikiPageGenerator<QueryPageResultItem>

Public Class QueryPageGenerator
	Inherits WikiPageGenerator(Of QueryPageResultItem)

Dim instance As QueryPageGenerator

public ref class QueryPageGenerator : public WikiPageGenerator<QueryPageResultItem^>

type QueryPageGenerator = 
    class
        inherit WikiPageGenerator<QueryPageResultItem>
    end

The QueryPageGenerator type exposes the following members.

Constructors

	Name	Description
	QueryPageGenerator(WikiSite)	Initializes a new instance of the QueryPageGenerator class
	QueryPageGenerator(WikiSite, String)	Initializes a new instance of the QueryPageGenerator class

Top

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	The name of list, used as the value of list parameter in action=query request. (Overrides WikiListTListName)
	PaginationSize	Gets/sets maximum items returned per MediaWiki API invocation. (Inherited from WikiListT)
	QueryPageName	Gets/sets the name of the special page. The name is case sensitive.
	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)
	GetQueryPageNamesAsync	Asynchronously get a list of available QueryPage-based special pages. The item in the list can later be used as a value of QueryPageName.
	GetQueryPageNamesAsync(WikiSite)	Asynchronously get a list of available QueryPage-based special pages. The item in the list can later be used as a value of QueryPageName.
	GetQueryPageResultInfoAsync	Retrieve the basic information of the result set of the currently specified MediaWiki query page.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	ItemFromJson	Parses an item contained in the action=query&list= JSON response. (Overrides WikiListTItemFromJson(JToken))
	ItemsFromResponse	From the given MediaWiki API response of the MediaWiki list request, locates the array of items whose items will be processed by ItemFromJson(JToken). (Overrides WikiListTItemsFromResponse(JToken))
	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. (Overrides ObjectToString)

Top

Remarks

For a list of available query pages, See mw:API:Querypage. You can also invoke GetQueryPageNamesAsync to ask for the list in the runtime.

Not all types of query pages yield list of page titles (e.g., GadgetUsage or MediaStatistics). Invoking EnumPagesAsync may yield pages that does not actually exist. In this case, consider using EnumItemsAsync(CancellationToken) instead.

Reference

WikiClientLibrary.Generators Namespace