@doubao-apps/ai 0.0.26 → 0.0.27

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

@@ -0,0 +1,164 @@
+# 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/.ai/reference/open-api/18-/350/256/276/345/244/207-/347/237/255/344/277/241.md

@@ -0,0 +1,62 @@
+# 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/.ai/reference/open-api/19-/350/256/276/345/244/207-/346/227/240/351/232/234/347/242/215.md

@@ -0,0 +1,43 @@
+# 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/.ai/reference/open-api/20-/350/256/276/345/244/207-/347/224/265/346/261/240.md

@@ -0,0 +1,83 @@
+# Open API: 设备 / 电池
+
+电池信息读取与变化监听。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getBatteryInfo](#getbatteryinfo) | 获取电池信息。 |
+| [onBatteryInfoChange](#onbatteryinfochange) | 监听电池信息变化事件。<br><br>返回取消监听函数。 |
+
+## API 详情
+
+<a id="getbatteryinfo"></a>
+### getBatteryInfo()
+
+> **getBatteryInfo**(`params`?): `Promise`\<[`GetBatteryInfoResult`](#getbatteryinforesult)\>
+
+获取电池信息。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetBatteryInfoResult`](#getbatteryinforesult)\>
+
+<a id="onbatteryinfochange"></a>
+### onBatteryInfoChange()
+
+> **onBatteryInfoChange**(`handler`): () => `void`
+
+监听电池信息变化事件。
+
+#### Parameters
+
+• **handler**
+
+#### Returns
+
+`Function`
+
+返回取消当前监听函数的函数。
+
+##### Returns
+
+`void`
+
+#### Example
+
+```ts
+import { onBatteryInfoChange } from '@doubao-apps/framework/api';
+
+const off = onBatteryInfoChange(({ isLowPowerModeEnabled }) => {
+  console.log(isLowPowerModeEnabled);
+});
+
+off();
+```
+
+## 相关类型
+
+<a id="getbatteryinforesult"></a>
+### GetBatteryInfoResult
+
+电池信息。
+
+#### Properties
+
+##### isCharging
+
+> **isCharging**: `boolean`
+
+是否正在充电。
+
+##### level
+
+> **level**: `number`
+
+当前电量，范围 1 - 100。

package/dist/contexts/doubao-apps-dev/.ai/reference/open-api/21-/350/256/276/345/244/207-/346/227/245/345/216/206.md

@@ -0,0 +1,215 @@
+# Open API: 设备 / 日历
+
+向系统日历添加事件和重复事件。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [addPhoneCalendar](#addphonecalendar) | 向系统日历添加事件。 |
+| [addPhoneRepeatCalendar](#addphonerepeatcalendar) | 向系统日历添加重复事件。 |
+
+## API 详情
+
+<a id="addphonecalendar"></a>
+### addPhoneCalendar()
+
+> **addPhoneCalendar**(`params`): `Promise`\<`object`\>
+
+向系统日历添加事件。
+
+#### Parameters
+
+• **params**: [`AddPhoneCalendarParams`](#addphonecalendarparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="addphonerepeatcalendar"></a>
+### addPhoneRepeatCalendar()
+
+> **addPhoneRepeatCalendar**(`params`): `Promise`\<`object`\>
+
+向系统日历添加重复事件。
+
+#### Parameters
+
+• **params**: [`AddPhoneRepeatCalendarParams`](#addphonerepeatcalendarparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+## 相关类型
+
+<a id="addphonecalendarparams"></a>
+### AddPhoneCalendarParams
+
+添加系统日历事件的请求参数。
+
+#### Extended by
+
+- [`AddPhoneRepeatCalendarParams`](#addphonerepeatcalendarparams)
+
+#### Properties
+
+##### alarm?
+
+> `optional` **alarm**: `boolean`
+
+是否提醒。
+
+##### alarmOffset?
+
+> `optional` **alarmOffset**: `number`
+
+提前提醒时间，单位秒。
+
+##### allDay?
+
+> `optional` **allDay**: `boolean`
+
+是否为全天事件。
+
+##### description?
+
+> `optional` **description**: `string`
+
+事件描述。
+
+##### endTime?
+
+> `optional` **endTime**: `number`
+
+结束时间的 Unix 秒级时间戳。
+
+##### location?
+
+> `optional` **location**: `string`
+
+事件位置。
+
+##### startTime
+
+> **startTime**: `number`
+
+开始时间的 Unix 秒级时间戳。
+
+##### title
+
+> **title**: `string`
+
+日历事件标题。
+
+<a id="addphonerepeatcalendarparams"></a>
+### AddPhoneRepeatCalendarParams
+
+添加重复日历事件的请求参数。
+
+#### Extends
+
+- [`AddPhoneCalendarParams`](#addphonecalendarparams)
+
+#### Properties
+
+##### alarm?
+
+> `optional` **alarm**: `boolean`
+
+是否提醒。
+
+###### Inherited from
+
+[`AddPhoneCalendarParams`](#addphonecalendarparams).[`alarm`](#alarm)
+
+##### alarmOffset?
+
+> `optional` **alarmOffset**: `number`
+
+提前提醒时间，单位秒。
+
+###### Inherited from
+
+[`AddPhoneCalendarParams`](#addphonecalendarparams).[`alarmOffset`](#alarmoffset)
+
+##### allDay?
+
+> `optional` **allDay**: `boolean`
+
+是否为全天事件。
+
+###### Inherited from
+
+[`AddPhoneCalendarParams`](#addphonecalendarparams).[`allDay`](#allday)
+
+##### description?
+
+> `optional` **description**: `string`
+
+事件描述。
+
+###### Inherited from
+
+[`AddPhoneCalendarParams`](#addphonecalendarparams).[`description`](#description)
+
+##### endTime?
+
+> `optional` **endTime**: `number`
+
+结束时间的 Unix 秒级时间戳。
+
+###### Inherited from
+
+[`AddPhoneCalendarParams`](#addphonecalendarparams).[`endTime`](#endtime)
+
+##### location?
+
+> `optional` **location**: `string`
+
+事件位置。
+
+###### Inherited from
+
+[`AddPhoneCalendarParams`](#addphonecalendarparams).[`location`](#location)
+
+##### repeatEndTime?
+
+> `optional` **repeatEndTime**: `number`
+
+重复结束时间的 Unix 秒级时间戳。
+
+##### repeatInterval?
+
+> `optional` **repeatInterval**: [`CalendarRepeatInterval`](#calendarrepeatinterval)
+
+重复周期。
+
+##### startTime
+
+> **startTime**: `number`
+
+开始时间的 Unix 秒级时间戳。
+
+###### Inherited from
+
+[`AddPhoneCalendarParams`](#addphonecalendarparams).[`startTime`](#starttime)
+
+##### title
+
+> **title**: `string`
+
+日历事件标题。
+
+###### Inherited from
+
+[`AddPhoneCalendarParams`](#addphonecalendarparams).[`title`](#title)
+
+<a id="calendarrepeatinterval"></a>
+### CalendarRepeatInterval
+
+> **CalendarRepeatInterval**: `"day"` \| `"week"` \| `"month"` \| `"year"`
+
+日历重复周期。

package/dist/contexts/doubao-apps-dev/.ai/reference/open-api/22-/350/256/276/345/244/207-/345/211/252/350/264/264/346/235/277.md

@@ -0,0 +1,70 @@
+# Open API: 设备 / 剪贴板
+
+读取和设置系统剪贴板内容。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getClipboardData](#getclipboarddata) | 获取剪贴板内容。 |
+| [setClipboardData](#setclipboarddata) | 设置系统剪贴板内容。 |
+
+## API 详情
+
+<a id="getclipboarddata"></a>
+### getClipboardData()
+
+> **getClipboardData**(`params`?): `Promise`\<[`GetClipboardDataResult`](#getclipboarddataresult)\>
+
+获取剪贴板内容。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetClipboardDataResult`](#getclipboarddataresult)\>
+
+<a id="setclipboarddata"></a>
+### setClipboardData()
+
+> **setClipboardData**(`params`): `Promise`\<`object`\>
+
+设置系统剪贴板内容。
+
+#### Parameters
+
+• **params**: [`SetClipboardDataParams`](#setclipboarddataparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+## 相关类型
+
+<a id="getclipboarddataresult"></a>
+### GetClipboardDataResult
+
+剪贴板读取结果。
+
+#### Properties
+
+##### data
+
+> **data**: `string`
+
+当前剪贴板内容。
+
+<a id="setclipboarddataparams"></a>
+### SetClipboardDataParams
+
+#### Properties
+
+##### data
+
+> **data**: `string`
+
+需要设置的剪贴板内容