Location APIs

getLocation

Get the current geographical location of the user.

Overview

my.getLocation retrieves the current geographical location of the user, including longitude, latitude, and accuracy information.

Sample Code

my.getLocation({
  success: (res) => {
    my.hideLoading();
    console.log(res);
    // Update your location data
    hasLocation = true;
    location = formatLocation(res.longitude, res.latitude);
  },
  fail: () => {
    my.hideLoading();
    my.alert({ title: 'location failed' });
  },
});

Parameters

PropertyTypeRequiredDescription
cacheTimeoutNumberNoLongitude and latitude location cache expiry time in seconds. Default is 30s. Use of cache can speed up location process. Re-location is done upon cache expiry.
typeNumberNo0: default, get the longitude and latitude.
successFunctionNoCallback function upon call success.
failFunctionNoCallback function upon call failure.
completeFunctionNoCallback function upon call completion (to be executed upon either call success or failure).

Success Callback Function

The incoming parameter is of the Object type with the following attributes:

PropertyTypeDescription
longitudeStringLongitude.
latitudeStringLatitude.
accuracyStringAccuracy, in m.

Error Code

ErrorDescriptionSolution
11Make sure the location related right has been enabled.Prompt the user to enable location permission.
12Network abnormity, try again later.Prompt the user to check the current network.
13Location failure, try again later.-
14Service location timeout.Prompt the user to try again.

Usage Notes

  • Requires location permission to be enabled
  • The cacheTimeout parameter can improve performance by caching location data
  • Default cache expiry is 30 seconds
  • Returns longitude, latitude, and accuracy in meters
  • Network connectivity is required for location services