@capacitor/geolocation
地理定位 API 提供了简便的方法，用于通过 GPS 获取和追踪设备的当前位置，并在可用时提供海拔、朝向和速度信息。
安装
npm install @capacitor/geolocation
npx cap sync
iOS
Apple 要求在 Info.plist 中为位置信息指定隐私描述：
NSLocationAlwaysAndWhenInUseUsageDescription（隐私 - 始终和在应用使用时访问位置的使用说明）NSLocationWhenInUseUsageDescription（隐私 - 在应用使用时访问位置的使用说明）
[!注意] 此 Capacitor 插件不直接支持后台地理定位。但它依赖于
ion-ios-geolocation，该组件可以在后台报告 位置。因此，Apple 要求你在Info.plist中包含NSLocationAlwaysAndWhenInUseUsageDescription条目。由于此权限 提示不会向用户显示，你可以安全地使用与NSLocationWhenInUseUsageDescription相同的描述字符串。
阅读 iOS 指南 中的 配置 Info.plist 部分，了解更多关于在 Xcode 中设置 iOS 权限的信息。
Android
此插件需要将以下权限添加到你的 AndroidManifest.xml：
<!-- 地理定位插件 -->
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-feature android:name="android.hardware.location.gps" />
前两个权限请求获取粗略和精确的位置数据，最后一行是可选的，但如果你的应用需要 GPS 才能运行，则是必需的。你也可以省略它，但请注意，这可能导致你的应用安装在缺少 GPS 硬件的设备上。
阅读 Android 指南 中的 设置权限 部分，了解更多关于设置 Android 权限的信息。
API
有关错误代码列表，请参阅 错误
getCurrentPosition(...)
getCurrentPosition(options?: PositionOptions | undefined) => Promise<Position>
获取设备的当前 GPS 位置
| 参数 | 类型 |
|---|---|
options | |
返回值:
Promise<Position>自版本: 1.0.0
watchPosition(...)
watchPosition(options: PositionOptions, callback: WatchPositionCallback) => Promise<CallbackID>
设置位置变化的监听器。请注意，监听位置变化 可能会消耗大量电量。仅在需要时智能地监听。
| 参数 | 类型 |
|---|---|
options | |
callback | |
返回值: Promise<string>
自版本: 1.0.0
clearWatch(...)
clearWatch(options: ClearWatchOptions) => Promise<void>
清除指定的监听器
| 参数 | 类型 |
|---|---|
options | |
自版本: 1.0.0
checkPermissions()
checkPermissions() => Promise<PermissionStatus>
检查位置权限。如果系统位置服务被禁用，将抛出错误。
返回值:
Promise<PermissionStatus>自版本: 1.0.0
requestPermissions(...)
requestPermissions(permissions?: GeolocationPluginPermissions | undefined) => Promise<PermissionStatus>
请求位置权限。如果系统位置服务被禁用，将抛出错误。
在 Web 上不可用。
| 参数 | 类型 |
|---|---|
permissions | |
返回值:
Promise<PermissionStatus>自版本: 1.0.0
Interfaces
Position
| 属性 | 类型 | 描述 | 自版本 |
|---|---|---|---|
timestamp | number | 坐标的创建时间戳 | 1.0.0 |
coords | { latitude: number; longitude: number; accuracy: number; altitudeAccuracy: number | null; altitude: number | null; speed: number | null; heading: number | null; } | GPS 坐标及数据精度 | 1.0.0 |
PositionOptions
| 属性 | 类型 | 描述 | 默认值 | 自版本 |
|---|---|---|---|---|
enableHighAccuracy | boolean | 高精度模式（如 GPS，如果可用）。在 Android 12+ 设备上，如果用户未授予 ACCESS_FINE_LOCATION 权限（可通过 location 别名检查），此设置将被忽略。 | false | 1.0.0 |
timeout | number | 位置更新的最大等待时间（毫秒）。在 Android 上，自插件版本 7.1.0 起，它也用于确定 watchPosition 的位置更新间隔。 | 10000 | 1.0.0 |
maximumAge | number | 可接受的缓存位置的最大年龄（毫秒） | 0 | 1.0.0 |
minimumUpdateInterval | number | 位置更新的最小间隔（毫秒）。如果位置更新的速度比此间隔快，则只有在自上次位置更新以来最小更新间隔已过期时才会进行更新。此参数仅适用于 Android。它对 iOS 或 Web 平台没有影响。 | 5000 | 6.1.0 |
ClearWatchOptions
| 属性 | 类型 |
|---|---|
id | |
PermissionStatus
| 属性 | 类型 | 描述 | 自版本 |
|---|---|---|---|
location | | location 别名的权限状态。在 Android 上，它请求/检查 ACCESS_COARSE_LOCATION 和 ACCESS_FINE_LOCATION 权限。在 iOS 和 Web 上，它请求/检查位置权限。 | 1.0.0 |
coarseLocation | | coarseLocation 别名的权限状态。在 Android 上，它请求/检查 ACCESS_COARSE_LOCATION。在 Android 12+ 上，用户可以选择 Approximate location（ACCESS_COARSE_LOCATION）或 Precise location（ACCESS_FINE_LOCATION），因此如果应用不需要高精度，可以使用此别名。在 iOS 和 Web 上，其值与 location 别名相同。 | 1.2.0 |
GeolocationPluginPermissions
| 属性 | 类型 |
|---|---|
permissions | GeolocationPermissionType[] |
Type Aliases
WatchPositionCallback
(position: Position | null, err?: any): void
CallbackID
string
PermissionState
'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'
GeolocationPermissionType
'location' | 'coarseLocation'
错误
插件在原生 Android 和 iOS 上返回特定的错误代码。Web 不遵循此错误标准。
下表列出了所有插件错误：
| 错误代码 | 平台 | 错误信息 |
|---|---|---|
| OS-PLUG-GLOC-0002 | Android, iOS | 尝试获取位置时出错。 |
| OS-PLUG-GLOC-0003 | Android, iOS | 位置权限请求被拒绝。 |
| OS-PLUG-GLOC-0004 | iOS | 'getCurrentPosition' 输入参数无效。 |
| OS-PLUG-GLOC-0005 | iOS | 'watchPosition' 输入参数无效。 |
| OS-PLUG-GLOC-0006 | iOS | 'clearWatch' 输入参数无效。 |
| OS-PLUG-GLOC-0007 | Android, iOS | 位置服务未启用。 |
| OS-PLUG-GLOC-0008 | iOS | 应用使用位置服务的权限受限。 |
| OS-PLUG-GLOC-0009 | Android | 启用位置的请求被拒绝。 |
| OS-PLUG-GLOC-0010 | Android | 无法在指定时间内获取位置。尝试增加超时时间。 |
| OS-PLUG-GLOC-0011 | Android | 超时时间必须为正值。 |
| OS-PLUG-GLOC-0012 | Android | 未找到 WatchId。 |
| OS-PLUG-GLOC-0013 | Android | 必须提供 WatchId。 |
| OS-PLUG-GLOC-0014 | Android | Google Play 服务错误，用户可解决。 |
| OS-PLUG-GLOC-0015 | Android | Google Play 服务错误。 |
| OS-PLUG-GLOC-0016 | Android | 位置设置错误。 |