TileRequest
Methods
get
- get
Fetch Option(): FetchOptions
-
Gets the fetch option that controls how requests are handled.
The default option is
OnlineIfNotFound. It queries the network if the requested resource is not in the cache.Returns FetchOptionsThe fetch option.
with
- with
Billing Tag(tag: string): TileRequest
-
An optional free-form tag that is used for grouping billing records together.
If supplied, it must be 4–16 characters long and contain only alphanumeric ASCII characters [A–Za–z0–9].
ParametersReturns TileRequestThe updated TileRequest instance that you can use to chain methods.
with
- with
Fetch Option(option: FetchOptions): TileRequest
-
Sets the fetch option that you can use to set the source from which data should be fetched.
see
getFetchOption()for information on usage and format.Parameters-
option: FetchOptions
The
FetchOptionenum.
Returns TileRequestA reference to the updated
PartitionsRequestinstance. -
with
- with
Tile Key(quadKey: QuadKey): TileRequest
-
A geometric area represented as a HERE tile.
Parameters-
quadKey: QuadKey
Addresses a tile in the quadtree.
Returns TileRequestThe updated TileRequest instance that you can use to chain methods.
-
Prepares information for calls to get the tile blob data by the tile key.
This class works only with versioned and volatile layers where the partitioning scheme is HERE Tile.
You can initialize the request class once for a specific catalog, layer, and version (@see TileRequestParams) and use it many times to get the a tile.
example
const params: TileRequestParams = {settings: "% your `OlpClientSettings` instance % ", catalogHrn: "% the HRN instance of your catalog %", layerId: "% your layer ID %", layerType: "% versioned or volatile %", catalogVersion: "% the catalog version; for versioned layers, the latest version is used by default %"}
const request = new TileRequest(params);
const requestForTile1 = request.withTileKey(yourTileKey1);
const requestForTile2 = request.withTileKey(yourTileKey2);