Represents a point in a rectangle as a ratio of this rectangle’s width and height.

An Anchor2D keyframe. A keyframe consists of a value and an animation duration.

Represents an angle independent of the unit of measurement.

Represents angle ranges as a circular sector by using an absolute start angle and a relative range angle called extent. They both define a sector on a circle. All angles are in degrees and are clockwise-oriented. By default, the AngleRange represents the entire circle, the value is in the range of [0, 360]. Values will be corrected during construction using normalization for the start angle and clamping for the extent angle, ensuring a valid range for all possible inputs.

Use the authentication class to authenticate and retrieve a secure token that can be used with other HERE services.

Protocol passed to Authentication.authenticate(SDKNativeEngine). This protocol is called on the main thread asynchronously when an authenticate call has completed.

Authentication exception

This is a bearer authentication mode which adds or does not add a header (“Authorization”, “Bearer $Token”) to each online request of the module the object is added to. The token (if used) can be provided or is retrieved via key/secret from a dedicated backend.

Represents image link to the company’s logo. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

A method which is called on the main thread when SDKCache.clearCache(...) has been completed.

Indicates the official directional identifier assigned to this road. The direction indicates the same information as on the signpost shield text: For example, if it is “101 West”, the direction contains WEST.

Using this class you can configure in the SDKOptions, how the SDKNativeEngine should access, use and store the data for the desired catalog.

Using this class, you can access default catalogs on the HERE platform and also custom catalogs such as for self-hosted or BYOD (bring your own data) use cases.

For information on how the user can identify a catalog on the HERE platform, see DesiredCatalog For further information about catalogs and related concepts see CatalogIdentifier.

Note: This API is only applicable for the Navigate license.

This class is used to identify any catalog in the HERE platform.

A catalog is a storage-representation to store map data on the HERE platform. The data inside a catalog is divided into layers, where each layer consists of datasets with similar functional attributes in the physical world. For example, there can be a layer for road-topology, a layer for road-attributes (such as speed limits) and a layer for places and business addresses. All these layers, in different geographic regions, can be grouped together into a catalog to create a representation of the world we live in, called HERE map. It can be also used to render a MapView. Each geographic region is cut into geospatial tiles for efficient search, map display, routing, map matching, and driver warnings. Each tile partitions the map data (in one or more layers, depending on the product) in the geolocation of that specific tile. The data inside a catalog is logically managed and access controlled as a single set. If you have any data that you want to bring to the HERE platform, you need a catalog to contain it. For additional information about catalogs, and related concepts of data representation on the HERE platform, refer to the Data API and Introduction to Mapping Concepts

Represents default HERE catalog types.

A class to control the catalog update process.

This is a class for capturing user’s intent for the desired catalog version to use in DesiredCatalog class.

You can request a specific or latest version of a catalog by calling the static functions CatalogVersionHint.specific(...) and CatalogVersionHint.latest(...) respectively. The HERE platform will make the best effort to provide an appropriate version for the catalog based on this version hint. Please take note that for the API CatalogVersionHint.specific(...) to function properly, it is essential that the mutable and persistent storage should be cleaned.

Custom collection implementation.

This enum represents country codes in accordance with the ISO 3166-1 standard using alpha-3 codes.

This enum represents the type of electric current

Protocol for storing arbitrary metadata types. By implementing this protocol, multiple object types can be stored as desired, simply by adding fields to the implementation that refer to those objects and then assigning an instance of the CustomMetadataValue derived class to a map item.

This class provides an interface to the user, to identify a catalog on the HERE platform, whose data he wants to access. The user can specify the HERE Resource Name (HRN) for the catalog along with a hint for the desired version. If the desired version is not available, the HERE platform will determine the best version to use for a specific catalog or result in error logs. For information on how to specify the catalog version, see CatalogVersionHint. For information about catalogs and related concepts see CatalogIdentifier.

This method will be called on the main thread when SDKNativeEngine.getDeviceId(...) has been completed.

Lists the available HERE SDK endpoints that can be customized with a custom backend base URL.

Specifies several options specific to different engines. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Identifier of the entity as provided by the external source

Represents a bounding rectangle aligned with latitude and longitude. Geographic area represented by this would be visualised as a rectangle when using a normal cylindrical projection (such as Mercator). The box has a maximum span of 360 degrees in longitude and 180 degrees in latitude direction. The box with equal values in longitude for the corners is considered as a span of 360 degrees. The box is considered empty if the latitude of the GeoBox.southWestCorner is larger than the the latitude of the GeoBox.northEastCorner.

Represents a circle area in 2D space.

Represents geographical coordinates in 3D space.

Represents geographical coordinates in 3D space. Unlike GeoCoordinates, its members can be undefined, allowing for APIs that update only the specified parts of geo coordinates.

A geographical area that wraps around a geographical polyline with a given distance. The corridor has round edges at the endpoints of the polyline. The distance from any point of the polyline to the closest border of the corridor is always the same.

Geodetic orientation with bearing, tilt and roll.

Describes geodetic orientation update with bearing and tilt. Updating an orientation value can be skipped by setting nil in an appriopriate field. For example, if one wants bearing not to be updated set it to nil.

Represents a GeoPolygon area as a series of geographic coordinates, and optionally, a list of inner boundaries (also known as holes). An instance of this class, initialized with appropriate vertices.

A list of geographic coordinates representing the vertices of a polyline. An instance of this class, initialized with appropriate vertices. Represents a GeoPolyline as a series of geographic coordinates.

Defines if a function on a GeoPolyline computes the operation starting from the beginning or from the end of GeoPolyline.vertices.

Instantiation error.

Instantiation error.

An integer range [min, max] with inclusive minimum and maximum value.

Junctions traversability of some traffic incident or flow section.

This enum represents language codes. The basic naming pattern consists of a 2-letter ISO 639-1 language code followed by a 2-letter ISO 3166-1 country code. Some language codes consist only of a language code, i.e. without a country code. When there is no ISO 639-1 language code, the related ISO 639-2 or ISO 639-3 language code is used. In case the script is specified, its ISO 15924 code is used.

A class to configure which layers should be enabled or disabled in the OCM map data. Disabling a layer allows to reduce the amount of data that will be downloaded or prefetched from the internet, for example, when panning the map view online or when downloading maps for offline use.

LayerConfiguration changes made via SDKOptions require sdk.maploader.MapUpdater to align previously downloaded content. To ensure that the changes in SDKOptions affect the map data, it is recommended to trigger a map update. Without calling mapUpdater.updateCatalog(...), the adjustments will apply only to future map downloads and will not impact the currently installed map data, either in the cache or in the persisted storage. Note that calling updateCatalog(...) will update the version, only when a map update is available in the catalog.

Notes

• The LayerConfiguration is only available for the Navigate licenses that contains the offline maps feature. It has no effect on other license.

Note that the RENDERING layer is a base layer that cannot be disabled: Therefore, it is not necessary to explicitly add the layer to a feature configuration - it will be always enabled.

• The LayerConfiguration cannot be set separately for a region, it will be applied globally for all regions that will be downloaded in the future.
• It is not possible to specify a separate LayerConfiguration for the map cache and offline maps. The LayerConfiguration will be always applied to both.
• If a LayerConfiguration is applied, then only the listed features will be enabled, all others will be disabled. For example, if you want to disable only one feature, then all other features need to be present, or they will be also disabled.

The LayerConfiguration controls which content will be subject of

• map download for features in enabledFeatures(),
• explicit prefetching using sdk.prefetcher.RoutePrefetcher, sdk.prefetcher.PolygonPrefetcher and implicit prefetching, such as when displaying a map view, for features in implicitlyPrefetchedFeatures().

Used to represent road number localized to specific language with optional direction and route type information.

The list of multiple names or titles for the same entity, possibly in different languages.

Used to represent text localized to specific language.

The list of multiple names or titles for the same entity, possibly in different languages.

Describes a location in the world at a given time.

This protocol should be implemented in order to receive notifications about location updates.

Indicates where the location was computed.

Tells whether the location was calculated on the same device running HERE SDK or received from an external source.

Example external sources: GNSS modules connected via serial (e.g., u-blox), or vehicle positioning systems.

Example internal sources: positions computed on the same phone or embedded device using integrated GNSS or sensor fusion components.

Technology or provider of the location.

This struct presents all the time data tied to a location, like an arrival or departure time. The time data is originally specified in RFC 3339, section 5.6 format. For example, “2022-03-23T16:07:31+01:00” in Cracow, Poland, i.e. a Central European Time (CET) location. Note that this struct doesn’t give any data on the tied location. The location should be derived from the context.

An interface to implement a listener to receive log messages.

This class provides functionality to enable/disable console logs as well as setting a custom log appender to receive log messages from the SDK.

Severity levels for log messages.

Holds metadata on behalf of a map item. An instance of this class can contain metadata items of varying types, such as String, Integer, Double, GeoCoordinates etc. and can also hold arbitrary metadata types by the use of the CustomMetadataValue protocol.

Different types of objects that can be stored in a Metadata class instance.

Structure to represent name-id pairs.

Network endpoint.

Network configuration to be used by SDKNativeEngine during the initialization.

Contains values of configurable parameters that are used in SDK. This is a BETA feature and thus there can be bugs and unexpected behavior.

Represents features that are allowed to consume online data when the HERE SDK’s offline mode is activated via SDKNativeEngine.isOfflineMode and/or SDKOptions.offlineMode.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents the type of electrical power. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Contains values of pedestrian profile. This is a BETA feature and thus there can be bugs and unexpected behavior.

Carries the result of picking a Carto POI (point of interest) object.

Protocol for task activities on the main thread.

Represents a point in 2D space. When this point is used to indicate coordinates on a view, then (0,0) will mark the top-left corner of the view.

Represents a point in 3D space.

The method will be called on the main thread when PolylineSimplifier.simplify(...) is finished.

Error code which specifies, what went wrong during PolylineSimplifier.simplify(...) operation.

PolylineSimplifier helps to reduce the number of points in the polyline by removing redundant elements using Douglas–Peucker algorithm, so that result stays within PolylineSimplifier.Options.

Typical use case is to perform input preparation step before invoking computationally heavy API. Such API have an upper limit on the input collection size and is subject to reduced performance when collection is huge. Examples of such API are:

• TrafficEngine methods which accept a GeoCorridor;
• RoutePrefetcher.prefetchGeoCorridor.

Proxy configuration for the HERE SDK network that is applied per request. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Represents a 2D rectangle defined by the origin and size.

Indicates the level of significance of a route in a range from 1 to 6. A value of 1 stands for the most major route and 6 the most minor. The route type indicates that the road’s name is actually a route number and in many countries is displayed in a shield symbol (e.g., Interstate and State routes in the U.S.). See https://developer.here.com/documentation/here-map-content-schema/dev_guide/topics_schema/streetname.routetype.html

Protocol that should be implemented by any class whose instances are intended to be executed by a thread.

The SDKBuildInformation class is designed to provide information about the SDK build.

A class to manage SDK Cache. Path for SDKCache is specified via SDKOptions.cachePath. SDKCache manages temporary downloaded map data during map interaction and follows LRU (least recently used) strategy to delete map data when cache size exceeds the specified SDKOptions.cacheSizeInBytes.

This class is used to initialize internals of the SDK. Usually shouldn’t be used directly.

Logging interface for Android/iOS platforms. These logs are under management of LogControl and should be used instead of platform-specific logging functions.

Holds internal services and configurations needed by various HERE SDK modules.

You can initialize the HERE SDK in two ways:

• Create a shared instance of the SDKNativeEngine with SDKNativeEngine.makeSharedInstance().
• Create individual instances of the SDKNativeEngine via SDKNativeEngine(). Note that this does not automatically set a shared instance.

Undocumented

SDKOptions provide an alternative way to set or update the HERE SDK credentials and other parameters at runtime to initialize the SDKNativeEngine.

The SDKVersion represents version information for an SDK product. It encapsulates various attributes related to the version, including product variant, version details and backend configuration. Please note, sdk.core.engine.SDKBuildInformation can be used to get SDKVersion.

Represents the size of a 2D structure.

The method will be called on the main thread when a task call has been completed.

Handle used for the manipulation of the task.

This enum represents that a task has been completed. Refer to TaskCompletionHandler for more details.

Initializes threading support on native side.

Used to indicate a time period of one or more intervals in GDF specification. For example: -*(M3f21h2){M9}(M11f12h2){-M9}+(h15){h2}(h20){h2}, which represents: March 2nd Sunday 02h:00m for 9 months ONLY DURING November 1st Sunday 02h:00m from 9 months ago BUT NOT from 15:00 to 17:00 OR 20:00 to 22:00

The operator * represents reccuring occurrence, + represents a logical OR operation and - represents exclusion meaning, BUT NOT operations.

This example string represents a time period that meets the following criteria:

• M3f21h2: M3 denotes third month of the year, i.e. March, f2 stands for the second Sunday of the month (as “f” might indicate “first”, “second”, “third”, etc.), 1 stands for the day of the week (1…7, Day of week, Sunday = day 1), and h2 represents the hour of the day (02:00) in 24 hour format.
• {M9}: This denotes “for 9 months”, with “M9” standing for nine months. The brackets {} indicate a duration.
• M11f12h2: M11 denotes 11th month of the year, i.e. November, f1 stands for the first Monday of the month, 2 stands for the day of the week (1…7, Day of week, Monday = day 2), and h2 represents the hour of the day (02:00) in 24 hour format.
• {-M9}: This denotes “9 months ago from the current stated time”, with “-M9” standing for nine months in the past.
• (h15){h2}(h20){h2}: 15:00 to 17:00 OR 20:00 to 22:00 The brackets {} denotes duration, and the negative sign - represents a past duration.

Note: The time period is a logical AND (&&) combination of two components or points in time and it only applies if a point in time is in both components.

For more advanced examples of TimeRule see here.

Contains values of transport profile. This is a BETA feature and thus there can be bugs and unexpected behavior.

Represents the available unit systems(imperial/metric).

A class that gathers statistics of the HERE SDK network usage for uploaded and downloaded data.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.