Click or drag to resize

WikiClientLibrary.Pages.Queries.Properties Namespace

This is preliminary documentation and is subject to change.

This namespace contains property groups along with their providers for querying various page properties of MediaWiki pages.
Classes
 ClassDescription
Public classCategoriesPropertyGroup 
Public classCategoriesPropertyProvider 
Public classCategoryInfoPropertyGroup Property group for category page information.
Public classCategoryInfoPropertyProvider Provides information for category pages. (mw:API:Categoryinfo, MediaWiki 1.13+)
Public classExtractsPropertyGroup 
Public classExtractsPropertyProvider Returns plain-text or limited HTML extracts of the given pages. action=query&prop=extracts (mw:Extension:TextExtracts#API)
Public classFileInfoPropertyGroup Contains properties for MediaWiki files. (mw:API:Fileinfo, mw:API:Imageinfo, MediaWiki 1.13+)
Public classFileInfoPropertyProvider Provides information for MediaWiki files. (mw:API:Fileinfo, MediaWiki 1.13+)
Public classGeoCoordinatesPropertyGroup 
Public classGeoCoordinatesPropertyProvider Returns the geographical coordinates associated with the page. (mw:Extension:GeoData#prop=coordinates)
Public classLanguageLinkInfo Represents the information about a language link.
Public classLanguageLinksPropertyGroup 
Public classLanguageLinksPropertyProvider Gets a list of interlanguage links from the provided pages to other languages. (mw:API:Langlinks)
Public classPageImageInfo Contains information for page image URL along with image size.
Public classPageImagesPropertyGroup Contains information about images on the page, such as thumbnail and presence of photos. (mw:Extension:PageImages#API)
Public classPageImagesPropertyProvider Provides information about images on the page, such as thumbnail and presence of photos. (mw:Extension:PageImages#API)
Public classPageInfoPropertyGroup 
Public classPageInfoPropertyProvider 
Public classPagePropertiesPropertyGroup 
Public classPagePropertiesPropertyProvider 
Public classRevisionsPropertyGroup 
Public classRevisionsPropertyProvider Returns the latest revision of the page. (mw:API:Revisions, MediaWiki 1.8+)
Public classWikiPagePropertyGroup A base class for an immutable group of extendable WikiPage properties. The default implementation for IWikiPagePropertyGroup.
Public classWikiPagePropertyProviderT Provides default implementation for IWikiPagePropertyProviderT.
Structures
 StructureDescription
Public structureWikiPageCategoryInfo Contains information about a page's belonging category.
Interfaces
 InterfaceDescription
Public interfaceIWikiPagePropertyGroup A marker interface which indicates the implementation type is an immutable group of property values associated with WikiPage that can be fetched from MediaWiki server.
Public interfaceIWikiPagePropertyProviderT Used in client-side to implement different query modules by providing extra parameters for action=query requests.
Enumerations
 EnumerationDescription
Public enumerationLanguageLinkProperties The additional language link properties to retrieve for LanguageLinksPropertyGroup.
Remarks

When querying for MediaWiki pages from server, the client can also ask for a subset of properties for the page of interest. Depending on the installation of extensions, the server supports different set of property modules. For a list of commonly-used property modules, see mw:API:Properties.

The classes in this namespace deal with property modules that applies to pages only. For property modules that don't need to be associated with MediaWiki pages (e.g. prop=stashimageinfo), you might need to initiate the request via InvokeMediaWikiApiAsync(WikiRequestMessage, CancellationToken). For most of the properties that returns a sequence of values (e.g. prop=revisions, prop=links), please refer to the derived classes of WikiPagePropertyListT, which allows you to enumerate the items with automatic list-continuation support. There is one special case, however, for prop=revisions, that it has been implemented as RevisionsPropertyProvider and RevisionsGenerator. For the distinction between these classes, see their respective documentations.