WikiPagePropertyListT Class

This is preliminary documentation and is subject to change.

Represents a list-like sequence parsed from a property of MediaWiki page.

Inheritance Hierarchy

SystemObject
WikiClientLibrary.Generators.PrimitiveWikiPagePropertyListT
WikiClientLibrary.Generators.PrimitiveWikiPagePropertyGeneratorTItem

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

Syntax

C++

Copy

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

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

Dim instance As WikiPagePropertyList(Of T)

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

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

Type Parameters

T: The type of item.

The WikiPagePropertyListT type exposes the following members.

Constructors

	Name	Description
	WikiPagePropertyListT(WikiSite)	Initializes a new instance of the WikiPagePropertyListT class
	WikiPagePropertyListT(WikiSite, WikiPageStub)	Initializes a new instance of the WikiPagePropertyListT class

Top

Properties

	Name	Description
	PageId	Gets/sets the page ID from which to get the list-like property value.
	PageTitle	Gets/sets the page title from which to get the list-like property value.
	PaginationSize	Gets/sets maximum items returned per MediaWiki API invocation.
	PropertyName	Gets the name of the property, used as the value of prop parameter in action=query request.
	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&prop={PropertyName} 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&prop={PropertyName} JSON response.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Overrides ObjectToString)

Top

Remarks

Some properties of a MediaWiki page are inherently a list e.g. link(see mw:API:Links) that supports pagination, and that thus can be enumerated asynchronously. This class provides basic functionality for enumerating such list-like property values.

Reference

WikiClientLibrary.Generators.Primitive Namespace

WikiPagePropertyGeneratorTItem

WikiListT