RevisionsGenerator Class

This is preliminary documentation and is subject to change.

Enumerates the sequence of revisions on a specific MediaWiki page. (mw:API:Revisions, MediaWiki 1.8+)

Inheritance Hierarchy

SystemObject
  WikiClientLibrary.Generators.PrimitiveWikiPagePropertyListRevision
    WikiClientLibrary.Generators.PrimitiveWikiPagePropertyGeneratorRevision
      WikiClientLibrary.GeneratorsRevisionsGenerator

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

Syntax

C++

Copy

public class RevisionsGenerator : WikiPagePropertyGenerator<Revision>

Public Class RevisionsGenerator
	Inherits WikiPagePropertyGenerator(Of Revision)

Dim instance As RevisionsGenerator

public ref class RevisionsGenerator : public WikiPagePropertyGenerator<Revision^>

type RevisionsGenerator = 
    class
        inherit WikiPagePropertyGenerator<Revision>
    end

The RevisionsGenerator type exposes the following members.

Constructors

	Name	Description
	RevisionsGenerator(WikiSite)	Initializes a new instance of the RevisionsGenerator class
	RevisionsGenerator(WikiSite, WikiPageStub)	Initializes a new instance of the RevisionsGenerator 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 WikiPagePropertyGeneratorTItem)
	EndRevisionId	Revision ID to stop listing at.
	EndTime	The timestamp to end listing at.
	ExcludedUserName	Do not list revisions made by this user.
	GeneratorName	(Inherited from WikiPagePropertyGeneratorTItem)
	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. (Overrides WikiPagePropertyListTPropertyName)
	PropertyProvider	Gets/sets the page query options for EnumItemsAsync(CancellationToken)
	Site	Gets the MediaWiki site this instance applies to. (Inherited from WikiPagePropertyListT)
	StartRevisionId	Revision ID to start listing from.
	StartTime	The timestamp to start listing from.
	TimeAscending	Whether to list revisions in an ascending order of time.
	UserName	Only list revisions made by this user.

Top

Methods

	Name	Description
	EnumGeneratorParameters	Fills generator parameters for action=query&generator= request. (Inherited from WikiPagePropertyGeneratorTItem)
	EnumItemsAsync	Asynchronously enumerates all the items in the list. (Inherited from WikiPagePropertyListT)
	EnumListParameters	When overridden, fills generator parameters for action=query&prop={PropertyName} request. (Overrides WikiPagePropertyListTEnumListParameters)
	EnumPagesAsync	Infrastructure. Not intended to be used directly in your code. Asynchronously enumerates the pages from generator. (Overrides WikiPagePropertyGeneratorTItemEnumPagesAsync)
	EnumPagesAsync(IWikiPageQueryProvider)	Infrastructure. Not intended to be used directly in your code. Asynchronously enumerates the pages from generator. (Overrides WikiPagePropertyGeneratorTItemEnumPagesAsync(IWikiPageQueryProvider))
	EnumPagesAsync(PageQueryOptions)	Infrastructure. Not intended to be used directly in your code. Asynchronously enumerates the pages from generator. (Overrides WikiPagePropertyGeneratorTItemEnumPagesAsync(PageQueryOptions))
	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 WikiPagePropertyListTItemFromJson(JToken, JObject))
	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

The prop=revisions module has been implemented as RevisionsPropertyProvider and RevisionsGenerator. The former allows you to fetch for the latest revisions for multiple pages, while the latter allows you to enumerate the revisions of a single page.

Reference

WikiClientLibrary.Generators Namespace