WikiPagePropertyGenerator Class

This is preliminary documentation and is subject to change.

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

Inheritance Hierarchy

System.Object
  WikiClientLibrary.Generators.Primitive.WikiPagePropertyList<WikiPageStub>
    WikiClientLibrary.Generators.Primitive.WikiPagePropertyGenerator<WikiPageStub>
      WikiClientLibrary.Generators.Primitive.WikiPagePropertyGenerator
        WikiClientLibrary.Generators.FilesGenerator
        WikiClientLibrary.Generators.LinksGenerator
        WikiClientLibrary.Generators.TransclusionsGenerator

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

Syntax

C++

Copy

public abstract class WikiPagePropertyGenerator : WikiPagePropertyGenerator<WikiPageStub>

Public MustInherit Class WikiPagePropertyGenerator
	Inherits WikiPagePropertyGenerator(Of WikiPageStub)

Dim instance As WikiPagePropertyGenerator

public ref class WikiPagePropertyGenerator abstract : public WikiPagePropertyGenerator<WikiPageStub>

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

The WikiPagePropertyGenerator type exposes the following members.

Constructors

	Name	Description
	WikiPagePropertyGenerator(WikiSite)	Initializes a new instance of the WikiPagePropertyGenerator class
	WikiPagePropertyGenerator(WikiSite, WikiPageStub)	Initializes a new instance of the WikiPagePropertyGenerator 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. (Inherited from WikiPagePropertyGenerator<TItem>)
	GeneratorName	(Inherited from WikiPagePropertyGenerator<TItem>)
	PageId	Gets/sets the page ID from which to get the list-like property value. (Inherited from WikiPagePropertyList<T>)
	PageTitle	Gets/sets the page title from which to get the list-like property value. (Inherited from WikiPagePropertyList<T>)
	PaginationSize	Gets/sets maximum items returned per MediaWiki API invocation. (Inherited from WikiPagePropertyList<T>)
	PropertyName	Gets the name of the property, used as the value of prop parameter in action=query request. (Inherited from WikiPagePropertyList<T>)
	Site	Gets the MediaWiki site this instance applies to. (Inherited from WikiPagePropertyList<T>)

Top

Methods

	Name	Description
	EnumGeneratorParameters	Fills generator parameters for action=query&generator= request. (Inherited from WikiPagePropertyGenerator<TItem>)
	EnumItemsAsync	Asynchronously enumerates all the items in the list. (Inherited from WikiPagePropertyList<T>)
	EnumListParameters	When overridden, fills generator parameters for action=query&prop={PropertyName} request. (Inherited from WikiPagePropertyList<T>)
	EnumPagesAsync()	Asynchronously generate the sequence of pages. (Inherited from WikiPagePropertyGenerator<TItem>)
	EnumPagesAsync(IWikiPageQueryProvider)	Asynchronously generates the sequence of pages. (Inherited from WikiPagePropertyGenerator<TItem>)
	EnumPagesAsync(PageQueryOptions)	Asynchronously generates the sequence of pages. (Inherited from WikiPagePropertyGenerator<TItem>)
	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. (Overrides WikiPagePropertyList<T>.ItemFromJson(JsonNode, JsonObject))
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from WikiPagePropertyList<T>)

Top

Remarks

For a more generic implementations for page-property-based MediaWiki generator, or implementations returning a sequence where the item type is not WikiPageStub, please derive your generator from WikiPagePropertyGenerator<TItem>.

Reference

WikiClientLibrary.Generators.Primitive Namespace