WikiPageGenerator Class

This is preliminary documentation and is subject to change.

The base classes for commonly-used WikiPage generator that implements WikiPageGeneratorTItem, where TItem is WikiPageStub.

Inheritance Hierarchy

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

Syntax

C++

Copy

public abstract class WikiPageGenerator : WikiPageGenerator<WikiPageStub>

Public MustInherit Class WikiPageGenerator
	Inherits WikiPageGenerator(Of WikiPageStub)

Dim instance As WikiPageGenerator

public ref class WikiPageGenerator abstract : public WikiPageGenerator<WikiPageStub>

[<AbstractClassAttribute>]
type WikiPageGenerator = 
    class
        inherit WikiPageGenerator<WikiPageStub>
    end

The WikiPageGenerator type exposes the following members.

Constructors

	Name	Description
	WikiPageGenerator	Initializes a new instance of the WikiPageGenerator 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. (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. (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. (Inherited from WikiListT)
	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. (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). (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 a more generic implementations for MediaWiki generator, or implementations returning sequence where the item type is not WikiPageStub, please derive your generator from WikiPageGeneratorTItem.

Reference

WikiClientLibrary.Generators.Primitive Namespace

Inheritance Hierarchy