Online Maps v3
Loading...
Searching...
No Matches
OnlineMapsBingMapsLocation Class Reference

This class is used to search for a location by address using Bing Maps Location API.
https://msdn.microsoft.com/en-us/library/ff701715.aspx. More...

Inheritance diagram for OnlineMapsBingMapsLocation:
OnlineMapsTextWebService OnlineMapsWebServiceAPI

Static Public Member Functions

static OnlineMapsBingMapsLocation FindByQuery (string query, string key, int maxResults=5, bool includeNeighborhood=false)
 Get latitude and longitude coordinates that correspond to location information provided as a query string.
 
static OnlineMapsBingMapsLocation FindByPoint (Vector2 point, string key, bool includeNeighborhood=false)
 Get the location information associated with latitude and longitude coordinates (reverse geocoding).
 
static OnlineMapsBingMapsLocationResult[] GetResults (string response)
 Converts response into an array of results.
 

Additional Inherited Members

- Public Member Functions inherited from OnlineMapsWebServiceAPI
void Destroy ()
 Destroys the current request to webservice.
 
OnlineMapsWWW GetWWW ()
 Get request instance.
 
- Public Attributes inherited from OnlineMapsTextWebService
Action< string > OnComplete
 Event that occurs when a response is received from webservice.
 
new Action< OnlineMapsTextWebServiceOnFailed
 Event that occurs when an error response is received from webservice.
 
new Action< OnlineMapsTextWebServiceOnFinish
 This event is occurs after other events, before disposing the request.
 
new Action< OnlineMapsTextWebServiceOnSuccess
 Event that occurs when a success response is received from webservice.
 
- Public Attributes inherited from OnlineMapsWebServiceAPI
Action< OnlineMapsWebServiceAPIOnFailed
 Event that occurs when an error response is received from webservice.
 
Action< OnlineMapsWebServiceAPIOnFinish
 Event that occurs after OnComplete, when the response from webservice processed.
 
Action< OnlineMapsWebServiceAPIOnDispose
 Event that occurs when the current request instance is disposed.
 
Action< OnlineMapsWebServiceAPIOnSuccess
 Event that occurs when a success response is received from webservice.
 
object customData
 In this variable you can put any data that you need to work with requests.
 
- Protected Member Functions inherited from OnlineMapsTextWebService
void OnRequestComplete (OnlineMapsWWW www)
 Checks whether the response from webservice.
 
- Protected Attributes inherited from OnlineMapsTextWebService
string _response
 Response string.
 
- Properties inherited from OnlineMapsTextWebService
string response [get]
 Gets a response from webservice.
 
- Properties inherited from OnlineMapsWebServiceAPI
OnlineMapsQueryStatus status [get]
 Gets the current status of the request to webservice.
 

Detailed Description

This class is used to search for a location by address using Bing Maps Location API.
https://msdn.microsoft.com/en-us/library/ff701715.aspx.

Member Function Documentation

◆ FindByPoint()

static OnlineMapsBingMapsLocation OnlineMapsBingMapsLocation.FindByPoint ( Vector2 point,
string key,
bool includeNeighborhood = false )
static

Get the location information associated with latitude and longitude coordinates (reverse geocoding).

Parameters
pointThe coordinates of the location that you want to reverse geocode (X - Longitude, Y - Latitude).
keyBing Maps API Key.
includeNeighborhoodSpecifies to include the neighborhood in the response when it is available.
Returns
Instance of query

◆ FindByQuery()

static OnlineMapsBingMapsLocation OnlineMapsBingMapsLocation.FindByQuery ( string query,
string key,
int maxResults = 5,
bool includeNeighborhood = false )
static

Get latitude and longitude coordinates that correspond to location information provided as a query string.

Parameters
queryA string that contains information about a location, such as an address or landmark name.
keyBing Maps API Key
maxResultsSpecifies the maximum number (1-20) of locations to return in the response.
includeNeighborhoodSpecifies to include the neighborhood with the address information the response when it is available.
Returns
Instance of query

◆ GetResults()

static OnlineMapsBingMapsLocationResult[] OnlineMapsBingMapsLocation.GetResults ( string response)
static

Converts response into an array of results.

Parameters
responseResponse of query.
Returns
Array of result.