@doubao-apps/ai 0.0.32 → 0.0.33

package/dist/contexts/doubao-apps-dev/references/reference/open-api/02-/345/256/232/344/275/215.md

@@ -1,359 +0,0 @@
-# Open API: 定位
-
-获取设备当前的地理位置信息。
-
-[返回目录](./README.md) | [返回速查](../open-api.md)
-
-## 速查
-
-| API | 说明 |
-| --- | --- |
-| [getLocation](#getlocation) | 获取设备当前的地理位置信息。<br><br>可能涉及定位授权。 |
-| [chooseLocation](#chooselocation) | 打开地图选择位置。 |
-| [openLocation](#openlocation) | 使用地图查看位置。 |
-| [startLocationUpdate](#startlocationupdate) | 开始接收位置更新。<br><br>需配对调用 stopLocationUpdate。 |
-| [stopLocationUpdate](#stoplocationupdate) | 停止接收位置更新。 |
-| [onLocationChange](#onlocationchange) | 注册地理位置变化回调。<br><br>返回 void，不是 Promise。 |
-| [offLocationChange](#offlocationchange) | 取消注册地理位置变化回调。<br><br>返回 void，不是 Promise。 |
-| [onLocationChangeError](#onlocationchangeerror) | 注册位置更新异常回调。<br><br>返回 void，不是 Promise。 |
-| [offLocationChangeError](#offlocationchangeerror) | 取消注册位置更新异常回调。<br><br>返回 void，不是 Promise。 |
-
-## API 详情
-
-<a id="getlocation"></a>
-### getLocation()
-
-> **getLocation**(`params`?): `Promise`\<[`GetLocationResponse`](#getlocationresponse)\>
-
-获取设备当前的地理位置信息。
-
-#### Parameters
-
-• **params?**: [`GetLocationParams`](#getlocationparams)
-
-#### Returns
-
-`Promise`\<[`GetLocationResponse`](#getlocationresponse)\>
-
-返回一个 Promise，成功时解析为包含地理位置信息的对象，包含：
-  - `latitude`: number - 纬度。
-  - `longitude`: number - 经度。
-  - `timestamp`: string - 时间戳。
-  - `speed`: number - 行进速度，单位：米/秒。
-  - `accuracy`: number - 定位精度，单位：米。
-  参考 [GetLocationResponse](#getlocationresponse)。
-
-#### Throws
-
-如果调用失败（例如，用户拒绝权限、定位服务关闭等），则抛出此错误。
-
-#### Remarks
-
-可能涉及定位授权。
-
-#### Example
-
-```typescript
-import { getLocation } from '@byted-doubao-apps/framework';
-
-async function fetchLocation() {
-  try {
-    const locationData = await getLocation();
-    console.log('纬度:', locationData.latitude);
-    console.log('经度:', locationData.longitude);
-    console.log('时间戳:', locationData.timestamp);
-    console.log('行进速度:', locationData.speed);
-    console.log('定位精度:', locationData.accuracy);
-  } catch (error) {
-    console.error('获取位置失败:', error);
-    // 处理错误，例如提示用户开启定位权限
-  }
-}
-
-fetchLocation();
-```
-
-<a id="chooselocation"></a>
-### chooseLocation()
-
-> **chooseLocation**(`params`?): `Promise`\<[`ChooseLocationResponse`](#chooselocationresponse)\>
-
-打开地图选择位置。
-
-#### Parameters
-
-• **params?**: [`ChooseLocationParams`](#chooselocationparams)
-
-#### Returns
-
-`Promise`\<[`ChooseLocationResponse`](#chooselocationresponse)\>
-
-<a id="openlocation"></a>
-### openLocation()
-
-> **openLocation**(`params`): `Promise`\<`object`\>
-
-使用地图查看位置。
-
-#### Parameters
-
-• **params**: [`OpenLocationParams`](#openlocationparams)
-
-#### Returns
-
-`Promise`\<`object`\>
-
-<a id="startlocationupdate"></a>
-### startLocationUpdate()
-
-> **startLocationUpdate**(`params`?): `Promise`\<`object`\>
-
-开始接收位置更新。
-
-#### Parameters
-
-• **params?**: [`StartLocationUpdateParams`](#startlocationupdateparams)
-
-#### Returns
-
-`Promise`\<`object`\>
-
-#### Remarks
-
-需配对调用 stopLocationUpdate。
-
-<a id="stoplocationupdate"></a>
-### stopLocationUpdate()
-
-> **stopLocationUpdate**(`params`?): `Promise`\<`object`\>
-
-停止接收位置更新。
-
-#### Parameters
-
-• **params?**
-
-#### Returns
-
-`Promise`\<`object`\>
-
-<a id="onlocationchange"></a>
-### onLocationChange()
-
-> **onLocationChange**(`callback`): `void`
-
-注册地理位置变化回调。
-
-#### Parameters
-
-• **callback**: [`LocationChangeListener`](#locationchangelistener)
-
-#### Returns
-
-`void`
-
-<a id="offlocationchange"></a>
-### offLocationChange()
-
-> **offLocationChange**(`callback`?): `void`
-
-取消注册地理位置变化回调。
-
-#### Parameters
-
-• **callback?**: [`LocationChangeListener`](#locationchangelistener)
-
-#### Returns
-
-`void`
-
-<a id="onlocationchangeerror"></a>
-### onLocationChangeError()
-
-> **onLocationChangeError**(`callback`): `void`
-
-注册位置更新异常回调。
-
-#### Parameters
-
-• **callback**: [`LocationChangeErrorListener`](#locationchangeerrorlistener)
-
-#### Returns
-
-`void`
-
-<a id="offlocationchangeerror"></a>
-### offLocationChangeError()
-
-> **offLocationChangeError**(`callback`?): `void`
-
-取消注册位置更新异常回调。
-
-#### Parameters
-
-• **callback?**: [`LocationChangeErrorListener`](#locationchangeerrorlistener)
-
-#### Returns
-
-`void`
-
-## 相关类型
-
-<a id="getlocationparams"></a>
-### GetLocationParams
-
-#### Properties
-
-##### maxCacheMs?
-
-> `optional` **maxCacheMs**: `number`
-
-缓存时间，单位毫秒，默认为0
-
-##### mode?
-
-> `optional` **mode**: `number`
-
-定位模式
-0：低功耗
-1：仅设备
-2：高精度（默认）
-
-##### source?
-
-> `optional` **source**: `string`
-
-调用业务方
-
-##### timeoutMs?
-
-> `optional` **timeoutMs**: `number`
-
-超时时间，单位毫秒，默认 30000
-
-<a id="getlocationresponse"></a>
-### GetLocationResponse
-
-#### Properties
-
-##### accuracy
-
-> **accuracy**: `number`
-
-定位精度，单位：米
-
-##### latitude
-
-> **latitude**: `number`
-
-纬度
-
-##### longitude
-
-> **longitude**: `number`
-
-经度
-
-##### speed
-
-> **speed**: `number`
-
-行进速度，单位：米/秒
-
-##### timestamp
-
-> **timestamp**: `string`
-
-时间戳
-
-<a id="chooselocationparams"></a>
-### ChooseLocationParams
-
-#### Properties
-
-##### latitude?
-
-> `optional` **latitude**: `number`
-
-目标地纬度
-
-##### longitude?
-
-> `optional` **longitude**: `number`
-
-目标地经度
-
-<a id="chooselocationresponse"></a>
-### ChooseLocationResponse
-
-#### Properties
-
-##### address?
-
-> `optional` **address**: `string`
-
-地址详情
-
-##### latitude
-
-> **latitude**: `number`
-
-纬度，GCJ-02 坐标系
-
-##### longitude
-
-> **longitude**: `number`
-
-经度，GCJ-02 坐标系
-
-##### name?
-
-> `optional` **name**: `string`
-
-位置名称
-
-<a id="openlocationparams"></a>
-### OpenLocationParams
-
-#### Properties
-
-##### address?
-
-> `optional` **address**: `string`
-
-地址详情
-
-##### latitude
-
-> **latitude**: `number`
-
-纬度
-
-##### longitude
-
-> **longitude**: `number`
-
-经度
-
-##### name?
-
-> `optional` **name**: `string`
-
-位置名称
-
-##### scale?
-
-> `optional` **scale**: `number`
-
-缩放比例，范围 5 ~ 18
-
-<a id="startlocationupdateparams"></a>
-### StartLocationUpdateParams
-
-#### Properties
-
-##### type?
-
-> `optional` **type**: `"wgs84"` \| `"gcj02"`
-
-坐标系类型，支持 wgs84 或 gcj02