| 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 Structures | Structure | Description |
---|
| PageImageInfo |
Contains information for page image URL along with image size.
|
| WikiPageCategoryInfo |
Contains information about a page's belonging category.
|
Interfaces | Interface | Description |
---|
| IWikiPagePropertyGroup |
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.
|
| IWikiPagePropertyProviderT |
Used in client-side to implement different query modules
by providing extra parameters for action=query requests.
|
Enumerations 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.