This shows you the differences between two versions of the page.
— |
api:thinkgeo.cloud.geocodingclient [2019/02/14 07:19] (current) tgwikiupdate created |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== ThinkGeo.Cloud.GeocodingClient ====== | ||
+ | |||
+ | |||
+ | ===== Inheritance Hierarchy ===== | ||
+ | *System.Object | ||
+ | *ThinkGeo.Cloud.BaseClient | ||
+ | ***ThinkGeo.Cloud.GeocodingClient** | ||
+ | ===== Members Summary ===== | ||
+ | ==== Public Constructors ==== | ||
+ | ** {{wiki:PublicMethod.gif|}} GeocodingClient() ** | ||
+ | |||
+ | * //Initilizes an instance. You need apply client Id and secret by properties.// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} GeocodingClient(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.// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Parameters == | ||
+ | * //clientId// | ||
+ | * Type:String | ||
+ | * Description:The ClientID for the auth. | ||
+ | |||
+ | * //clientSecret// | ||
+ | * Type:String | ||
+ | * Description:The ClientSecret for the auth. | ||
+ | |||
+ | <div newline></div> | ||
+ | ==== Protected Constructors ==== | ||
+ | ==== Public Methods ==== | ||
+ | ** {{wiki:PublicMethod.gif|}} Search(String) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:[[ThinkGeo.Cloud.GeocodingResult|GeocodingResult]] | ||
+ | * Description:The search result. | ||
+ | |||
+ | == Parameters == | ||
+ | * //location// | ||
+ | * Type:String | ||
+ | * Description:The location expression | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} Search(String,GeocodingOptions) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:[[ThinkGeo.Cloud.GeocodingResult|GeocodingResult]] | ||
+ | * Description:The search result. | ||
+ | |||
+ | == Parameters == | ||
+ | * //location// | ||
+ | * Type:String | ||
+ | * Description:The location expression | ||
+ | |||
+ | * //options// | ||
+ | * Type:[[ThinkGeo.Cloud.GeocodingOptions|GeocodingOptions]] | ||
+ | * Description:The options for the searching. | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} SearchAsync(String) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Task<[[ThinkGeo.Cloud.GeocodingResult|GeocodingResult]]> | ||
+ | * Description:The search result. | ||
+ | |||
+ | == Parameters == | ||
+ | * //location// | ||
+ | * Type:String | ||
+ | * Description:The location expression | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} SearchAsync(String,GeocodingOptions) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Task<[[ThinkGeo.Cloud.GeocodingResult|GeocodingResult]]> | ||
+ | * Description:The search result. | ||
+ | |||
+ | == Parameters == | ||
+ | * //location// | ||
+ | * Type:String | ||
+ | * Description:The location expression | ||
+ | |||
+ | * //options// | ||
+ | * Type:[[ThinkGeo.Cloud.GeocodingOptions|GeocodingOptions]] | ||
+ | * Description:The options for the searching. | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} Search(IEnumerable<String>) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Collection<[[ThinkGeo.Cloud.GeocodingResult|GeocodingResult]]> | ||
+ | * Description:The search result. | ||
+ | |||
+ | == Parameters == | ||
+ | * //locations// | ||
+ | * Type:IEnumerable<String> | ||
+ | * Description:The multi location | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} Search(IEnumerable<String>,GeocodingOptions) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Collection<[[ThinkGeo.Cloud.GeocodingResult|GeocodingResult]]> | ||
+ | * Description:The search result. | ||
+ | |||
+ | == Parameters == | ||
+ | * //locations// | ||
+ | * Type:IEnumerable<String> | ||
+ | * Description:The multi location | ||
+ | |||
+ | * //options// | ||
+ | * Type:[[ThinkGeo.Cloud.GeocodingOptions|GeocodingOptions]] | ||
+ | * Description:The options for the searching. | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} SearchAsync(IEnumerable<String>) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Task<Collection<[[ThinkGeo.Cloud.GeocodingResult|GeocodingResult]]>> | ||
+ | * Description:The search result. | ||
+ | |||
+ | == Parameters == | ||
+ | * //locations// | ||
+ | * Type:IEnumerable<String> | ||
+ | * Description:The multi location | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} SearchAsync(IEnumerable<String>,GeocodingOptions) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Task<Collection<[[ThinkGeo.Cloud.GeocodingResult|GeocodingResult]]>> | ||
+ | * Description:The search result. | ||
+ | |||
+ | == Parameters == | ||
+ | * //locations// | ||
+ | * Type:IEnumerable<String> | ||
+ | * Description:The multi location | ||
+ | |||
+ | * //options// | ||
+ | * Type:[[ThinkGeo.Cloud.GeocodingOptions|GeocodingOptions]] | ||
+ | * Description:The options for the searching. | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} Dispose() ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Void | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:String | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Boolean | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | * //obj// | ||
+ | * Type:Object | ||
+ | * Description:N/A | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Int32 | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Type | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ===== Protected Methods ===== | ||
+ | ** {{wiki:ProtectedMethod.gif|}} AuthenticateWebRequest(WebRequest) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Void | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | * //webRequest// | ||
+ | * Type:WebRequest | ||
+ | * Description:N/A | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:ProtectedMethod.gif|}} GetToken() ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:String | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:ProtectedMethod.gif|}} GetTokenCore() ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:String | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:ProtectedMethod.gif|}} SendWebRequest(WebRequest) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:WebResponse | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | * //webRequest// | ||
+ | * Type:WebRequest | ||
+ | * Description:N/A | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:ProtectedMethod.gif|}} SendWebRequestAsync(WebRequest) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Task<WebResponse> | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | * //webRequest// | ||
+ | * Type:WebRequest | ||
+ | * Description:N/A | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:ProtectedMethod.gif|}} GetNextCandidateBaseUri() ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:String | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:ProtectedMethod.gif|}} GetNextCandidateBaseUriCore() ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:String | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:ProtectedMethod.gif|}} OnGettingAccessToken(GettingAccessTokenEventArgs) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Void | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | * //e// | ||
+ | * Type:[[ThinkGeo.Cloud.GettingAccessTokenEventArgs|GettingAccessTokenEventArgs]] | ||
+ | * Description:N/A | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:ProtectedMethod.gif|}} OnSendingWebRequest(SendingWebRequestEventArgs) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Void | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | * //e// | ||
+ | * Type:[[ThinkGeo.MapSuite.Layers.SendingWebRequestEventArgs|SendingWebRequestEventArgs]] | ||
+ | * Description:N/A | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:ProtectedMethod.gif|}} OnSentWebRequest(SentWebRequestEventArgs) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Void | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | * //e// | ||
+ | * Type:[[ThinkGeo.MapSuite.Layers.SentWebRequestEventArgs|SentWebRequestEventArgs]] | ||
+ | * Description:N/A | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Void | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Object | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ==== Public Properties ==== | ||
+ | ** {{wiki:PublicProperty.gif|}} TimeoutInSeconds ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Return Value == | ||
+ | * Type:Int32 | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} WebProxy ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Return Value == | ||
+ | * Type:IWebProxy | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ClientId ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Return Value == | ||
+ | * Type:String | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ClientSecret ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Return Value == | ||
+ | * Type:String | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} BaseUris ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Return Value == | ||
+ | * Type:Collection<Uri> | ||
+ | |||
+ | ==== Protected Properties ==== | ||
+ | ==== Public Events ==== | ||
+ | ** {{wiki:PublicEvent.gif|}} GettingAccessToken ** | ||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | Event Arguments:[[ThinkGeo.Cloud.GettingAccessTokenEventArgs|GettingAccessTokenEventArgs]] | ||
+ | |||
+ | ** {{wiki:PublicEvent.gif|}} SendingWebRequest ** | ||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | Event Arguments:[[ThinkGeo.MapSuite.Layers.SendingWebRequestEventArgs|SendingWebRequestEventArgs]] | ||
+ | |||
+ | ** {{wiki:PublicEvent.gif|}} SentWebRequest ** | ||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | Event Arguments:[[ThinkGeo.MapSuite.Layers.SentWebRequestEventArgs|SentWebRequestEventArgs]] | ||
+ | |||