Class: GeofencingService

H .service.GeofencingService

new H.service.GeofencingService (opt_options)

This class encapsulates the HERE Geofencing API v8 as a service stub.

It is 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#getGeofencingService on a platform instance.

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

Throws:

in case of invalid specified options.

Type

H.lang.InvalidArgumentError
when trying to create an instance using constructor.

Type

H.lang.IllegalOperationError

Example

// Assumption: the platform is instantiated
const geofencingService = platform.getGeofencingService(null, 8);
geofencingService.geofence({
     layers: "layer1,layer2",
     in: "point:52.52144,13.41265;r=30"
  },
  console.log,
  console.error
);

Extends

H.service.Service

Members

H.service.GeofencingService.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

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

This method sends a geofence delete request to HERE Geofencing API v8 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 HERE Geofencing API v8 documentation for information on available parameters and the response object structure.

Name	Type	Description
`params`	H.service.ServiceParameters	Contains service parameters to be sent with the request.
`onResult`	function(H.service.ServiceResult)	A callback function to be called once the API provides a response to the request.
`onError`	function(Error)	A callback function to be called if a communication error occurs during the request.

Returns:

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

Example

// Assumption: the platform is instantiated.
// Get an instance of the Geofencing service.
const service = platform.getGeofencingService(null, 8);
service.delete({
     layerId: "appID.mapName.layerName",
     storage: "updatable"
  },
  console.log,
  console.error
);

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.

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

This method sends a geofence request to the HERE Geofencing API v8 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 HERE Geofencing API v8 documentation for information on available parameters and the response object structure.

Name	Type	Description
`params`	H.service.ServiceParameters	Contains service parameters to be sent with the request.
`onResult`	function(H.service.ServiceResult)	A callback function to be called once the API provides a response to the request.
`onError`	function(Error)	A callback function to be called if a communication error occurs during the request.

Returns:

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

Example

// Assumption: the platform is instantiated.
// Get an instance of the Geofencing service
let service = platform.getGeofencingService(null, 8);
service.geofence({
     layers: "layer1,layer2",
     in: "point:52.52144,13.41265;r=30"
  },
  console.log,
  console.error
);

getUrl ()H.service.Url inherited

This method returns the configured service URL.

Returns:

Type	Description
H.service.Url

modify (params, data, onResult, onError)H.util.ICancelable

This method sends a modify request to HERE Geofencing API v8 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 HERE Geofencing API v8 documentation for information on available parameters and the response object structure.

Name	Type	Description
`params`	H.service.ServiceParameters	Contains service parameters to be sent with the request.
`data`	Blob	The payload to send.
`onResult`	function(H.service.ServiceResult)	A callback function to be called once the API provides a response to the request.
`onError`	function(Error)	A callback function to be called if a communication error occurs during the request.

Throws:

in case of invalid data.

Returns:

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

Example

// Assumption: the platform is instantiated.
// Get an instance of the Geofencing service.
const service = platform.getGeofencingService(null, 8);
service.modify({
    layerId: 'appID.mapName.layerName',
    action: 'update'
  },
  fileBlob,
  console.log,
  console.error
);

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

upload (params, data, onResult, onError)H.util.ICancelable

This method sends a upload request to HERE Geofencing API v8 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 HERE Geofencing API v8 documentation for information on available parameters and the response object structure.

Name	Type	Description
`params`	H.service.ServiceParameters	Contains service parameter to be sent with the request.
`data`	Blob	The payload to send.
`onResult`	function(H.service.ServiceResult)	A callback function to be called once the API provides a response to the request.
`onError`	function(Error)	A callback function to be called if a communication error occurs during the request.

Throws:

in case of invalid data.

Returns:

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

Example

// Assumption: the platform is instantiated.

// Get an instance of the Geofencing service
const service = platform.getGeofencingService(null, 8);
service.upload({
    layerId: 'appID.mapName.layerName',
    level: 10
  },
  fileBlob,
  console.log,
  console.error
);