Class: Service7

H .service .traffic.Service7

new H.service.traffic.Service7 (opt_options)

This class encapsulates the HERE Traffic API v7 in a service stub, providing methods to access its resources.

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#getTrafficService on a platform instance.

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

Throws:

Example

// Assumption: the platform is instantiated
platform.getTrafficService(null, 7).requestIncidentsByArea(
  {
    in: "circle:52.5189,13.4158;r=15000", // traffic incidents in Berlin within a 15km radius
    locationReferencing: 'shape'
  },
  console.log,
  console.error
);

Extends

H.service.Service

Members

H.service.traffic.Service7.CONFIG_KEY string 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

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

requestFlowByArea (params, onResult, onError)H.util.ICancelable

This method requests traffic flow information within a specified area

Please refer to the Traffic API v7 documentation for information on available parameters and the response object structure.

Name	Type	Description
`params`	H.service.ServiceParameters	service parameters to be added to the request
`onResult`	function(H.service.ServiceResult)	callback to handle a service response
`onError`	function(Error)	callback to handle a communication error

Returns:

Type	Description
H.util.ICancelable	a handle that allows to cancel the request.

requestIncidentById (originalId, params, onResult, onError)H.util.ICancelable

This method requests traffic incidents based on the service parameters provided.

Please refer to the Traffic API v7 documentation for information on available parameters and the response object structure.

Name	Type	Description
`originalId`	string	Identifier of the first traffic incident in a chain of updates
`params`	H.service.ServiceParameters	service parameters to be added to the request
`onResult`	function(H.service.ServiceResult)	callback to handle a service response
`onError`	function(Error)	callback to handle a communication error

Returns:

Type	Description
H.util.ICancelable	a handle that allows to cancel the request.

requestIncidentsByArea (params, onResult, onError)H.util.ICancelable

This method requests traffic incident information within a specified area

Please refer to the Traffic API v7 documentation for information on available parameters and the response object structure.

Name	Type	Description
`params`	H.service.ServiceParameters	service parameters to be added to the request
`onResult`	function(H.service.ServiceResult)	callback to handle a service response
`onError`	function(Error)	callback to handle a communication error

Returns:

Type	Description
H.util.ICancelable	a handle that allows to cancel the request.