 | Search |
This is preliminary documentation and is subject to change.
Search for the pages matching the specific keywords in titles and text.
(mw:API:Search, MediaWiki 1.11+)
Inheritance HierarchySystemObject
WikiClientLibrary.Generators.PrimitiveWikiListSearchResultItem
WikiClientLibrary.Generators.PrimitiveWikiPageGeneratorSearchResultItem
WikiClientLibrary.GeneratorsSearchGenerator
WikiClientLibrary.Generators.PrimitiveWikiListSearchResultItem
WikiClientLibrary.Generators.PrimitiveWikiPageGeneratorSearchResultItem
WikiClientLibrary.GeneratorsSearchGenerator
Namespace: WikiClientLibrary.Generators
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.9.0-int.2+447d1d590e6726b7881f750a0a0e42908f3e417e
SyntaxThe SearchGenerator type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SearchGenerator(WikiSite) | Initializes a new instance of the SearchGenerator class |
| SearchGenerator(WikiSite, String) | Initializes a new instance of the SearchGenerator class |
Properties| Name | Description | |
|---|---|---|
 | BackendName | Class name of search back-end to use (Default: $wgSearchType, MediaWiki 1.22+) |
| CompatibilityOptions |
Gets/sets the compatibility options used with this list.
(Inherited from WikiListT) |
 | DistinctGeneratedPages |
When using the default implementation of EnumPagesAsync(IWikiPageQueryProvider),
determines whether to remove duplicate page results generated from generator results.
This property does not affect the behavior of EnumItemsAsync(CancellationToken).
(Overrides WikiPageGeneratorTItemDistinctGeneratedPages) |
| GeneratorName |
The name of generator, used as the value of generator parameter in action=query request.
(Inherited from WikiPageGeneratorTItem) |
| IncludesInterwiki | Include interwiki results in the search, if available. (Default: false, MediaWiki 1.23+) |
| Keyword | Search for all page titles (or content) that have this value. |
| ListName |
The name of list, used as the value of list parameter in action=query request.
(Overrides WikiListTListName) |
| MatchingField | Search inside the text or titles. |
| NamespaceIds | Only list pages in these namespaces. |
| 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) |
Methods| Name | Description | |
|---|---|---|
| EnumGeneratorParameters |
Fills generator parameters for action=query&generator= request.
(Inherited from WikiPageGeneratorTItem) |
| 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) |
| EnumPagesAsync |
Asynchronously generates the sequence of pages.
(Inherited from WikiPageGeneratorTItem) |
| EnumPagesAsync(IWikiPageQueryProvider) |
Asynchronously generates the sequence of pages.
(Inherited from WikiPageGeneratorTItem) |
| EnumPagesAsync(PageQueryOptions) |
Asynchronously generates the sequence of pages.
(Inherited from WikiPageGeneratorTItem) |
| 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(JsonNode)) |
| ItemsFromResponse |
From the given MediaWiki API response of the MediaWiki list request,
locates the array of items whose items will be processed by ItemFromJson(JsonNode).
(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) |
RemarksDepending on the real-time changes happening on the server, the enumerated sequence from EnumItemsAsync(CancellationToken) may duplicate between each pagination, usually the first and/or the last 1 or 2 items. The result of EnumPagesAsync, however, has already been removed of duplicates.
For full-text search on Wikia, use LocalWikiSearchList.
See Also