stopMonitoringGeofence()

Stop monitoring a specific geofence.

Syntax

1import { getGeofencingService } from 'lightning/mobileCapabilities';
2stopMonitoringGeofence(
3    id: string
4): Promise<void>;

Parameters

id—(Required) Unique ID assigned to a specific geofence.

Returns

A Promise object that resolves as void. If there’s an error, a rejected promise returns the error type of GeofenceServiceFailure.

Usage

Use this function to stop monitoring of a specific geofence.

1myGeofenceService.stopMonitoringGeofence(geofenceId)
2    .then(() => {
3        const msg = `Successfully stopped monitoring geofence for ID:${geofenceId}`;
4        console.log(msg);
5    })
6    .catch((error) => {
7        const msg = `Failed to stop monitoring:${JSON.stringify(error)}`;
8        console.log(msg);
9    });

Release Preview

This release is in preview. Features described here don't become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can't guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.