Click or drag to resize

RandomPageGenerator Class

This is preliminary documentation and is subject to change.

Gets random pages in a specific namespace. (mw:API:Random, MediaWiki 1.12+)
Inheritance Hierarchy

Namespace: WikiClientLibrary.Generators
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.8.0-int.8+f07259cca53448109bd542f6a3e53c54ddd48d58
Syntax
Copy
public class RandomPageGenerator : WikiPageGenerator

The RandomPageGenerator type exposes the following members.

Constructors
 NameDescription
Public methodRandomPageGeneratorInitializes a new instance of the RandomPageGenerator class
Top
Properties
 NameDescription
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).
(Inherited from WikiPageGeneratorTItem)
Public propertyGeneratorName The name of generator, used as the value of generator parameter in action=query request.
(Inherited from WikiPageGeneratorTItem)
Public propertyListName The name of list, used as the value of list parameter in action=query request.
(Overrides WikiListTListName)
Public propertyNamespaceIds Only list pages in these namespaces.
Public propertyPaginationSize Gets/sets maximum items returned per MediaWiki API invocation.
(Inherited from WikiListT)
Public propertyRedirectsFilter How to filter redirects.
Public propertySiteGets the MediaWiki site this instance applies to.
(Inherited from WikiListT)
Top
Methods
 NameDescription
Public methodEnumGeneratorParameters Fills generator parameters for action=query&generator= request.
(Inherited from WikiPageGeneratorTItem)
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 WikiPageGeneratorItemFromJson(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
Remarks
The max allowed PaginationSize is 10 for regular users, and 20 for users with the apihighlimits right (typically in bot or sysop group).
See Also