WikiPagePropertyGeneratorTItem Class

This is preliminary documentation and is subject to change.

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

Inheritance Hierarchy

SystemObject
  WikiClientLibrary.Generators.PrimitiveWikiPagePropertyListTItem
    WikiClientLibrary.Generators.PrimitiveWikiPagePropertyGeneratorTItem
      WikiClientLibrary.GeneratorsCategoriesGenerator
      WikiClientLibrary.Generators.PrimitiveWikiPagePropertyGenerator
      WikiClientLibrary.GeneratorsRevisionsGenerator

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

Syntax

C++

Copy

public abstract class WikiPagePropertyGenerator<TItem> : WikiPagePropertyList<TItem>, 
	IWikiPageGenerator

Public MustInherit Class WikiPagePropertyGenerator(Of TItem)
	Inherits WikiPagePropertyList(Of TItem)
	Implements IWikiPageGenerator

Dim instance As WikiPagePropertyGenerator(Of TItem)

generic<typename TItem>
public ref class WikiPagePropertyGenerator abstract : public WikiPagePropertyList<TItem>, 
	IWikiPageGenerator

[<AbstractClassAttribute>]
type WikiPagePropertyGenerator<'TItem> = 
    class
        inherit WikiPagePropertyList<'TItem>
        interface IWikiPageGenerator
    end

Type Parameters

TItem: The type of listed items.

The WikiPagePropertyGeneratorTItem type exposes the following members.

Constructors

	Name	Description
	WikiPagePropertyGeneratorTItem(WikiSite)	Initializes a new instance of the WikiPagePropertyGeneratorTItem class
	WikiPagePropertyGeneratorTItem(WikiSite, WikiPageStub)	Initializes a new instance of the WikiPagePropertyGeneratorTItem class

Top

Properties

	Name	Description
	DistinctGeneratedPages	When using the default implementation of EnumPagesAsync(IWikiPageQueryProvider), determines whether to remove duplicate page results generated from generator results.
	GeneratorName
	PageId	Gets/sets the page ID from which to get the list-like property value. (Inherited from WikiPagePropertyListT)
	PageTitle	Gets/sets the page title from which to get the list-like property value. (Inherited from WikiPagePropertyListT)
	PaginationSize	Gets/sets maximum items returned per MediaWiki API invocation. (Inherited from WikiPagePropertyListT)
	PropertyName	Gets the name of the property, used as the value of prop parameter in action=query request. (Inherited from WikiPagePropertyListT)
	Site	Gets the MediaWiki site this instance applies to. (Inherited from WikiPagePropertyListT)

Top

Methods

	Name	Description
	EnumGeneratorParameters	Fills generator parameters for action=query&generator= request.
	EnumItemsAsync	Asynchronously enumerates all the items in the list. (Inherited from WikiPagePropertyListT)
	EnumListParameters	When overridden, fills generator parameters for action=query&prop={PropertyName} request. (Inherited from WikiPagePropertyListT)
	EnumPagesAsync	Asynchronously generate 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&prop={PropertyName} JSON response. (Inherited from WikiPagePropertyListT)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from WikiPagePropertyListT)

Top

Remarks

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

For generators, it's not necessary for the sequence taken out from EnumPagesAsync(IWikiPageQueryProvider) to be kept ordered. If you need ordered sequence, for example, enumerating the links from the beginning of an article using LinksGenerator, use EnumItemsAsync(CancellationToken).

Reference

WikiClientLibrary.Generators.Primitive Namespace

WikiPageGeneratorTItem