Device.getLocation

函数式 API getCurrentLocation也可以这样使用同样的功能。

功能说明

获取设备的当前位置一次。用于地图、天气、查找门店等需要当前位置时。若要持续检测位置变化， Device.subscribeLocation请使用它。

如果没有位置权限， GetCurrentLocationPermissionError会发生。 Device.getLocation.getPermission() / Device.getLocation.openPermissionDialog()可以用来确认并请求权限。

类型

Device.getLocation(options: GetCurrentLocationOptions): Promise<Location>;

Params

enum Accuracy {
  Lowest = 1, // 误差范围约 3KM 以内
  Low = 2, // 误差范围约 1KM 以内
  Balanced = 3, // 误差范围数百米以内
  High = 4, // 误差范围约 10M 以内
  Highest = 5,
  BestForNavigation = 6,
}

type GetCurrentLocationOptions = {
  accuracy: Accuracy;
};

Response

type Location = {
  accessLocation?: "FINE" | "COARSE"; // 仅 Android
  timestamp: number;
  coords: {
    latitude: number;
    longitude: number;
    altitude: number;
    accuracy: number;
    altitudeAccuracy: number;
    heading: number;
  };
};

错误

错误会以类的形式抛出 — error instanceof GetCurrentLocationPermissionError来识别。该类可在 @apps-in-toss/web-framework中导入。

错误类	说明
GetCurrentLocationPermissionError	表示位置权限被拒绝。 Device.getLocation.openPermissionDialog()可以重新请求。

示例代码

import {
  Accuracy,
  Device,
  GetCurrentLocationPermissionError,
} from "@apps-in-toss/web-framework";

async function showCurrentPosition() {
  try {
    const location = await Device.getLocation({ accuracy: Accuracy.Balanced });
    console.log(location.coords.latitude, location.coords.longitude);
  } catch (error) {
    if (error instanceof GetCurrentLocationPermissionError) {
      console.warn("没有位置权限。");
      return;
    }
    console.error(error);
  }
}

document
  .getElementById("get-location")
  .addEventListener("click", showCurrentPosition);