import { FetchOptions, HRN, OlpClientSettings, QuadKey } from "@here/olp-sdk-core"; /** * Parameters used to get a tile. */ export interface TileRequestParams { catalogHrn: HRN; settings: OlpClientSettings; layerId: string; layerType: "versioned" | "volatile"; catalogVersion?: number; } /** * 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); * * ``` */ export declare class TileRequest { private quadKey?; private billingTag?; private fetchOption; /** * A geometric area represented as a HERE tile. * * @param quadKey Addresses a tile in the quadtree. * @returns The updated [[TileRequest]] instance that you can use to chain methods. */ withTileKey(quadKey: QuadKey): 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]. * * @param tag The `BillingTag` string. * @return The updated [[TileRequest]] instance that you can use to chain methods. */ withBillingTag(tag: string): TileRequest; /** * Gets the configured [[QuadKey]] object for the request. * * @return The configured [[QuadKey]] object. */ getTileKey(): QuadKey | undefined; /** * Gets a billing tag to group billing records together. * * @return The `BillingTag` string. */ getBillingTag(): string | undefined; /** * 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. * * @param option The `FetchOption` enum. * * @return A reference to the updated `PartitionsRequest` instance. */ withFetchOption(option: FetchOptions): TileRequest; /** * 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. * * @return The fetch option. */ getFetchOption(): FetchOptions; }