api:thinkgeo.cloud.baseclient
Differences
This shows you the differences between two versions of the page.
| — |
api:thinkgeo.cloud.baseclient [2018/12/19 08:00] (current) tgwikiupdate created |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== ThinkGeo.Cloud.BaseClient ====== | ||
| + | |||
| + | |||
| + | ===== Inheritance Hierarchy ===== | ||
| + | *System.Object | ||
| + | ***ThinkGeo.Cloud.BaseClient** | ||
| + | *[[ThinkGeo.Cloud.ColorClient]] | ||
| + | *[[ThinkGeo.Cloud.ElevationClient]] | ||
| + | *[[ThinkGeo.Cloud.MapsClient]] | ||
| + | *[[ThinkGeo.Cloud.ProjectionClient]] | ||
| + | *[[ThinkGeo.Cloud.ReverseGeocodingClient]] | ||
| + | ===== Members Summary ===== | ||
| + | ==== Public Constructors ==== | ||
| + | ==== Protected Constructors ==== | ||
| + | ** {{wiki:ProtectedMethod.gif|}} BaseClient() ** | ||
| + | |||
| + | * //This method is the default protected constructor. You need apply client Id and secret by properties.// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} BaseClient(String,String) ** | ||
| + | |||
| + | * //This method is the default protected constructor with a NativeConfidential client ID and secret. It will send a request to the GIS Server to acquire an access token, which will then be added to the Header for all future requests.// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Parameters == | ||
| + | * //clientId// | ||
| + | * Type:String | ||
| + | * Description:The NativeConfidential client Id with which to authenticate. | ||
| + | |||
| + | * //clientSecret// | ||
| + | * Type:String | ||
| + | * Description:The NativeConfidential client secret with which to authenticate. | ||
| + | |||
| + | <div newline></div> | ||
| + | ==== Public Methods ==== | ||
| + | ** {{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:The webRequest which need to apply token to header | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetToken() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:String | ||
| + | * Description:The AccessToken from server. if the request is canceled by user, return null | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetTokenCore() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:String | ||
| + | * Description:The AccessToken from server. if the request is canceled by user, return null | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} SendWebRequest(WebRequest) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:WebResponse | ||
| + | * Description:The HTTP response. | ||
| + | |||
| + | == 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:The HTTP response. | ||
| + | |||
| + | == Parameters == | ||
| + | * //webRequest// | ||
| + | * Type:WebRequest | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetNextCandidateBaseUri() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:String | ||
| + | * Description:A Gis Server uri | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetNextCandidateBaseUriCore() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:String | ||
| + | * Description:A Gis Server uri | ||
| + | |||
| + | == 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:Event argument for GettingAccessToken event. | ||
| + | |||
| + | <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:Event argument for SendingWebRequest event. | ||
| + | |||
| + | <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|}} 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 ==== | ||
api/thinkgeo.cloud.baseclient.txt ยท Last modified: 2018/12/19 08:00 by tgwikiupdate