This class provides a functionality for the geofencing use case of 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#getGeofencingService 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.getGeofencingService();
Extends
Members
-
The property name to use when specifying options for this service within the
H.service.Platform.Options#servicesConfig. -
List of available entry points. At the moment only proximity search entry point is available.
Properties:
Name Description SEARCH_PROXIMITY
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
removeEventListenerordisposeon the given object when you no longer need it.Name Type Description typestring The name of the event
handlerfunction An event handler function
opt_captureboolean optional trueindicates that the method should listen in the capture phase (bubble otherwise)opt_scopeObject 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
EventTargetobject is being disposed.Name Type Description callbackfunction The callback function.
opt_scopeObject optional An optional scope for the callback function
-
dispatchEvent (evt) inherited
-
This method dispatches an event on the
EventTargetobject.Name Type Description evtH.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
EventTargetmay 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
EventTargetinstance.Name Type Description typestring The name of the event
handlerfunction A previously added event handler
opt_captureboolean optional trueindicates that the method should listen in the capture phase (bubble otherwise)opt_scopeObject optional An object defining the scope for the handler function
-
request (entryPoint, params, onResult, onError)H.util.ICancelable Deprecated : since 3.1.63.0
-
This method fetches resource with the provided name from the HERE Fleet Telematics API
Name Type Description entryPointH.service.extension.geofencing.Service.EntryPoint The entry point of the HERE Fleet Telematics API.
paramsH.service.ServiceParameters A key-value map of query parameters to use for the request.
onResultfunction(H.service.ServiceResult) The callback which is called when result is returned
onErrorfunction(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 a handle that allows to cancel the request. Example
// Search for geo fence geometries within a given radius around the asset position // Assumption: the platform is instantiated var fleetService = platform.getGeofencingService(); fleetService.request( H.service.extension.geofencing.Service.EntryPoint.SEARCH_PROXIMITY, { 'layer_ids': ['LAYER1', 'LAYER2'], 'proximity': '52.53,13.38,100', 'key_attributes': ['NAME', 'NAME'] }, console.log, console.error); -