LogEventsList Class

This is preliminary documentation and is subject to change.

Get a list of all logged events, à la Special:Log.

Inheritance Hierarchy

SystemObject
WikiClientLibrary.Generators.PrimitiveWikiListLogEventItem
WikiClientLibrary.GeneratorsLogEventsList

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

Syntax

C++

Copy

public class LogEventsList : WikiList<LogEventItem>

Public Class LogEventsList
	Inherits WikiList(Of LogEventItem)

Dim instance As LogEventsList

public ref class LogEventsList : public WikiList<LogEventItem^>

type LogEventsList = 
    class
        inherit WikiList<LogEventItem>
    end

The LogEventsList type exposes the following members.

Constructors

	Name	Description
	LogEventsList	Initializes a new instance of the LogEventsList class

Top

Properties

	Name	Description
	CompatibilityOptions	Gets/sets the compatibility options used with this list. (Inherited from WikiListT)
	EndTime	The timestamp to end listing at.
	ListName	The name of list, used as the value of list parameter in action=query request. (Overrides WikiListTListName)
	LogAction	Filter log actions to only this type.
	LogType	Only list log entries of this type.
	NamespaceId	Only list log events associated with pages in this namespace. (MediaWiki 1.24+)
	PaginationSize	Gets/sets maximum items returned per MediaWiki API invocation. (Inherited from WikiListT)
	Site	Gets the MediaWiki site this instance applies to. (Inherited from WikiListT)
	StartTime	The timestamp to start listing from.
	Tag	Only list event entries tagged with this tag.
	TimeAscending	Whether to list pages in an ascending order of time. (Default: false)
	UserName	Only list changes made by this user.

Top

Methods

	Name	Description
	EnumItemsAsync	Asynchronously enumerates all the items in the list. (Inherited from WikiListT)
	EnumListParameters	When overridden, fills generator parameters for action=query&list={ListName} request. (Overrides WikiListTEnumListParameters)
	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. (Overrides WikiListTItemFromJson(JToken))
	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). (Inherited from WikiListT)
	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). (Inherited from WikiListT)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Remarks

This module cannot be used as a generator.

Reference

WikiClientLibrary.Generators Namespace