 | Wiki |
This is preliminary documentation and is subject to change.
Represents a MediaWiki site.
Inheritance HierarchyNamespace: WikiClientLibrary.Sites
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.9.0-int.2+447d1d590e6726b7881f750a0a0e42908f3e417e
SyntaxThe WikiSite type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | WikiSite(IWikiClient, String) | Initializes a WikiSite instance with the specified API endpoint. |
| WikiSite(IWikiClient, SiteOptions) | Initializes a WikiSite instance with the specified settings. |
| WikiSite(IWikiClient, SiteOptions, String, String) | Initializes a WikiSite instance with the specified settings and optional login before fetching for site information. |
Properties| Name | Description | |
|---|---|---|
 | AccountAssertionFailureHandler | A handler used to re-login when account assertion fails. |
| AccountInfo | Gets the current user's account information. |
| ApiEndpoint | The endpoint URL for MediaWiki API. |
| Extensions | Gets a collection of installed extensions on this MediaWiki site. |
| Initialization | A task that indicates the asynchronous initialization status of this instance. |
| InterwikiMap | Gets the interwiki map information on this wiki site. |
| Logger | Replaces the logger factory of the specified instance. |
| MagicWords | Gets a list of magic words and their aliases on this MediaWiki site. (MW 1.14+) |
| ModificationThrottler | A throttler used to enforce the speed limitation when performing edit/move/delete operations. |
| Namespaces | Gets a collection of namespaces used on this MediaWiki site. |
 | Options | Gets the options applied to the current instance. |
| SiteInfo | Gets the basic site information. |
| WikiClient | Gets the MediaWiki API client used to perform the requests. |
Methods| Name | Description | |
|---|---|---|
| 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) |
| GetMessageAsync(String) | Get the content of MediaWiki interface message. |
| GetMessageAsync(String, CancellationToken) | Get the content of MediaWiki interface message. |
| GetMessagesAsync(IEnumerableString) | Get the content of some or all MediaWiki interface messages. |
| GetMessagesAsync(IEnumerableString, CancellationToken) | Get the content of some or all MediaWiki interface messages. |
| GetStatisticsAsync | Gets the statistical information of the MediaWiki site. |
| GetStatisticsAsync(CancellationToken) | Gets the statistical information of the MediaWiki site. |
| GetTokenAsync(String) | Request a token for operation. |
| GetTokenAsync(String, Boolean) | Request a token for operation. |
| GetTokenAsync(String, CancellationToken) | Request a token for operation. |
| GetTokenAsync(String, Boolean, CancellationToken) | Request a token for operation. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| InvokeMediaWikiApiAsync(WikiRequestMessage, CancellationToken) | Invokes MediaWiki API and gets JSON result. |
| InvokeMediaWikiApiAsync(WikiRequestMessage, Boolean, CancellationToken) | Invokes MediaWiki API and gets JSON result. |
| InvokeMediaWikiApiAsyncT(WikiRequestMessage, IWikiResponseMessageParserT, Boolean, CancellationToken) | Invokes MediaWiki API and gets JSON result. |
| LoginAsync(String, String) | Logins into the wiki site. |
| LoginAsync(String, String, String) | Logins into the wiki site. |
| LoginAsync(String, String, String, CancellationToken) | Logins into the wiki site. |
| LogoutAsync | Logouts from the wiki site. |
| LogoutAsync(Boolean) | Logouts from the wiki site. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OpenSearchAsync(String) | Performs an opensearch and get results, often used for search box suggestions. (MediaWiki 1.25 or OpenSearch extension) |
| OpenSearchAsync(String, Int32) | Performs an opensearch and get results, often used for search box suggestions. (MediaWiki 1.25 or OpenSearch extension) |
| OpenSearchAsync(String, OpenSearchOptions) | Performs an opensearch and get results, often used for search box suggestions. (MediaWiki 1.25 or OpenSearch extension) |
| OpenSearchAsync(String, Int32, OpenSearchOptions) | Performs an opensearch and get results, often used for search box suggestions. (MediaWiki 1.25 or OpenSearch extension) |
| OpenSearchAsync(String, Int32, Int32, OpenSearchOptions) | Performs an opensearch and get results, often used for search box suggestions. (MediaWiki 1.25 or OpenSearch extension) |
| OpenSearchAsync(String, Int32, OpenSearchOptions, CancellationToken) | Performs an opensearch and get results, often used for search box suggestions. (MediaWiki 1.25 or OpenSearch extension) |
| OpenSearchAsync(String, Int32, Int32, OpenSearchOptions, CancellationToken) | Performs an opensearch and get results, often used for search box suggestions. (MediaWiki 1.25 or OpenSearch extension) |
| RefreshAccountInfoAsync | Refreshes user account information. |
| RefreshSiteInfoAsync | Refreshes site information. |
 | SearchApiEndpointAsync | Given a site or page URL of a MediaWiki site, try to look for the Api Endpoint URL of it. |
| SendLogoutRequestAsync | Directly sends a logout request. This method will be invoked by LogoutAsync(Boolean). |
| ToString | Returns a string that represents the current object. (Overrides ObjectToString) |
Extension Methods| Name | Description | |
|---|---|---|
 | BeginActionScope |
Invokes BeginScopeTState(TState) with the current action(method) name and parameters.
(Defined by WikiLoggingHelper) |
| BeginActionScope | (Defined by WikiLoggingHelper) |
| BeginActionScope |
Invokes BeginScopeTState(TState) on the Logger
with the current action(method) name and parameters.
(Defined by WikiLoggingHelper) |
| BeginActionScope | (Defined by WikiLoggingHelper) |
| BeginActionScope |
Invokes BeginScopeTState(TState) on the Logger
with the current action(method) name and parameters.
(Defined by WikiLoggingHelper) |
| ExecuteCargoQueryAsync |
Executes a Cargo query and retrieves the response rows.
(Defined by CargoWikiSiteExtensions) |
| ExecuteCargoQueryAsync |
Executes a Cargo query and retrieves the response rows.
(Defined by CargoWikiSiteExtensions) |
| ParseContentAsync |
Parsing the specific page content and/or summary, gets HTML and more information. (MediaWiki 1.12)
(Defined by WikiSiteExtensions) |
| ParseContentAsync |
Parsing the specific page content and/or summary, gets HTML and more information. (MediaWiki 1.12)
(Defined by WikiSiteExtensions) |
| ParseContentAsync |
Parsing the specific page content and/or summary, gets HTML and more information. (MediaWiki 1.12)
(Defined by WikiSiteExtensions) |
| ParseContentAsync |
Parsing the specific page content and/or summary, gets HTML and more information. (MediaWiki 1.12)
(Defined by WikiSiteExtensions) |
| ParsePageAsync |
Parsing the specific page, gets HTML and more information. (MediaWiki 1.12)
(Defined by WikiSiteExtensions) |
| ParsePageAsync |
Parsing the specific page, gets HTML and more information. (MediaWiki 1.12)
(Defined by WikiSiteExtensions) |
| ParsePageAsync |
Parsing the specific page, gets HTML and more information. (MediaWiki 1.12)
(Defined by WikiSiteExtensions) |
| ParsePageAsync |
Parsing the specific page, gets HTML and more information. (MediaWiki 1.12)
(Defined by WikiSiteExtensions) |
| ParsePageAsync |
Parsing the specific page, gets HTML and more information. (MediaWiki 1.12)
(Defined by WikiSiteExtensions) |
| ParsePageAsync |
Parsing the specific page, gets HTML and more information. (MediaWiki 1.12)
(Defined by WikiSiteExtensions) |
| ParsePageAsync |
Parsing the specific page, gets HTML and more information. (MediaWiki 1.12)
(Defined by WikiSiteExtensions) |
| ParsePageAsync |
Parsing the specific page, gets HTML and more information. (MediaWiki 1.12)
(Defined by WikiSiteExtensions) |
| ParseRevisionAsync |
Parsing the specific page revision, gets HTML and more information. (MediaWiki 1.12)
(Defined by WikiSiteExtensions) |
| ParseRevisionAsync |
Parsing the specific page revision, gets HTML and more information. (MediaWiki 1.12)
(Defined by WikiSiteExtensions) |
| ParseRevisionAsync |
Parsing the specific page revision, gets HTML and more information. (MediaWiki 1.12)
(Defined by WikiSiteExtensions) |
| ParseRevisionAsync |
Parsing the specific page revision, gets HTML and more information. (MediaWiki 1.12)
(Defined by WikiSiteExtensions) |
| ScribuntoExecuteLuaAsyncT |
Evaluates an ad-hoc Lua module with the specified module content in Scribunto Lua console, and gets the returned value.
(Defined by ScribuntoWikiSiteExtensions) |
| ScribuntoExecuteLuaAsyncT |
Evaluates an ad-hoc Lua module with the specified module content in Scribunto Lua console, and gets the returned value.
(Defined by ScribuntoWikiSiteExtensions) |
| ScribuntoExecuteLuaAsyncT |
Evaluates an ad-hoc Lua module with the specified module content in Scribunto Lua console, and gets the returned value.
(Defined by ScribuntoWikiSiteExtensions) |
| ScribuntoExecuteLuaAsyncT |
Evaluates an ad-hoc Lua module with the specified module content in Scribunto Lua console, and gets the returned value.
(Defined by ScribuntoWikiSiteExtensions) |
| ScribuntoLoadDataAsyncT |
Imports the Lua module with the specified name and gets the module content.
(Defined by ScribuntoWikiSiteExtensions) |
| ScribuntoLoadDataAsyncT |
Imports the Lua module with the specified name and gets the module content.
(Defined by ScribuntoWikiSiteExtensions) |
| ScribuntoLoadDataAsyncT |
Imports the Lua module with the specified name and gets the module content.
(Defined by ScribuntoWikiSiteExtensions) |
| ScribuntoLoadDataAsyncT |
Imports the Lua module with the specified name and gets the module content.
(Defined by ScribuntoWikiSiteExtensions) |
| ScribuntoLoadDataAsyncT |
Imports the Lua module with the specified name and gets the module content.
(Defined by ScribuntoWikiSiteExtensions) |
| ScribuntoLoadDataAsyncT |
Imports the Lua module with the specified name and gets the module content.
(Defined by ScribuntoWikiSiteExtensions) |
| ScribuntoLoadDataAsyncT |
Imports the Lua module with the specified name and evaluates the specified Lua code with it.
(Defined by ScribuntoWikiSiteExtensions) |
| UploadAsync |
Asynchronously uploads a file in this title.
(Defined by WikiSiteExtensions) |
| UploadAsync |
Asynchronously uploads a file in this title.
(Defined by WikiSiteExtensions) |
| UploadAsync |
Asynchronously uploads a file in this title.
(Defined by WikiSiteExtensions) |
RemarksFor FANDOM/Wikia specific site access, use WikiaSite instead of this class.
See Also