Namespace: service

Classes

GeocodingService

GeofencingService

MapTileService

PlacesService

Platform

RoutingService

RoutingService8

SearchService

Service

Url

WaypointsSequenceService

Namespaces

extension

iml

metaInfo

omv

publicTransit

rasterTile

traffic

trafficVectorTile

Type Definitions

H.service.JsonpRequestHandle Object

This type represents a handle object.

Properties:

Name	Type	Description
id	number	The internal ID of the request
cancel	function	A callback function to be invoked to cancel the request

H.service.Options Object

This type encapsulates configuration (initialization) options for an instance of a service.

Properties:

Name	Type	Argument	Description
baseUrl	H.service.Url	<optional>	The base URL of the service. If supplied, it overrides all defaults (either coming from platform or service internals) including authentication params.
subDomain	string	<optional>	The subdomain of the service relative to the base URL.
path	string	<optional>	The path of the service.
headers	Object	<optional>	A map of HTTP headers to be sent with each request made by the service.

H.service.ServiceParameters Object.<string, *>

This type encapsulates URL parameters to be sent to a HERE platform service.

When calling HERE REST APIs, additional URL parameters can be sent by providing an object parameter which contains URL parameters in key-value format, where keys are URL parameter names and the values are the parameter values.

Note: The object assumes that values are in string format.

Example

serviceParameters = {
  paramA: 'valueA',
  paramB: 'valueB'
}

H.service.ServiceResult Object

This type encapsulates a response object provider by a HERE platform service. The structure of a service response object is specific to each service.

H.service.TileProviderOptions Object

This type defines options which are used to initialize a tile provider.

Properties:

Name	Type	Argument	Description
crossOrigin	string	<optional> <nullable>	The value to use for the crossOrigin attribute of the tile images, if omitted the attribute is set to "anonymous". For more details see MDN web docs.
headers	Object	<optional>	A map of HTTP headers to be sent with each request made by the provider.