`isAvailable()`

Determines whether location service functionality is available.

Syntax

1import { getLocationService } from 'lightning/mobileCapabilities';
2isAvailable(): Boolean

Parameters

None.

Returns

Returns true when used on a supported device, and false otherwise.

Usage

Use this function to disable or hide location-based features on platforms where location services aren’t supported. For example:

1handleFindMeClick() {
2  const myLocationService = getLocationService();
3  if (myLocationService.isAvailable()) {
4    // Perform location-based requests
5  }
6  else {
7    // LocationService isn’t available
8     // Not running on hardware with GPS, or not inside mobile app
9    // Handle with message, error, beep, and so on
10  }
11}

See Also

LocationService Example

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.