@doubao-apps/create 0.0.31 → 0.0.32

package/dist/template-empty/references/reference/open-api/22-/350/256/276/345/244/207-/345/237/272/347/241/200/344/277/241/346/201/257.md

@@ -0,0 +1,133 @@
+# Open API: 设备 / 基础信息
+
+设备品牌、型号、系统、内存和性能等级。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getDeviceInfo](#getdeviceinfo) | 获取设备基础信息。 |
+| [getDeviceInfoSync](#getdeviceinfosync) | 同步获取设备基础信息。<br><br>同步 API。 |
+
+## API 详情
+
+<a id="getdeviceinfo"></a>
+### getDeviceInfo()
+
+> **getDeviceInfo**(`params`?): `Promise`\<[`GetDeviceInfoResult`](#getdeviceinforesult)\>
+
+获取设备基础信息。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetDeviceInfoResult`](#getdeviceinforesult)\>
+
+返回设备品牌、型号、系统、内存和性能等级等字段，见 [GetDeviceInfoResult](#getdeviceinforesult)。
+
+#### Example
+
+```typescript
+import { getDeviceInfo } from '@doubao-apps/framework/api';
+
+const result = await getDeviceInfo();
+
+console.log(result.brand, result.model, result.system);
+console.log(result.platform, result.benchmarkLevel);
+```
+
+<a id="getdeviceinfosync"></a>
+### getDeviceInfoSync()
+
+> **getDeviceInfoSync**(`params`?): [`GetDeviceInfoResult`](#getdeviceinforesult)
+
+同步获取设备基础信息。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+[`GetDeviceInfoResult`](#getdeviceinforesult)
+
+返回设备品牌、型号、系统、内存和性能等级等字段，见 [GetDeviceInfoResult](#getdeviceinforesult)。
+
+#### Example
+
+```typescript
+import { getDeviceInfoSync } from '@doubao-apps/framework/api';
+
+const result = getDeviceInfoSync();
+
+console.log(result.brand, result.model, result.system);
+console.log(result.platform, result.benchmarkLevel);
+```
+
+## 相关类型
+
+<a id="getdeviceinforesult"></a>
+### GetDeviceInfoResult
+
+设备基础信息。
+
+#### Properties
+
+##### abi?
+
+> `optional` **abi**: `string`
+
+宿主 App 二进制接口类型，仅 Android 支持。
+
+##### benchmarkLevel
+
+> **benchmarkLevel**: `number`
+
+设备性能等级，值越高性能越好；-1 表示未知。
+
+##### brand
+
+> **brand**: `string`
+
+设备品牌。
+
+##### cpuType?
+
+> `optional` **cpuType**: `string`
+
+设备 CPU 型号，仅 Android 支持。
+
+##### deviceAbi?
+
+> `optional` **deviceAbi**: `string`
+
+设备二进制接口类型，仅 Android 支持。
+
+##### memorySize
+
+> **memorySize**: `string`
+
+设备内存大小，单位 MB。
+
+##### model
+
+> **model**: `string`
+
+设备型号。
+
+##### platform
+
+> **platform**: `string`
+
+客户端平台。
+
+##### system
+
+> **system**: `string`
+
+操作系统及版本。

package/dist/template-empty/references/reference/open-api/README.md

@@ -7,7 +7,7 @@
 | 分组 | 说明 | API 数量 | 详细文档 |
 | --- | --- | ---: | --- |
 | 基础 / 账号 / 系统 | 账号、授权、宿主基础信息、窗口信息和能力可用性。 | 9 | [查看](./01-基础-账号-系统.md) |
-| 定位 | 获取设备当前的地理位置信息。 | 1 | [查看](./02-定位.md) |
+| 定位 | 获取设备当前的地理位置信息。 | 9 | [查看](./02-定位.md) |
 | 存储 | 本地缓存；带 Sync 后缀的是同步 API。 | 10 | [查看](./03-存储.md) |
 | 路由 | 应用内页面跳转、返回、退出和关闭。 | 6 | [查看](./04-路由.md) |
 | 界面 / 交互 | Toast、Loading、Modal、ActionSheet 和返回前提醒。 | 9 | [查看](./05-界面-交互.md) |
@@ -27,13 +27,14 @@
 | 设备 / 网络 | 网络类型和本机局域网 IP。 | 3 | [查看](./19-设备-网络.md) |
 | 设备 / 短信 | 拉起系统短信发送面板。 | 1 | [查看](./20-设备-短信.md) |
 | 设备 / 无障碍 | 检测无障碍能力开关状态。 | 1 | [查看](./21-设备-无障碍.md) |
-| 设备 / 电池 | 电池信息读取与变化监听。 | 2 | [查看](./22-设备-电池.md) |
-| 设备 / 日历 | 向系统日历添加事件和重复事件。 | 2 | [查看](./23-设备-日历.md) |
-| 设备 / 剪贴板 | 读取和设置系统剪贴板内容。 | 2 | [查看](./24-设备-剪贴板.md) |
-| 设备 / 联系人 | 选择和添加手机联系人。 | 2 | [查看](./25-设备-联系人.md) |
-| 设备 / 加密 | 安全随机数能力。 | 1 | [查看](./26-设备-加密.md) |
-| 设备 / 电话 | 拨打电话。 | 1 | [查看](./27-设备-电话.md) |
-| 设备 / 扫码 | 调起扫码并读取扫码结果。 | 1 | [查看](./28-设备-扫码.md) |
-| 设备 / 屏幕 | 屏幕亮度、常亮和截屏/录屏相关能力。 | 5 | [查看](./29-设备-屏幕.md) |
-| 设备 / 震动 | 触发短震动和长震动。 | 2 | [查看](./30-设备-震动.md) |
-| 文件系统 | 文件读写、目录管理和文件信息操作。 | 1 | [查看](./31-文件系统.md) |
+| 设备 / 基础信息 | 设备品牌、型号、系统、内存和性能等级。 | 2 | [查看](./22-设备-基础信息.md) |
+| 设备 / 电池 | 电池信息读取与变化监听。 | 2 | [查看](./23-设备-电池.md) |
+| 设备 / 日历 | 向系统日历添加事件和重复事件。 | 2 | [查看](./24-设备-日历.md) |
+| 设备 / 剪贴板 | 读取和设置系统剪贴板内容。 | 2 | [查看](./25-设备-剪贴板.md) |
+| 设备 / 联系人 | 选择和添加手机联系人。 | 2 | [查看](./26-设备-联系人.md) |
+| 设备 / 加密 | 安全随机数能力。 | 1 | [查看](./27-设备-加密.md) |
+| 设备 / 电话 | 拨打电话。 | 1 | [查看](./28-设备-电话.md) |
+| 设备 / 扫码 | 调起扫码并读取扫码结果。 | 1 | [查看](./29-设备-扫码.md) |
+| 设备 / 屏幕 | 屏幕亮度、常亮和截屏/录屏相关能力。 | 5 | [查看](./30-设备-屏幕.md) |
+| 设备 / 震动 | 触发短震动和长震动。 | 2 | [查看](./31-设备-震动.md) |
+| 文件系统 | 文件读写、目录管理和文件信息操作。 | 1 | [查看](./32-文件系统.md) |

package/dist/template-empty/references/reference/open-api.md

@@ -146,6 +146,22 @@ Promise 对象，授权成功时会返回授权结果
 
 ***
 
+### chooseLocation()
+
+> **chooseLocation**(`params`?): `Promise`\<[`ChooseLocationResponse`](doubao-apps-sdk-open-api.md#chooselocationresponse)\>
+
+打开地图选择位置。
+
+#### Parameters
+
+• **params?**: [`ChooseLocationParams`](doubao-apps-sdk-open-api.md#chooselocationparams)
+
+#### Returns
+
+`Promise`\<[`ChooseLocationResponse`](doubao-apps-sdk-open-api.md#chooselocationresponse)\>
+
+***
+
 ### clearStorage()
 
 > **clearStorage**(`params`?): `Promise`\<`object`\>
@@ -855,6 +871,64 @@ console.log(result.host?.appId, result.enableDebug);
 
 ***
 
+### getDeviceInfo()
+
+> **getDeviceInfo**(`params`?): `Promise`\<[`GetDeviceInfoResult`](doubao-apps-sdk-open-api.md#getdeviceinforesult)\>
+
+获取设备基础信息。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetDeviceInfoResult`](doubao-apps-sdk-open-api.md#getdeviceinforesult)\>
+
+返回设备品牌、型号、系统、内存和性能等级等字段，见 [GetDeviceInfoResult](doubao-apps-sdk-open-api.md#getdeviceinforesult)。
+
+#### Example
+
+```typescript
+import { getDeviceInfo } from '@doubao-apps/framework/api';
+
+const result = await getDeviceInfo();
+
+console.log(result.brand, result.model, result.system);
+console.log(result.platform, result.benchmarkLevel);
+```
+
+***
+
+### getDeviceInfoSync()
+
+> **getDeviceInfoSync**(`params`?): [`GetDeviceInfoResult`](doubao-apps-sdk-open-api.md#getdeviceinforesult)
+
+同步获取设备基础信息。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+[`GetDeviceInfoResult`](doubao-apps-sdk-open-api.md#getdeviceinforesult)
+
+返回设备品牌、型号、系统、内存和性能等级等字段，见 [GetDeviceInfoResult](doubao-apps-sdk-open-api.md#getdeviceinforesult)。
+
+#### Example
+
+```typescript
+import { getDeviceInfoSync } from '@doubao-apps/framework/api';
+
+const result = getDeviceInfoSync();
+
+console.log(result.brand, result.model, result.system);
+console.log(result.platform, result.benchmarkLevel);
+```
+
+***
+
 ### getFileSystemManager()
 
 > **getFileSystemManager**(): [`FileSystemManager`](doubao-apps-sdk-open-api.md#filesystemmanager)
@@ -1586,6 +1660,38 @@ Widget 登录参数。
 
 ***
 
+### offLocationChange()
+
+> **offLocationChange**(`callback`?): `void`
+
+取消注册地理位置变化回调。
+
+#### Parameters
+
+• **callback?**: [`LocationChangeListener`](doubao-apps-sdk-open-api.md#locationchangelistener)
+
+#### Returns
+
+`void`
+
+***
+
+### offLocationChangeError()
+
+> **offLocationChangeError**(`callback`?): `void`
+
+取消注册位置更新异常回调。
+
+#### Parameters
+
+• **callback?**: [`LocationChangeErrorListener`](doubao-apps-sdk-open-api.md#locationchangeerrorlistener)
+
+#### Returns
+
+`void`
+
+***
+
 ### onAccelerometerChange()
 
 > **onAccelerometerChange**(`handler`): () => `void`
@@ -1786,6 +1892,38 @@ const unsubscribe = onKeyboardHeightChange(({ height }) => {
 
 ***
 
+### onLocationChange()
+
+> **onLocationChange**(`callback`): `void`
+
+注册地理位置变化回调。
+
+#### Parameters
+
+• **callback**: [`LocationChangeListener`](doubao-apps-sdk-open-api.md#locationchangelistener)
+
+#### Returns
+
+`void`
+
+***
+
+### onLocationChangeError()
+
+> **onLocationChangeError**(`callback`): `void`
+
+注册位置更新异常回调。
+
+#### Parameters
+
+• **callback**: [`LocationChangeErrorListener`](doubao-apps-sdk-open-api.md#locationchangeerrorlistener)
+
+#### Returns
+
+`void`
+
+***
+
 ### onNetworkStatusChange()
 
 > **onNetworkStatusChange**(`handler`): () => `void`
@@ -1928,6 +2066,22 @@ off();
 
 ***
 
+### openLocation()
+
+> **openLocation**(`params`): `Promise`\<`object`\>
+
+使用地图查看位置。
+
+#### Parameters
+
+• **params**: [`OpenLocationParams`](doubao-apps-sdk-open-api.md#openlocationparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+***
+
 ### postLoginResult()
 
 > **postLoginResult**(`params`): `Promise`\<`object`\>
@@ -2754,6 +2908,26 @@ showToast({
 
 ***
 
+### startLocationUpdate()
+
+> **startLocationUpdate**(`params`?): `Promise`\<`object`\>
+
+开始接收位置更新。
+
+#### Parameters
+
+• **params?**: [`StartLocationUpdateParams`](doubao-apps-sdk-open-api.md#startlocationupdateparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+需配对调用 stopLocationUpdate。
+
+***
+
 ### startWifi()
 
 > **startWifi**(`params`?): `Promise`\<`object`\>
@@ -2870,6 +3044,22 @@ Wi-Fi 流程入口。
 
 ***
 
+### stopLocationUpdate()
+
+> **stopLocationUpdate**(`params`?): `Promise`\<`object`\>
+
+停止接收位置更新。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+***
+
 ### stopWifi()
 
 > **stopWifi**(`params`?): `Promise`\<`object`\>
@@ -3854,6 +4044,54 @@ H5 场景下可复用的 input 元素 ID。
 
 ***
 
+### ChooseLocationParams
+
+#### Properties
+
+##### latitude?
+
+> `optional` **latitude**: `number`
+
+目标地纬度
+
+##### longitude?
+
+> `optional` **longitude**: `number`
+
+目标地经度
+
+***
+
+### ChooseLocationResponse
+
+#### Properties
+
+##### address?
+
+> `optional` **address**: `string`
+
+地址详情
+
+##### latitude
+
+> **latitude**: `number`
+
+纬度，GCJ-02 坐标系
+
+##### longitude
+
+> **longitude**: `number`
+
+经度，GCJ-02 坐标系
+
+##### name?
+
+> `optional` **name**: `string`
+
+位置名称
+
+***
+
 ### ChooseMessageFile
 
 选择消息文件返回的单个文件信息。
@@ -5289,6 +5527,68 @@ RSSI 信号强度，单位 dBm。
 
 ***
 
+### GetDeviceInfoResult
+
+设备基础信息。
+
+#### Properties
+
+##### abi?
+
+> `optional` **abi**: `string`
+
+宿主 App 二进制接口类型，仅 Android 支持。
+
+##### benchmarkLevel
+
+> **benchmarkLevel**: `number`
+
+设备性能等级，值越高性能越好；-1 表示未知。
+
+##### brand
+
+> **brand**: `string`
+
+设备品牌。
+
+##### cpuType?
+
+> `optional` **cpuType**: `string`
+
+设备 CPU 型号，仅 Android 支持。
+
+##### deviceAbi?
+
+> `optional` **deviceAbi**: `string`
+
+设备二进制接口类型，仅 Android 支持。
+
+##### memorySize
+
+> **memorySize**: `string`
+
+设备内存大小，单位 MB。
+
+##### model
+
+> **model**: `string`
+
+设备型号。
+
+##### platform
+
+> **platform**: `string`
+
+客户端平台。
+
+##### system
+
+> **system**: `string`
+
+操作系统及版本。
+
+***
+
 ### GetFileInfoParams
 
 [FileSystemManager.getFileInfo](doubao-apps-sdk-open-api.md#getfileinfo) 的参数。
@@ -5927,6 +6227,90 @@ Wi-Fi 的系统开关
 
 ***
 
+### LocationChangeErrorEvent
+
+#### Properties
+
+##### errCode?
+
+> `optional` **errCode**: `number`
+
+错误码
+
+##### errMsg
+
+> **errMsg**: `string`
+
+错误信息
+
+***
+
+### LocationChangeEvent
+
+#### Properties
+
+##### accuracy?
+
+> `optional` **accuracy**: `number`
+
+位置精确度，单位 m
+
+##### altitude?
+
+> `optional` **altitude**: `number`
+
+高度，单位 m
+
+##### city?
+
+> `optional` **city**: `string`
+
+城市信息
+
+##### district?
+
+> `optional` **district**: `string`
+
+区县信息
+
+##### horizontalAccuracy?
+
+> `optional` **horizontalAccuracy**: `number`
+
+水平精度，单位 m
+
+##### latitude
+
+> **latitude**: `number`
+
+纬度
+
+##### longitude
+
+> **longitude**: `number`
+
+经度
+
+##### province?
+
+> `optional` **province**: `string`
+
+省份信息
+
+##### speed?
+
+> `optional` **speed**: `number`
+
+速度，单位 m/s
+
+##### verticalAccuracy?
+
+> `optional` **verticalAccuracy**: `number`
+
+垂直精度，单位 m
+
+***
+
 ### LoginRequest
 
 #### Properties
@@ -6217,6 +6601,42 @@ Execution status from client
 
 ***
 
+### OpenLocationParams
+
+#### Properties
+
+##### address?
+
+> `optional` **address**: `string`
+
+地址详情
+
+##### latitude
+
+> **latitude**: `number`
+
+纬度
+
+##### longitude
+
+> **longitude**: `number`
+
+经度
+
+##### name?
+
+> `optional` **name**: `string`
+
+位置名称
+
+##### scale?
+
+> `optional` **scale**: `number`
+
+缩放比例，范围 5 ~ 18
+
+***
+
 ### PluginAccountInfo
 
 插件账号信息（仅在插件中调用时包含）。
@@ -7657,6 +8077,18 @@ iOS 下是否忽略蓝牙可用性校验。
 
 ***
 
+### StartLocationUpdateParams
+
+#### Properties
+
+##### type?
+
+> `optional` **type**: `"wgs84"` \| `"gcj02"`
+
+坐标系类型，支持 wgs84 或 gcj02
+
+***
+
 ### StatParams
 
 [FileSystemManager.stat](doubao-apps-sdk-open-api.md#stat) 的参数。
@@ -8262,6 +8694,34 @@ iBeacon 距离等级。
 
 ***
 
+### LocationChangeErrorListener()
+
+> **LocationChangeErrorListener**: (`event`) => `void`
+
+#### Parameters
+
+• **event**: [`LocationChangeErrorEvent`](doubao-apps-sdk-open-api.md#locationchangeerrorevent)
+
+#### Returns
+
+`void`
+
+***
+
+### LocationChangeListener()
+
+> **LocationChangeListener**: (`event`) => `void`
+
+#### Parameters
+
+• **event**: [`LocationChangeEvent`](doubao-apps-sdk-open-api.md#locationchangeevent)
+
+#### Returns
+
+`void`
+
+***
+
 ### LoginType
 
 > **LoginType**: `0` \| `1` \| `2` \| `3`