 | Geo |
This is preliminary documentation and is subject to change.
Searches for articles around the given point (determined either by coordinates or by article name).
(mw:Extension:GeoData#prop=coordinates)
Inheritance HierarchySystemObject
WikiClientLibrary.Generators.PrimitiveWikiListGeoSearchResultItem
WikiClientLibrary.Generators.PrimitiveWikiPageGeneratorGeoSearchResultItem
WikiClientLibrary.GeneratorsGeoSearchGenerator
WikiClientLibrary.Generators.PrimitiveWikiListGeoSearchResultItem
WikiClientLibrary.Generators.PrimitiveWikiPageGeneratorGeoSearchResultItem
WikiClientLibrary.GeneratorsGeoSearchGenerator
Namespace: WikiClientLibrary.Generators
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.9.0-int.2+447d1d590e6726b7881f750a0a0e42908f3e417e
SyntaxThe GeoSearchGenerator type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GeoSearchGenerator | Initializes a new instance of the GeoSearchGenerator class |
Properties| Name | Description | |
|---|---|---|
 | BoundingRectangle | Geographical bounding box to search in. |
| 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).
(Inherited from WikiPageGeneratorTItem) |
| GeneratorName |
The name of generator, used as the value of generator parameter in action=query request.
(Inherited from WikiPageGeneratorTItem) |
| IncludesSecondaryCoordinates | Gets/set a value indicating whether to include secondary coordinates in the search results. |
| ListName |
The name of list, used as the value of list parameter in action=query request.
(Overrides WikiListTListName) |
| NamespaceIds | Only list pages in these namespaces. |
| PaginationSize |
Gets/sets maximum items returned per MediaWiki API invocation.
(Inherited from WikiListT) |
| Radius | Gets/sets the search radius in meters (10-10000). |
| Site | Gets the MediaWiki site this instance applies to. (Inherited from WikiListT) |
| TargetCoordinate | Gets/sets the coordinate around which to search. |
| TargetTitle | Gets/sets the title of page around which to search. |
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).
(Overrides WikiListTOnEnumItemsFailed(Exception)) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
See Also