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에서 import할 수 있어요.

에러 클래스	설명
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);