Click or drag to resize

RecentChangesGenerator Class

This is preliminary documentation and is subject to change.

Generates all recent changes to the wiki, à la Special:Recentchanges.
Inheritance Hierarchy

Namespace: WikiClientLibrary.Generators
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.8.0-int.8+f07259cca53448109bd542f6a3e53c54ddd48d58
Syntax
public class RecentChangesGenerator : WikiPageGenerator<RecentChangeItem>

The RecentChangesGenerator type exposes the following members.

Constructors
 NameDescription
Public methodRecentChangesGeneratorInitializes a new instance of the RecentChangesGenerator class
Top
Properties
 NameDescription
Public propertyAnonymousFilter Whether to list edits by anonymous users.
Public propertyBotFilter Whether to list bot edits.
Public propertyCompatibilityOptions Gets/sets the compatibility options used with this list.
(Inherited from WikiListT)
Protected propertyDistinctGeneratedPages 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).
(Overrides WikiPageGeneratorTItemDistinctGeneratedPages)
Public propertyEndTime The timestamp to end listing at.
Public propertyExcludedUserName Do not list changes made by this user.
Public propertyGeneratorName The name of generator, used as the value of generator parameter in action=query request.
(Inherited from WikiPageGeneratorTItem)
Public propertyLastRevisionsOnly Only list changes which are the latest revision.
Public propertyListName The name of list, used as the value of list parameter in action=query request.
(Overrides WikiListTListName)
Public propertyMinorFilter Whether to list minor edits.
Public propertyNamespaceIds Only list pages in these namespaces.
Public propertyPaginationSize Gets/sets maximum items returned per MediaWiki API invocation.
(Inherited from WikiListT)
Public propertyPatrolledFilter Whether to list edits flagged as patrolled. Only available to users with the patrol right.
Public propertyRedirectsFilter Whether to list edits to pages that are currently redirects.
Public propertySiteGets the MediaWiki site this instance applies to.
(Inherited from WikiListT)
Public propertyStartTime The timestamp to start listing from. (May not be more than $wgRCMaxAge into the past, which on Wikimedia wikis is 30 days.)
Public propertyTag Only list changes tagged with this tag.
Public propertyTimeAscending Whether to list pages in an ascending order of time. (Default: false)
Public propertyTypeFilters Only list certain types of changes.
Public propertyUserName Only list changes made by this user.
Top
Methods
 NameDescription
Public methodEnumGeneratorParameters Fills generator parameters for action=query&generator= request.
(Overrides WikiPageGeneratorTItemEnumGeneratorParameters)
Public methodEnumItemsAsync Asynchronously enumerates all the items in the list.
(Inherited from WikiListT)
Public methodEnumListParameters When overridden, fills generator parameters for action=query&list={ListName} request.
(Overrides WikiListTEnumListParameters)
Public methodEnumPagesAsync Asynchronously generates the sequence of pages.
(Inherited from WikiPageGeneratorTItem)
Public methodEnumPagesAsync(IWikiPageQueryProvider) Asynchronously generates the sequence of pages.
(Inherited from WikiPageGeneratorTItem)
Public methodEnumPagesAsync(PageQueryOptions) Asynchronously generates the sequence of pages.
(Inherited from WikiPageGeneratorTItem)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodItemFromJson Parses an item contained in the action=query&list= JSON response.
(Overrides WikiListTItemFromJson(JToken))
Protected methodItemsFromResponse 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)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnEnumItemsFailed When overriden, called when there is exception raised when executing the asynchronous generator function inside EnumItemsAsync(CancellationToken).
(Inherited from WikiListT)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
See Also