WikiPageGeneratorTItem Class

This is preliminary documentation and is subject to change.

Represents a list-based MediaWiki generator (or sequence, see mw:API:Generator) of WikiPage.

Inheritance Hierarchy

SystemObject
  WikiClientLibrary.Generators.PrimitiveWikiListTItem
    WikiClientLibrary.Generators.PrimitiveWikiPageGeneratorTItem
      More

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

Syntax

C++

Copy

public abstract class WikiPageGenerator<TItem> : WikiList<TItem>, 
	IWikiPageGenerator

Public MustInherit Class WikiPageGenerator(Of TItem)
	Inherits WikiList(Of TItem)
	Implements IWikiPageGenerator

Dim instance As WikiPageGenerator(Of TItem)

generic<typename TItem>
public ref class WikiPageGenerator abstract : public WikiList<TItem>, 
	IWikiPageGenerator

[<AbstractClassAttribute>]
type WikiPageGenerator<'TItem> = 
    class
        inherit WikiList<'TItem>
        interface IWikiPageGenerator
    end

Type Parameters

TItem: The type of listed items.

The WikiPageGeneratorTItem type exposes the following members.

Constructors

	Name	Description
	WikiPageGeneratorTItem	Initializes a new instance of the WikiPageGeneratorTItem 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).
	GeneratorName	The name of generator, used as the value of generator parameter in action=query request.
	ListName	The name of list, used as the value of list parameter in action=query request. (Inherited from WikiListT)
	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.
	EnumItemsAsync	Asynchronously enumerates all the items in the list. (Inherited from WikiListT)
	EnumListParameters	When overridden, fills generator parameters for action=query&list={ListName} request. (Inherited from WikiListT)
	EnumPagesAsync	Asynchronously generates the sequence of pages.
	EnumPagesAsync(IWikiPageQueryProvider)	Asynchronously generates the sequence of pages.
	EnumPagesAsync(PageQueryOptions)	Asynchronously generates the sequence of pages.
	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 WikiListT)
	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). (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

Remarks

For common implementations for MediaWiki generator, prefer inheriting from WikiPageGenerator, which returns WikiPageStub for EnumItemsAsync(CancellationToken) implementation.

Reference

WikiClientLibrary.Generators.Primitive Namespace

WikiPagePropertyGeneratorTItem

Inheritance Hierarchy