Class GeocodingCloudClient

Namespace

ThinkGeo.Core

Assembly

ThinkGeo.Core.dll

A class provides the methods to access the Geocoding APIs.

public class GeocodingCloudClient : CloudClient, IDisposable

Inheritance

object

CloudClient

GeocodingCloudClient

Implements

IDisposable

Inherited Members

CloudClient.AuthenticateWebRequest(WebRequest)

CloudClient.AuthenticateWebRequestAsync(WebRequest)

CloudClient.GetToken()

CloudClient.GetTokenAsync()

CloudClient.GetTokenCoreAsync()

CloudClient.GetTokenCore()

CloudClient.SendWebRequest(WebRequest)

CloudClient.SendWebRequestAsync(WebRequest)

CloudClient.GetNextCandidateBaseUri()

CloudClient.GetNextCandidateBaseUriCore()

CloudClient.OnGettingAccessToken(GettingAccessTokenEventArgs)

CloudClient.OnSendingWebRequest(SendingWebRequestEventArgs)

CloudClient.OnSentWebRequest(SentWebRequestEventArgs)

CloudClient.Dispose()

CloudClient.TimeoutInSeconds

CloudClient.WebProxy

CloudClient.ClientId

CloudClient.ClientSecret

CloudClient.BaseUris

CloudClient.GettingAccessToken

CloudClient.SendingWebRequest

CloudClient.SentWebRequest

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

A class provides the methods to access the Geocoding APIs.

Constructors

GeocodingCloudClient()

Initilizes an instance. You need apply client Id and secret by properties.

public GeocodingCloudClient()

GeocodingCloudClient(string, string)

Initializes an instance with ClientID and ClientSecret. It will send a request to GIS Server to gain the token which will be added to the Header for all the requests.

public GeocodingCloudClient(string clientId, string clientSecret)

Parameters

clientId string

The ClientID for the auth.

clientSecret string

The ClientSecret for the auth.

Exceptions

ArgumentNullException

Thrown when the clientId or clientSecret is null.

Methods

Search(IEnumerable<string>)

Search for multi locations

public Collection<CloudGeocodingResult> Search(IEnumerable<string> locations)

Parameters

locations IEnumerable<string>

The multi location

Returns

Collection<CloudGeocodingResult>

The search result.CloudGeocodingResult

Search(IEnumerable<string>, CloudGeocodingOptions)

Search for multi locations

public Collection<CloudGeocodingResult> Search(IEnumerable<string> locations, CloudGeocodingOptions options)

Parameters

locations IEnumerable<string>

The multi location

options CloudGeocodingOptions

The options for the searching. CloudGeocodingOptions

Returns

Collection<CloudGeocodingResult>

The search result.CloudGeocodingResult

Search(string)

Search for a location expression

public CloudGeocodingResult Search(string location)

Parameters

location string

The location expression

Returns

CloudGeocodingResult

The search result.CloudGeocodingResult

Search(string, CloudGeocodingOptions)

Search for a location expression

public CloudGeocodingResult Search(string location, CloudGeocodingOptions options)

Parameters

location string

The location expression

options CloudGeocodingOptions

The options for the searching. CloudGeocodingOptions

Returns

CloudGeocodingResult

The search result.CloudGeocodingResult

SearchAsync(IEnumerable<string>)

Search for multi locations

public Task<Collection<CloudGeocodingResult>> SearchAsync(IEnumerable<string> locations)

Parameters

locations IEnumerable<string>

The multi location

Returns

Task<Collection<CloudGeocodingResult>>

The search result.CloudGeocodingResult

SearchAsync(IEnumerable<string>, CloudGeocodingOptions)

Search for multi locations

public Task<Collection<CloudGeocodingResult>> SearchAsync(IEnumerable<string> locations, CloudGeocodingOptions options)

Parameters

locations IEnumerable<string>

The multi location

options CloudGeocodingOptions

The options for the searching. CloudGeocodingOptions

Returns

Task<Collection<CloudGeocodingResult>>

The search result.CloudGeocodingResult

SearchAsync(string)

Search for a location expression

public Task<CloudGeocodingResult> SearchAsync(string location)

Parameters

location string

The location expression

Returns

Task<CloudGeocodingResult>

The search result.CloudGeocodingResult

SearchAsync(string, CloudGeocodingOptions)

Search for a location expression

public Task<CloudGeocodingResult> SearchAsync(string location, CloudGeocodingOptions options)

Parameters

location string

The location expression

options CloudGeocodingOptions

The options for the searching. CloudGeocodingOptions

Returns

Task<CloudGeocodingResult>

The search result.CloudGeocodingResult