WikiListT Class

This is preliminary documentation and is subject to change.

Represents a configured MediaWiki list. (mw:API:Lists)

Inheritance Hierarchy

SystemObject
  WikiClientLibrary.Generators.PrimitiveWikiListT
    WikiClientLibrary.AbuseFiltersAbuseFilterList
    WikiClientLibrary.GeneratorsLogEventsList
    WikiClientLibrary.Generators.PrimitiveWikiPageGeneratorTItem

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

Syntax

C++

Copy

public abstract class WikiList<T> : IWikiList<T>

Public MustInherit Class WikiList(Of T)
	Implements IWikiList(Of T)

Dim instance As WikiList(Of T)

generic<typename T>
public ref class WikiList abstract : IWikiList<T>

[<AbstractClassAttribute>]
type WikiList<'T> = 
    class
        interface IWikiList<'T>
    end

Type Parameters

T: The type of listed items.

The WikiListT type exposes the following members.

Constructors

	Name	Description
	WikiListT	Initializes a new instance of the WikiListT class

Top

Properties

	Name	Description
	CompatibilityOptions	Gets/sets the compatibility options used with this list.
	ListName	The name of list, used as the value of list parameter in action=query request.
	PaginationSize	Gets/sets maximum items returned per MediaWiki API invocation.
	Site	Gets the MediaWiki site this instance applies to.

Top

Methods

	Name	Description
	EnumItemsAsync	Asynchronously enumerates all the items in the list.
	EnumListParameters	When overridden, fills generator parameters for action=query&list={ListName} request.
	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&list= JSON response.
	ItemsFromResponse	From the given MediaWiki API response of the MediaWiki list request, locates the array of items whose items will be processed by ItemFromJson(JToken).
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OnEnumItemsFailed	When overriden, called when there is exception raised when executing the asynchronous generator function inside EnumItemsAsync(CancellationToken).
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Reference

WikiClientLibrary.Generators.Primitive Namespace

WikiPageGeneratorTItem

WikiPagePropertyListT