This shows you the differences between two versions of the page.
— |
api:thinkgeo.cloud.mapsclient [2018/12/19 08:03] (current) tgwikiupdate created |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== ThinkGeo.Cloud.MapsClient ====== | ||
+ | |||
+ | |||
+ | ===== Inheritance Hierarchy ===== | ||
+ | *System.Object | ||
+ | *ThinkGeo.Cloud.BaseClient | ||
+ | ***ThinkGeo.Cloud.MapsClient** | ||
+ | ===== Members Summary ===== | ||
+ | ==== Public Constructors ==== | ||
+ | ** {{wiki:PublicMethod.gif|}} MapsClient() ** | ||
+ | |||
+ | * //Initilizes an instance. You need apply client Id and secret by properties.// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} MapsClient(String,String) ** | ||
+ | |||
+ | * //Initializes an instance with ClientID and ClientSecret.// | ||
+ | == 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|}} GetRasterTile(Int64,Int64,Int64,MapProjection,RasterMapType,TileSize,TileResolution) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Stream | ||
+ | * Description:stream of image | ||
+ | |||
+ | == Parameters == | ||
+ | * //z// | ||
+ | * Type:Int64 | ||
+ | * Description:The Z value (zoom level) of the tile to get. | ||
+ | |||
+ | * //x// | ||
+ | * Type:Int64 | ||
+ | * Description:The X value (matrix column) of the tile to get. | ||
+ | |||
+ | * //y// | ||
+ | * Type:Int64 | ||
+ | * Description:The Y value (matrix row) of the tile to get. | ||
+ | |||
+ | * //projection// | ||
+ | * Type:[[ThinkGeo.Cloud.MapProjection|MapProjection]] | ||
+ | * Description:The projection to generate the tile. | ||
+ | |||
+ | * //mapType// | ||
+ | * Type:[[ThinkGeo.Cloud.RasterMapType|RasterMapType]] | ||
+ | * Description:The raster map type | ||
+ | |||
+ | * //tileSize// | ||
+ | * Type:[[ThinkGeo.Cloud.TileSize|TileSize]] | ||
+ | * Description:The tile size | ||
+ | |||
+ | * //tileResolution// | ||
+ | * Type:[[ThinkGeo.Cloud.TileResolution|TileResolution]] | ||
+ | * Description:The quality of tile image | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} GetRasterTileAsync(Int64,Int64,Int64,MapProjection,RasterMapType,TileSize,TileResolution) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Task<Stream> | ||
+ | * Description:stream of image | ||
+ | |||
+ | == Parameters == | ||
+ | * //z// | ||
+ | * Type:Int64 | ||
+ | * Description:The Z value (zoom level) of the tile to get. | ||
+ | |||
+ | * //x// | ||
+ | * Type:Int64 | ||
+ | * Description:The X value (matrix column) of the tile to get. | ||
+ | |||
+ | * //y// | ||
+ | * Type:Int64 | ||
+ | * Description:The Y value (matrix row) of the tile to get. | ||
+ | |||
+ | * //projection// | ||
+ | * Type:[[ThinkGeo.Cloud.MapProjection|MapProjection]] | ||
+ | * Description:The projection to generate the tile. | ||
+ | |||
+ | * //mapType// | ||
+ | * Type:[[ThinkGeo.Cloud.RasterMapType|RasterMapType]] | ||
+ | * Description:The raster map type | ||
+ | |||
+ | * //tileSize// | ||
+ | * Type:[[ThinkGeo.Cloud.TileSize|TileSize]] | ||
+ | * Description:The tile size | ||
+ | |||
+ | * //tileResolution// | ||
+ | * Type:[[ThinkGeo.Cloud.TileResolution|TileResolution]] | ||
+ | * Description:The quality of tile image | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} GetVectorTile(Int64,Int64,Int64,MapProjection) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Stream | ||
+ | * Description:An MVT vector tile encoded as protobufs (PBF) and gzipped. | ||
+ | |||
+ | == Parameters == | ||
+ | * //z// | ||
+ | * Type:Int64 | ||
+ | * Description:The Z value (zoom level) of the tile to get. | ||
+ | |||
+ | * //x// | ||
+ | * Type:Int64 | ||
+ | * Description:The X value (matrix column) of the tile to get. | ||
+ | |||
+ | * //y// | ||
+ | * Type:Int64 | ||
+ | * Description:The Y value (matrix row) of the tile to get. | ||
+ | |||
+ | * //projection// | ||
+ | * Type:[[ThinkGeo.Cloud.MapProjection|MapProjection]] | ||
+ | * Description:The projection to generate the tile. | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} GetVectorTileAsync(Int64,Int64,Int64,MapProjection) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Task<Stream> | ||
+ | * Description:An MVT vector tile encoded as protobufs (PBF) and gzipped. | ||
+ | |||
+ | == Parameters == | ||
+ | * //z// | ||
+ | * Type:Int64 | ||
+ | * Description:The Z value (zoom level) of the tile to get. | ||
+ | |||
+ | * //x// | ||
+ | * Type:Int64 | ||
+ | * Description:The X value (matrix column) of the tile to get. | ||
+ | |||
+ | * //y// | ||
+ | * Type:Int64 | ||
+ | * Description:The Y value (matrix row) of the tile to get. | ||
+ | |||
+ | * //projection// | ||
+ | * Type:[[ThinkGeo.Cloud.MapProjection|MapProjection]] | ||
+ | * Description:The projection to generate the tile. | ||
+ | |||
+ | <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|}} 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 ==== | ||