Class: Service

H .service .extension .customRoute.Service

new H.service.extension.customRoute.Service (opt_options) Deprecated : since 3.1.30.12

This class provides a functionality for the route calculation using custom data powered by the HERE Fleet Telematics API

It's not allowed to call the constructor directly (an IllegalOperationError is thrown). Instead an instance of this Service can be retrieved by calling the factory method H.service.Platform#getCustomRoutingService on a platform instance.

Name	Type	Description
`opt_options`	H.service.Options	optional Configuration options for the service

Throws:

Example

// Assumption: the platform is instantiated
fleetService = platform.getCustomRoutingService();

Extends

H.service.Service

Members

H.service.extension.customRoute.Service.CONFIG_KEY string Deprecated : since 3.1.63.0 staticconstant

The property name to use when specifying options for this service within the H.service.Platform.Options#servicesConfig.

Methods

addEventListener (type, handler, opt_capture, opt_scope) inherited

This method adds a listener for a specific event.

Note that to prevent potential memory leaks, you must either call removeEventListener or dispose on the given object when you no longer need it.

Name	Type	Description
`type`	string	The name of the event
`handler`	function	An event handler function
`opt_capture`	boolean	optional `true` indicates that the method should listen in the capture phase (bubble otherwise)
`opt_scope`	Object	optional An object defining the scope for the handler function

addOnDisposeCallback (callback, opt_scope) inherited

This method adds a callback which is triggered when the EventTarget object is being disposed.

Name	Type	Description
`callback`	function	The callback function.
`opt_scope`	Object	optional An optional scope for the callback function

calculateRoute (params, onResult, onError)H.util.ICancelable Deprecated : since 3.1.63.0

This method sends a route calculation request to the HERE Fleet Telematics API and calls the onResult callback function once the service response becomes available (providing a H.service.ServiceResult object) or the onError callback if a communication error occurred.

Please refer to the API Documentation for information on available parameters and the response object structure.

Name	Type	Description
`params`	H.service.ServiceParameters	Contains the service parameters to be sent with the routing request.
`onResult`	function(H.service.ServiceResult)	The callback which is called when result is returned
`onError`	function(Error)	The callback which is called when error occurred (i.e request timeout, or server error)

Throws:

If passed arguments are invalid

Returns:

Type	Description
H.util.ICancelable

dispatchEvent (evt) inherited

This method dispatches an event on the EventTarget object.

Name	Type	Description
`evt`	H.util.Event \| string	An object representing the event or a string with the event name

dispose () inherited

This method removes listeners from the given object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.

getUrl ()H.service.Url inherited

This method returns the configured service URL.

Returns:

Type	Description
H.service.Url

removeEventListener (type, handler, opt_capture, opt_scope) inherited

This method removes a previously added listener from the EventTarget instance.

Name	Type	Description
`type`	string	The name of the event
`handler`	function	A previously added event handler
`opt_capture`	boolean	optional `true` indicates that the method should listen in the capture phase (bubble otherwise)
`opt_scope`	Object	optional An object defining the scope for the handler function