@doubao-apps/ai 0.0.32 → 0.0.33

package/dist/contexts/doubao-apps-dev/references/reference/open-api/16-/350/256/276/345/244/207-/350/256/276/345/244/207/346/226/271/345/220/221.md

@@ -1,104 +0,0 @@
-# Open API: 设备 / 设备方向
-
-设备方向监听能力。
-
-[返回目录](./README.md) | [返回速查](../open-api.md)
-
-## 速查
-
-| API | 说明 |
-| --- | --- |
-| [startDeviceMotionListening](#startdevicemotionlistening) | 开始监听设备方向变化。<br><br>需配对调用 stopDeviceMotionListening。 |
-| [stopDeviceMotionListening](#stopdevicemotionlistening) | 停止监听设备方向变化。 |
-| [onDeviceMotionChange](#ondevicemotionchange) | 监听设备方向变化事件。<br><br>返回取消监听函数。 |
-
-## API 详情
-
-<a id="startdevicemotionlistening"></a>
-### startDeviceMotionListening()
-
-> **startDeviceMotionListening**(`params`?): `Promise`\<`object`\>
-
-开始监听设备方向变化。
-
-#### Parameters
-
-• **params?**: [`StartDeviceMotionListeningParams`](#startdevicemotionlisteningparams)
-
-#### Returns
-
-`Promise`\<`object`\>
-
-#### Remarks
-
-需配对调用 stopDeviceMotionListening。
-
-<a id="stopdevicemotionlistening"></a>
-### stopDeviceMotionListening()
-
-> **stopDeviceMotionListening**(`params`?): `Promise`\<`object`\>
-
-停止监听设备方向变化。
-
-#### Parameters
-
-• **params?**
-
-#### Returns
-
-`Promise`\<`object`\>
-
-<a id="ondevicemotionchange"></a>
-### onDeviceMotionChange()
-
-> **onDeviceMotionChange**(`handler`): () => `void`
-
-监听设备方向变化事件。
-
-#### Parameters
-
-• **handler**
-
-#### Returns
-
-`Function`
-
-返回取消当前监听函数的函数。
-
-##### Returns
-
-`void`
-
-#### Example
-
-```ts
-import { onDeviceMotionChange } from '@doubao-apps/framework/api';
-
-const off = onDeviceMotionChange(({ alpha, beta, gamma }) => {
-  console.log(alpha, beta, gamma);
-});
-
-off();
-```
-
-## 相关类型
-
-<a id="startdevicemotionlisteningparams"></a>
-### StartDeviceMotionListeningParams
-
-开始监听设备方向变化的请求参数。
-
-#### Properties
-
-##### interval?
-
-> `optional` **interval**: [`SensorInterval`](#sensorinterval)
-
-监听频率。
-
-<a id="sensorinterval"></a>
-### SensorInterval
-
-> **SensorInterval**: `"game"` \| `"ui"` \| `"normal"`
-
-传感器监听频率。

package/dist/contexts/doubao-apps-dev/references/reference/open-api/17-/350/256/276/345/244/207-/351/231/200/350/236/272/344/273/252.md

@@ -1,104 +0,0 @@
-# Open API: 设备 / 陀螺仪
-
-陀螺仪监听能力。
-
-[返回目录](./README.md) | [返回速查](../open-api.md)
-
-## 速查
-
-| API | 说明 |
-| --- | --- |
-| [startGyroscope](#startgyroscope) | 开始监听陀螺仪。<br><br>需配对调用 stopGyroscope。 |
-| [stopGyroscope](#stopgyroscope) | 停止监听陀螺仪。 |
-| [onGyroscopeChange](#ongyroscopechange) | 监听陀螺仪数据变化事件。<br><br>返回取消监听函数。 |
-
-## API 详情
-
-<a id="startgyroscope"></a>
-### startGyroscope()
-
-> **startGyroscope**(`params`?): `Promise`\<`object`\>
-
-开始监听陀螺仪。
-
-#### Parameters
-
-• **params?**: [`StartGyroscopeParams`](#startgyroscopeparams)
-
-#### Returns
-
-`Promise`\<`object`\>
-
-#### Remarks
-
-需配对调用 stopGyroscope。
-
-<a id="stopgyroscope"></a>
-### stopGyroscope()
-
-> **stopGyroscope**(`params`?): `Promise`\<`object`\>
-
-停止监听陀螺仪。
-
-#### Parameters
-
-• **params?**
-
-#### Returns
-
-`Promise`\<`object`\>
-
-<a id="ongyroscopechange"></a>
-### onGyroscopeChange()
-
-> **onGyroscopeChange**(`handler`): () => `void`
-
-监听陀螺仪数据变化事件。
-
-#### Parameters
-
-• **handler**
-
-#### Returns
-
-`Function`
-
-返回取消当前监听函数的函数。
-
-##### Returns
-
-`void`
-
-#### Example
-
-```ts
-import { onGyroscopeChange } from '@doubao-apps/framework/api';
-
-const off = onGyroscopeChange(({ x, y, z, timestamp }) => {
-  console.log(x, y, z, timestamp);
-});
-
-off();
-```
-
-## 相关类型
-
-<a id="startgyroscopeparams"></a>
-### StartGyroscopeParams
-
-开始监听陀螺仪的请求参数。
-
-#### Properties
-
-##### interval?
-
-> `optional` **interval**: [`SensorInterval`](#sensorinterval)
-
-监听频率。
-
-<a id="sensorinterval"></a>
-### SensorInterval
-
-> **SensorInterval**: `"game"` \| `"ui"` \| `"normal"`
-
-传感器监听频率。

package/dist/contexts/doubao-apps-dev/references/reference/open-api/18-ui-/350/276/223/345/205/245.md

@@ -1,49 +0,0 @@
-# Open API: UI / 输入
-
-键盘和输入框选区能力。
-
-[返回目录](./README.md) | [返回速查](../open-api.md)
-
-## 速查
-
-| API | 说明 |
-| --- | --- |
-| [getSelectedTextRange](#getselectedtextrange) | 获取当前输入框的选区范围。 |
-
-## API 详情
-
-<a id="getselectedtextrange"></a>
-### getSelectedTextRange()
-
-> **getSelectedTextRange**(`params`?): `Promise`\<[`GetSelectedTextRangeResult`](#getselectedtextrangeresult)\>
-
-获取当前输入框的选区范围。
-
-#### Parameters
-
-• **params?**
-
-#### Returns
-
-`Promise`\<[`GetSelectedTextRangeResult`](#getselectedtextrangeresult)\>
-
-## 相关类型
-
-<a id="getselectedtextrangeresult"></a>
-### GetSelectedTextRangeResult
-
-获取输入框选区范围的返回结果。
-
-#### Properties
-
-##### end
-
-> **end**: `number`
-
-选区结束位置。
-
-##### start
-
-> **start**: `number`
-
-选区起始位置。

package/dist/contexts/doubao-apps-dev/references/reference/open-api/19-/350/256/276/345/244/207-/347/275/221/347/273/234.md

@@ -1,164 +0,0 @@
-# Open API: 设备 / 网络
-
-网络类型和本机局域网 IP。
-
-[返回目录](./README.md) | [返回速查](../open-api.md)
-
-## 速查
-
-| API | 说明 |
-| --- | --- |
-| [getLocalIPAddress](#getlocalipaddress) | 获取局域网 IP 地址。 |
-| [getNetworkType](#getnetworktype) | 获取当前网络类型。 |
-| [onNetworkStatusChange](#onnetworkstatuschange) | 监听网络状态变化事件。<br><br>返回取消监听函数。 |
-
-## API 详情
-
-<a id="getlocalipaddress"></a>
-### getLocalIPAddress()
-
-> **getLocalIPAddress**(`params`?): `Promise`\<[`GetLocalIPAddressResult`](#getlocalipaddressresult)\>
-
-获取局域网 IP 地址。
-
-#### Parameters
-
-• **params?**
-
-#### Returns
-
-`Promise`\<[`GetLocalIPAddressResult`](#getlocalipaddressresult)\>
-
-<a id="getnetworktype"></a>
-### getNetworkType()
-
-> **getNetworkType**(`params`?): `Promise`\<[`GetNetworkTypeResult`](#getnetworktyperesult)\>
-
-获取当前网络类型。
-
-#### Parameters
-
-• **params?**: [`GetNetworkTypeParams`](#getnetworktypeparams)
-
-#### Returns
-
-`Promise`\<[`GetNetworkTypeResult`](#getnetworktyperesult)\>
-
-返回一个 Promise，解析为 [GetNetworkTypeResult](#getnetworktyperesult)。
-
-#### Example
-
-```ts
-import { getNetworkType } from '@byted-doubao-apps/framework/api';
-
-const result = await getNetworkType();
-console.log(result.networkType);
-```
-
-<a id="onnetworkstatuschange"></a>
-### onNetworkStatusChange()
-
-> **onNetworkStatusChange**(`handler`): () => `void`
-
-监听网络状态变化事件。
-
-#### Parameters
-
-• **handler**
-
-#### Returns
-
-`Function`
-
-返回取消当前监听函数的函数。
-
-##### Returns
-
-`void`
-
-#### Example
-
-```ts
-import { onNetworkStatusChange } from '@byted-doubao-apps/framework/api';
-
-const off = onNetworkStatusChange(({ isConnected, networkType }) => {
-  console.log(isConnected, networkType);
-});
-
-off();
-```
-
-## 相关类型
-
-<a id="getlocalipaddressresult"></a>
-### GetLocalIPAddressResult
-
-获取局域网 IP 的返回结果。
-
-#### Properties
-
-##### localIp
-
-> **localIp**: `string`
-
-本机局域网 IP 地址。
-
-##### netmask?
-
-> `optional` **netmask**: `string`
-
-子网掩码。
-
-<a id="getnetworktypeparams"></a>
-### GetNetworkTypeParams
-
-获取网络类型的请求参数。
-
-当前无需传入任何字段，预留扩展位。
-
-<a id="getnetworktyperesult"></a>
-### GetNetworkTypeResult
-
-获取网络类型的返回结果。
-
-#### Properties
-
-##### hasSystemProxy?
-
-> `optional` **hasSystemProxy**: `boolean`
-
-设备是否使用了系统代理。
-
-##### networkType
-
-> **networkType**: [`NetworkType`](#networktype-2)
-
-当前网络类型。
-
-##### signalStrength?
-
-> `optional` **signalStrength**: `number`
-
-信号强弱，单位 dBm。
-
-##### weakNet?
-
-> `optional` **weakNet**: `boolean`
-
-是否处于弱网环境。
-
-<a id="networktype-2"></a>
-<a id="networktype"></a>
-### NetworkType
-
-> **NetworkType**: `"wifi"` \| `"2g"` \| `"3g"` \| `"4g"` \| `"5g"` \| `"unknown"` \| `"none"`
-
-网络类型。
-
-- `wifi` - Wi-Fi 网络
-- `2g` - 2G 网络
-- `3g` - 3G 网络
-- `4g` - 4G 网络
-- `5g` - 5G 网络
-- `unknown` - Android 下不常见的网络类型
-- `none` - 无网络

package/dist/contexts/doubao-apps-dev/references/reference/open-api/20-/350/256/276/345/244/207-/347/237/255/344/277/241.md

@@ -1,62 +0,0 @@
-# Open API: 设备 / 短信
-
-拉起系统短信发送面板。
-
-[返回目录](./README.md) | [返回速查](../open-api.md)
-
-## 速查
-
-| API | 说明 |
-| --- | --- |
-| [sendSms](#sendsms) | 拉起系统短信发送面板。 |
-
-## API 详情
-
-<a id="sendsms"></a>
-### sendSms()
-
-> **sendSms**(`params`?): `Promise`\<`object`\>
-
-拉起系统短信发送面板。
-
-#### Parameters
-
-• **params?**: [`SendSmsParams`](#sendsmsparams)
-
-#### Returns
-
-`Promise`\<`object`\>
-
-返回一个 Promise，在成功拉起短信发送面板时解析。
-
-#### Example
-
-```typescript
-import { sendSms } from '@doubao-apps/framework/api';
-
-await sendSms({
-  phoneNumber: '10086',
-  message: '查询话费'
-});
-```
-
-## 相关类型
-
-<a id="sendsmsparams"></a>
-### SendSmsParams
-
-拉起系统短信发送面板的请求参数。
-
-#### Properties
-
-##### message?
-
-> `optional` **message**: `string`
-
-预填到发送短信面板的内容。
-
-##### phoneNumber?
-
-> `optional` **phoneNumber**: `string`
-
-预填到发送短信面板的手机号。

package/dist/contexts/doubao-apps-dev/references/reference/open-api/21-/350/256/276/345/244/207-/346/227/240/351/232/234/347/242/215.md

@@ -1,43 +0,0 @@
-# Open API: 设备 / 无障碍
-
-检测无障碍能力开关状态。
-
-[返回目录](./README.md) | [返回速查](../open-api.md)
-
-## 速查
-
-| API | 说明 |
-| --- | --- |
-| [checkIsOpenAccessibility](#checkisopenaccessibility) | 检测无障碍能力是否开启。 |
-
-## API 详情
-
-<a id="checkisopenaccessibility"></a>
-### checkIsOpenAccessibility()
-
-> **checkIsOpenAccessibility**(`params`?): `Promise`\<[`CheckIsOpenAccessibilityResult`](#checkisopenaccessibilityresult)\>
-
-检测无障碍能力是否开启。
-
-#### Parameters
-
-• **params?**
-
-#### Returns
-
-`Promise`\<[`CheckIsOpenAccessibilityResult`](#checkisopenaccessibilityresult)\>
-
-## 相关类型
-
-<a id="checkisopenaccessibilityresult"></a>
-### CheckIsOpenAccessibilityResult
-
-无障碍能力检测结果。
-
-#### Properties
-
-##### open
-
-> **open**: `boolean`
-
-是否开启视觉无障碍能力。

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

@@ -1,133 +0,0 @@
-# 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`
-
-操作系统及版本。