MapsRenderingClient.GetCopyrightForTileAsync Method

Definition

Namespace:

Azure.Maps.Rendering

Assembly:

Azure.Maps.Rendering.dll

Package:

Azure.Maps.Rendering v2.0.0-beta.1

Source:

MapsRenderingClient.cs

Serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries. Returns the copyright information for a given tile. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid).

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Maps.Rendering.RenderCopyright>> GetCopyrightForTileAsync (Azure.Maps.Rendering.MapTileIndex mapTileIndex, bool includeText = true, System.Threading.CancellationToken cancellationToken = default);

abstract member GetCopyrightForTileAsync : Azure.Maps.Rendering.MapTileIndex * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Maps.Rendering.RenderCopyright>>
override this.GetCopyrightForTileAsync : Azure.Maps.Rendering.MapTileIndex * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Maps.Rendering.RenderCopyright>>

Public Overridable Function GetCopyrightForTileAsync (mapTileIndex As MapTileIndex, Optional includeText As Boolean = true, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RenderCopyright))

Parameters

mapTileIndex

MapTileIndex

Zoom level, and coordinate of the tile on zoom grid. The value of X and Y coordinate in renderTileIndex must be in the range [0, (2^zoom)-1]]. Please see Zoom Levels and Tile Grid for details.

includeText

Boolean

Boolean value to include or exclude textual data from response. If false, only images and country names will be in response.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<RenderCopyright>>

Exceptions

ArgumentNullException

mapTileIndex is null.