@doubao-apps/ai 0.0.33 → 0.0.34

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

@@ -0,0 +1,102 @@
+# Open API: 设备 / 网络
+
+网络类型和本机局域网 IP。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getLocalIPAddress](#getlocalipaddress) | 获取局域网 IP 地址。 |
+| [getNetworkType](#getnetworktype) | 获取当前网络类型。 |
+| [NetworkStatusChangeListener](#networkstatuschangelistener) | 网络状态变化事件监听函数。<br><br>返回 void，不是 Promise。 |
+
+## API 详情
+
+<a id="getlocalipaddress"></a>
+### getLocalIPAddress()
+
+获取局域网 IP 地址。
+
+## 代码示例
+
+```typescript
+import { getLocalIPAddress } from '@doubao-apps/framework/api';
+
+const { localIp, netmask } = await getLocalIPAddress();
+
+console.log(localIp, netmask);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<GetLocalIPAddressResult>`。
+
+|字段名|类型|说明|
+|---|---|---|
+|localIp|`string`|本机局域网 IP 地址。|
+|netmask|`string`|子网掩码。|
+
+<a id="getnetworktype"></a>
+### getNetworkType()
+
+获取当前网络类型。
+
+## 代码示例
+
+```ts
+import { getNetworkType } from '@doubao-apps/framework/api';
+
+const result = await getNetworkType();
+console.log(result.networkType);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回一个 Promise，解析为 GetNetworkTypeResult。
+
+|字段名|类型|说明|
+|---|---|---|
+|hasSystemProxy|`boolean`|设备是否使用了系统代理。|
+|networkType|`NetworkType`|当前网络类型。|
+|signalStrength|`number`|信号强弱，单位 dBm。|
+|weakNet|`boolean`|是否处于弱网环境。|
+
+**类型说明**
+
+- `NetworkType`: `"wifi" | "2g" | "3g" | "4g" | "5g" | "unknown" | "none"`
+
+<a id="networkstatuschangelistener"></a>
+### NetworkStatusChangeListener()
+
+网络状态变化事件监听函数。
+
+## 代码示例
+
+```typescript
+// 暂无代码示例
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|isConnected|`boolean`|是|当前是否有可用网络连接。|
+|networkType|`NetworkType`|是|当前网络类型。|
+
+**类型说明**
+
+- `NetworkType`: `"wifi" | "2g" | "3g" | "4g" | "5g" | "unknown" | "none"`
+
+## 返回值
+
+返回 `void`。

package/dist/skills/doubao-apps-dev/references/reference/open-api/22-/347/237/255/344/277/241.md

@@ -0,0 +1,40 @@
+# Open API: 短信
+
+拉起系统短信发送面板。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [sendSms](#sendsms) | 拉起系统短信发送面板。 |
+
+## API 详情
+
+<a id="sendsms"></a>
+### sendSms()
+
+拉起系统短信发送面板。
+
+## 代码示例
+
+```typescript
+import { sendSms } from '@doubao-apps/framework/api';
+
+await sendSms({
+  phoneNumber: '10086',
+  message: '查询话费'
+});
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|message|`string`|否|预填到发送短信面板的内容。|
+|phoneNumber|`string`|否|预填到发送短信面板的手机号。|
+
+## 返回值
+
+返回一个 Promise，在成功拉起短信发送面板时解析。

package/dist/skills/doubao-apps-dev/references/reference/open-api/23-/346/227/240/351/232/234/347/242/215.md

@@ -0,0 +1,40 @@
+# Open API: 无障碍
+
+检测无障碍能力开关状态。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [checkIsOpenAccessibility](#checkisopenaccessibility) | 检测无障碍能力是否开启。 |
+
+## API 详情
+
+<a id="checkisopenaccessibility"></a>
+### checkIsOpenAccessibility()
+
+检测无障碍能力是否开启。
+
+## 代码示例
+
+```typescript
+import { checkIsOpenAccessibility } from '@doubao-apps/framework/api';
+
+const { open } = await checkIsOpenAccessibility();
+
+console.log(open);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<CheckIsOpenAccessibilityResult>`。
+
+|字段名|类型|说明|
+|---|---|---|
+|open|`boolean`|是否开启视觉无障碍能力。|

package/dist/skills/doubao-apps-dev/references/reference/open-api/24-/345/237/272/347/241/200/344/277/241/346/201/257.md

@@ -0,0 +1,86 @@
+# Open API: 基础信息
+
+设备品牌、型号、系统、内存和性能等级。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getDeviceInfo](#getdeviceinfo) | 获取设备基础信息。 |
+| [getDeviceInfoSync](#getdeviceinfosync) | 同步获取设备基础信息。<br><br>同步 API。 |
+
+## API 详情
+
+<a id="getdeviceinfo"></a>
+### getDeviceInfo()
+
+获取设备基础信息。
+
+## 代码示例
+
+```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);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回设备品牌、型号、系统、内存和性能等级等字段，见 GetDeviceInfoResult。
+
+|字段名|类型|说明|
+|---|---|---|
+|abi|`string`|宿主 App 二进制接口类型，仅 Android 支持。|
+|benchmarkLevel|`number`|设备性能等级，值越高性能越好；-1 表示未知。|
+|brand|`string`|设备品牌。|
+|cpuType|`string`|设备 CPU 型号，仅 Android 支持。|
+|deviceAbi|`string`|设备二进制接口类型，仅 Android 支持。|
+|memorySize|`string`|设备内存大小，单位 MB。|
+|model|`string`|设备型号。|
+|platform|`string`|客户端平台。|
+|system|`string`|操作系统及版本。|
+
+<a id="getdeviceinfosync"></a>
+### getDeviceInfoSync()
+
+同步获取设备基础信息。
+
+## 代码示例
+
+```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);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回设备品牌、型号、系统、内存和性能等级等字段，见 GetDeviceInfoResult。
+
+|字段名|类型|说明|
+|---|---|---|
+|abi|`string`|宿主 App 二进制接口类型，仅 Android 支持。|
+|benchmarkLevel|`number`|设备性能等级，值越高性能越好；-1 表示未知。|
+|brand|`string`|设备品牌。|
+|cpuType|`string`|设备 CPU 型号，仅 Android 支持。|
+|deviceAbi|`string`|设备二进制接口类型，仅 Android 支持。|
+|memorySize|`string`|设备内存大小，单位 MB。|
+|model|`string`|设备型号。|
+|platform|`string`|客户端平台。|
+|system|`string`|操作系统及版本。|

package/dist/skills/doubao-apps-dev/references/reference/open-api/25-/347/224/265/346/261/240.md

@@ -0,0 +1,63 @@
+# Open API: 电池
+
+电池信息读取与变化监听。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [BatteryInfoChangeListener](#batteryinfochangelistener) | 电池信息变化事件监听函数。<br><br>返回 void，不是 Promise。 |
+| [getBatteryInfo](#getbatteryinfo) | 获取电池信息。 |
+
+## API 详情
+
+<a id="batteryinfochangelistener"></a>
+### BatteryInfoChangeListener()
+
+电池信息变化事件监听函数。
+
+## 代码示例
+
+```typescript
+// 暂无代码示例
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|isLowPowerModeEnabled|`boolean`|是|是否处于省电模式。|
+
+## 返回值
+
+返回 `void`。
+
+<a id="getbatteryinfo"></a>
+### getBatteryInfo()
+
+获取电池信息。
+
+## 代码示例
+
+```typescript
+import { getBatteryInfo } from '@doubao-apps/framework/api';
+
+const { isCharging, level } = await getBatteryInfo();
+
+console.log(isCharging, level);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<GetBatteryInfoResult>`。
+
+|字段名|类型|说明|
+|---|---|---|
+|isCharging|`boolean`|是否正在充电。|
+|level|`number`|当前电量，范围 1 - 100。|

package/dist/skills/doubao-apps-dev/references/reference/open-api/26-/346/227/245/345/216/206.md

@@ -0,0 +1,95 @@
+# Open API: 日历
+
+向系统日历添加事件和重复事件。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [addPhoneCalendar](#addphonecalendar) | 向系统日历添加事件。 |
+| [addPhoneRepeatCalendar](#addphonerepeatcalendar) | 向系统日历添加重复事件。 |
+
+## API 详情
+
+<a id="addphonecalendar"></a>
+### addPhoneCalendar()
+
+向系统日历添加事件。
+
+## 代码示例
+
+```typescript
+import { addPhoneCalendar } from '@doubao-apps/framework/api';
+
+const startTime = Math.floor(Date.now() / 1000) + 3600;
+
+await addPhoneCalendar({
+  title: '项目评审',
+  startTime,
+  endTime: startTime + 1800,
+  alarm: true,
+  alarmOffset: 300
+});
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|alarm|`boolean`|否|是否提醒。|
+|alarmOffset|`number`|否|提前提醒时间，单位秒。|
+|allDay|`boolean`|否|是否为全天事件。|
+|description|`string`|否|事件描述。|
+|endTime|`number`|否|结束时间的 Unix 秒级时间戳。|
+|location|`string`|否|事件位置。|
+|startTime|`number`|是|开始时间的 Unix 秒级时间戳。|
+|title|`string`|是|日历事件标题。|
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="addphonerepeatcalendar"></a>
+### addPhoneRepeatCalendar()
+
+向系统日历添加重复事件。
+
+## 代码示例
+
+```typescript
+import { addPhoneRepeatCalendar } from '@doubao-apps/framework/api';
+
+const startTime = Math.floor(Date.now() / 1000) + 3600;
+
+await addPhoneRepeatCalendar({
+  title: '每周例会',
+  startTime,
+  endTime: startTime + 1800,
+  repeatInterval: 'week'
+});
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|alarm|`boolean`|否|是否提醒。|
+|alarmOffset|`number`|否|提前提醒时间，单位秒。|
+|allDay|`boolean`|否|是否为全天事件。|
+|description|`string`|否|事件描述。|
+|endTime|`number`|否|结束时间的 Unix 秒级时间戳。|
+|location|`string`|否|事件位置。|
+|repeatEndTime|`number`|否|重复结束时间的 Unix 秒级时间戳。|
+|repeatInterval|`CalendarRepeatInterval`|否|重复周期。|
+|startTime|`number`|是|开始时间的 Unix 秒级时间戳。|
+|title|`string`|是|日历事件标题。|
+
+**类型说明**
+
+- `CalendarRepeatInterval`: `"day" | "week" | "month" | "year"`
+
+## 返回值
+
+返回 `Promise<object>`。

package/dist/skills/doubao-apps-dev/references/reference/open-api/27-/345/211/252/350/264/264/346/235/277.md

@@ -0,0 +1,64 @@
+# Open API: 剪贴板
+
+读取和设置系统剪贴板内容。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getClipboardData](#getclipboarddata) | 获取剪贴板内容。 |
+| [setClipboardData](#setclipboarddata) | 设置系统剪贴板内容。 |
+
+## API 详情
+
+<a id="getclipboarddata"></a>
+### getClipboardData()
+
+获取剪贴板内容。
+
+## 代码示例
+
+```typescript
+import { getClipboardData } from '@doubao-apps/framework/api';
+
+const { data } = await getClipboardData();
+
+console.log(data);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<GetClipboardDataResult>`。
+
+|字段名|类型|说明|
+|---|---|---|
+|data|`string`|当前剪贴板内容。|
+
+<a id="setclipboarddata"></a>
+### setClipboardData()
+
+设置系统剪贴板内容。
+
+## 代码示例
+
+```typescript
+import { setClipboardData } from '@doubao-apps/framework/api';
+
+await setClipboardData({ data: '复制内容' });
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|data|`string`|是|需要设置的剪贴板内容|
+
+## 返回值
+
+返回 `Promise<object>`。

package/dist/skills/doubao-apps-dev/references/reference/open-api/28-/350/201/224/347/263/273/344/272/272.md

@@ -0,0 +1,101 @@
+# Open API: 联系人
+
+选择和添加手机联系人。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [chooseContact](#choosecontact) | 选择手机联系人。 |
+| [addPhoneContact](#addphonecontact) | 添加手机联系人。 |
+
+## API 详情
+
+<a id="choosecontact"></a>
+### chooseContact()
+
+选择手机联系人。
+
+## 代码示例
+
+```typescript
+import { chooseContact } from '@doubao-apps/framework/api';
+
+const { displayName, phoneNumber } = await chooseContact();
+
+console.log(displayName, phoneNumber);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<ChooseContactResult>`。
+
+|字段名|类型|说明|
+|---|---|---|
+|displayName|`string`|联系人名称。|
+|phoneNumber|`string`|选中的手机号。|
+|phoneNumberList|`string[]`|联系人所有手机号。|
+
+<a id="addphonecontact"></a>
+### addPhoneContact()
+
+添加手机联系人。
+
+## 代码示例
+
+```typescript
+import { addPhoneContact } from '@doubao-apps/framework/api';
+
+await addPhoneContact({
+  firstName: 'Tom',
+  mobilePhoneNumber: '13800000000',
+  organization: 'Doubao'
+});
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|addressCity|`string`|否|家庭地址城市。|
+|addressCountry|`string`|否|家庭地址国家。|
+|addressPostalCode|`string`|否|家庭地址邮编。|
+|addressState|`string`|否|家庭地址省份。|
+|addressStreet|`string`|否|家庭地址街道。|
+|email|`string`|否|电子邮件。|
+|firstName|`string`|是|名字。|
+|homeAddressCity|`string`|否|家庭地址城市。|
+|homeAddressCountry|`string`|否|家庭地址国家。|
+|homeAddressPostalCode|`string`|否|家庭地址邮编。|
+|homeAddressState|`string`|否|家庭地址省份。|
+|homeAddressStreet|`string`|否|家庭地址街道。|
+|homeFaxNumber|`string`|否|家庭传真。|
+|homePhoneNumber|`string`|否|家庭电话。|
+|hostNumber|`string`|否|公司电话。|
+|lastName|`string`|否|姓。|
+|middleName|`string`|否|中间名。|
+|mobilePhoneNumber|`string`|否|手机号。|
+|nickName|`string`|否|昵称。|
+|organization|`string`|否|公司。|
+|photoFilePath|`string`|否|头像文件路径。|
+|remark|`string`|否|备注。|
+|title|`string`|否|职位。|
+|url|`string`|否|个人网站。|
+|weChatNumber|`string`|否|微信号。|
+|workAddressCity|`string`|否|工作地址城市。|
+|workAddressCountry|`string`|否|工作地址国家。|
+|workAddressPostalCode|`string`|否|工作地址邮编。|
+|workAddressState|`string`|否|工作地址省份。|
+|workAddressStreet|`string`|否|工作地址街道。|
+|workFaxNumber|`string`|否|工作传真。|
+|workPhoneNumber|`string`|否|工作电话。|
+
+## 返回值
+
+返回 `Promise<object>`。

package/dist/skills/doubao-apps-dev/references/reference/open-api/29-/345/212/240/345/257/206.md

@@ -0,0 +1,43 @@
+# Open API: 加密
+
+安全随机数能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getRandomValues](#getrandomvalues) | 获取安全随机数。 |
+
+## API 详情
+
+<a id="getrandomvalues"></a>
+### getRandomValues()
+
+获取安全随机数。
+
+## 代码示例
+
+```typescript
+import { getRandomValues } from '@doubao-apps/framework/api';
+
+const { randomValues } = await getRandomValues({ length: 16 });
+const bytes = new Uint8Array(randomValues);
+
+console.log(bytes);
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|length|`number`|是|需要生成的字节数。|
+
+## 返回值
+
+返回 `Promise<GetRandomValuesResult>`。
+
+|字段名|类型|说明|
+|---|---|---|
+|randomValues|`ArrayBuffer`|生成的随机字节。|

package/dist/skills/doubao-apps-dev/references/reference/open-api/30-/347/224/265/350/257/235.md

@@ -0,0 +1,36 @@
+# Open API: 电话
+
+拨打电话。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [makePhoneCall](#makephonecall) | 拨打电话。 |
+
+## API 详情
+
+<a id="makephonecall"></a>
+### makePhoneCall()
+
+拨打电话。
+
+## 代码示例
+
+```typescript
+import { makePhoneCall } from '@doubao-apps/framework/api';
+
+await makePhoneCall({ phoneNumber: '13800000000' });
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|phoneNumber|`string`|是|需要拨打的电话号码|
+
+## 返回值
+
+返回 `Promise<object>`。