@doubao-dev/plugin-app-dev 0.0.0-stage → 0.0.40-canary-dea0ddc73-20261026073950

package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/24-/347/237/255/344/277/241.md

@@ -0,0 +1,155 @@
+# 豆包应用插件的端能力 API: 短信
+
+拉起系统短信发送面板。
+
+[返回目录](./groups.md) | [返回速查](./quick-reference.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [sendSms](#sendsms) | 拉起系统短信发送面板。 |
+
+## API 详情
+
+<a id="sendsms"></a>
+### sendSms()
+
+# sendSms
+
+拉起系统短信发送面板。
+
+## 扫码预览
+![扫码预览 sendSms](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fdevice%252Fsend-sms%252Findex)
+
+## 使用限制
+
+> [!WARNING]
+> **Android、iOS**：Android 通过 Intent 打开短信应用即成功，iOS 通过 MFMessageComposeViewController 呈现并在用户完成/取消后回调，成功时机不同；相同调用在双端&quot;成功&quot;代表的实际状态不同。
+
+## 支持版本
+
+前端库版本不低于 `0.0.25`。
+
+## 支持平台
+
+<table>
+<thead>
+<tr><th>平台</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>Android</td><td>支持</td></tr>
+<tr><td>iOS</td><td>支持</td></tr>
+<tr><td>PC</td><td>不支持</td></tr>
+<tr><td>HarmonyOS</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 支持场景
+
+<table>
+<thead>
+<tr><th>场景</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>页面</td><td>支持</td></tr>
+<tr><td>卡片</td><td>支持</td></tr>
+</tbody>
+</table>
+
+## 使用说明
+
+- 该接口仅拉起系统短信面板，是否实际发送由用户在系统界面确认
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+sendSms(params?: SendSmsParams): Promise<object>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>message</code></td><td><code>string</code></td><td>否</td><td><code>-</code></td><td>-</td><td>预填到发送短信面板的内容。</td></tr>
+<tr><td><code>phoneNumber</code></td><td><code>string</code></td><td>否</td><td><code>-</code></td><td>-</td><td>预填到发送短信面板的手机号。</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { sendSms } from '@doubao-dev/framework/api';
+
+await sendSms({
+  phoneNumber: '10086',
+  message: '查询话费'
+});
+```
+
+## 成功返回
+
+无返回字段。
+
+### 返回示例
+
+```json
+{}
+```
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 失败示例
+
+```json
+{
+  "errNo": 114,
+  "errMsg": "operation cancelled"
+}
+```
+
+### 错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
+</thead>
+<tbody>
+<tr><td><code>103</code></td><td><code>feature not support</code></td><td>iOS</td><td>当前设备不支持发送短信</td><td>在支持短信的设备上调用，或提前提示用户设备不支持短信。</td></tr>
+<tr><td><code>114</code></td><td><code>operation cancelled</code></td><td>iOS</td><td>用户在系统短信面板中取消了发送</td><td>用户需要时可再次调用 `sendSms` 重新拉起短信面板。</td></tr>
+</tbody>
+</table>
+
+#### 通用错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
+</thead>
+<tbody>
+<tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android、iOS</td></tr>
+</tbody>
+</table>
+
+## 平台差异
+
+- **iOS**：拉起短信面板后用户取消返回 114、发送失败返回 102、设备不支持短信返回 103；Android 无法拉起短信应用时返回 102。
+
+## 相关类型
+
+<a id="sendsmsparams"></a>
+### SendSmsParams
+
+拉起系统短信发送面板的请求参数。
+
+#### Properties
+
+• **phoneNumber?**: `string` - 预填到发送短信面板的手机号
+• **message?**: `string` - 预填到发送短信面板的内容

package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/25-/346/227/240/351/232/234/347/242/215.md

@@ -0,0 +1,144 @@
+# 豆包应用插件的端能力 API: 无障碍
+
+检测无障碍能力开关状态。
+
+[返回目录](./groups.md) | [返回速查](./quick-reference.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [checkIsOpenAccessibility](#checkisopenaccessibility) | 检测无障碍能力是否开启。 |
+
+## API 详情
+
+<a id="checkisopenaccessibility"></a>
+### checkIsOpenAccessibility()
+
+# checkIsOpenAccessibility
+
+检测无障碍能力是否开启。
+
+## 扫码预览
+![扫码预览 checkIsOpenAccessibility](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fdevice%252Fcheck-is-open-accessibility%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.25`。
+
+## 支持平台
+
+<table>
+<thead>
+<tr><th>平台</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>Android</td><td>支持</td></tr>
+<tr><td>iOS</td><td>支持</td></tr>
+<tr><td>PC</td><td>不支持</td></tr>
+<tr><td>HarmonyOS</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 支持场景
+
+<table>
+<thead>
+<tr><th>场景</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>页面</td><td>支持</td></tr>
+</tbody>
+</table>
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+checkIsOpenAccessibility(params?: object): Promise<CheckIsOpenAccessibilityResult>
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```typescript
+import { checkIsOpenAccessibility } from '@doubao-dev/framework/api';
+
+const { open } = await checkIsOpenAccessibility();
+
+console.log(open);
+```
+
+## 成功返回
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>open</code></td><td><code>boolean</code></td><td>是</td><td>是否开启视觉无障碍能力。</td></tr>
+</tbody>
+</table>
+
+### 返回示例
+
+```json
+{
+  "open": false
+}
+```
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 失败示例
+
+```json
+{
+  "errNo": 103,
+  "errMsg": "feature not support"
+}
+```
+
+### 错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
+</thead>
+<tbody>
+<tr><td><code>103</code></td><td><code>feature not support</code></td><td>Android</td><td>当前设备不支持获取系统无障碍服务状态</td><td>在支持系统无障碍服务的设备上调用。</td></tr>
+</tbody>
+</table>
+
+#### 通用错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
+</thead>
+<tbody>
+<tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android</td></tr>
+</tbody>
+</table>
+
+## 平台差异
+
+- **Android**：检测系统无障碍服务是否开启
+- **iOS**：检测 VoiceOver 或开关控制是否开启
+
+## 相关类型
+
+<a id="checkisopenaccessibilityresult"></a>
+### CheckIsOpenAccessibilityResult
+
+无障碍能力检测结果。
+
+#### Properties
+
+• **open**: `boolean` - 是否开启视觉无障碍能力

package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/26-/345/237/272/347/241/200/344/277/241/346/201/257.md

@@ -0,0 +1,238 @@
+# 豆包应用插件的端能力 API: 基础信息
+
+设备品牌、型号、系统、内存和性能等级。
+
+[返回目录](./groups.md) | [返回速查](./quick-reference.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getDeviceInfo](#getdeviceinfo) | 获取设备基础信息。 |
+| [getDeviceInfoSync](#getdeviceinfosync) | 同步获取设备基础信息。<br><br>同步 API。 |
+
+## API 详情
+
+<a id="getdeviceinfo"></a>
+### getDeviceInfo()
+
+# getDeviceInfo
+
+获取设备基础信息。
+
+## 扫码预览
+![扫码预览 getDeviceInfo](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fdevice%252Fget-device-info%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.32`。
+
+## 支持平台
+
+<table>
+<thead>
+<tr><th>平台</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>Android</td><td>支持</td></tr>
+<tr><td>iOS</td><td>支持</td></tr>
+<tr><td>PC</td><td>支持</td></tr>
+<tr><td>HarmonyOS</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 支持场景
+
+<table>
+<thead>
+<tr><th>场景</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>页面</td><td>支持</td></tr>
+<tr><td>卡片</td><td>支持</td></tr>
+</tbody>
+</table>
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+getDeviceInfo(params?: object): Promise<GetDeviceInfoResult>
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```typescript
+import { getDeviceInfo } from '@doubao-dev/framework/api';
+
+const result = await getDeviceInfo();
+
+console.log(result.brand, result.model, result.system);
+console.log(result.platform, result.benchmarkLevel);
+```
+
+## 成功返回
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>abi</code></td><td><code>string</code></td><td>否</td><td>豆包客户端二进制接口类型，仅 Android 支持。</td></tr>
+<tr><td><code>benchmarkLevel</code></td><td><code>number</code></td><td>是</td><td>设备性能等级，值越高性能越好；-1 表示未知。</td></tr>
+<tr><td><code>brand</code></td><td><code>string</code></td><td>是</td><td>设备品牌。</td></tr>
+<tr><td><code>cpuType</code></td><td><code>string</code></td><td>否</td><td>设备 CPU 型号，仅 Android 支持。</td></tr>
+<tr><td><code>deviceAbi</code></td><td><code>string</code></td><td>否</td><td>设备二进制接口类型，仅 Android 支持。</td></tr>
+<tr><td><code>memorySize</code></td><td><code>string</code></td><td>是</td><td>设备内存大小，单位 MB。</td></tr>
+<tr><td><code>model</code></td><td><code>string</code></td><td>是</td><td>设备型号。</td></tr>
+<tr><td><code>platform</code></td><td><code>string</code></td><td>是</td><td>客户端平台。</td></tr>
+<tr><td><code>system</code></td><td><code>string</code></td><td>是</td><td>操作系统及版本。</td></tr>
+</tbody>
+</table>
+
+### 返回示例
+
+```json
+{
+  "benchmarkLevel": 30,
+  "brand": "Apple",
+  "model": "iPhone 15 Pro",
+  "system": "iOS 17.5",
+  "platform": "ios",
+  "memorySize": "8192"
+}
+```
+
+## 平台差异
+
+- **Android**：`abi`、`deviceAbi`、`cpuType` 仅 Android 返回
+- **iOS**：不返回 `abi`、`deviceAbi`、`cpuType`
+- **PC**：Flow Web 浏览器的 `platform` 返回 `web`；Windows、macOS 桌面客户端分别返回 `windows`、`mac`，不返回 Android 专属字段
+
+<a id="getdeviceinfosync"></a>
+### getDeviceInfoSync()
+
+# getDeviceInfoSync
+
+同步获取设备基础信息。
+
+## 扫码预览
+![扫码预览 getDeviceInfoSync](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fdevice%252Fget-device-info%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.32`。
+
+## 支持平台
+
+<table>
+<thead>
+<tr><th>平台</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>Android</td><td>支持</td></tr>
+<tr><td>iOS</td><td>支持</td></tr>
+<tr><td>PC</td><td>不支持</td></tr>
+<tr><td>HarmonyOS</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 支持场景
+
+<table>
+<thead>
+<tr><th>场景</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>页面</td><td>支持</td></tr>
+<tr><td>卡片</td><td>支持</td></tr>
+</tbody>
+</table>
+
+## 使用说明
+
+- `platform` 返回小写的客户端平台标识；`benchmarkLevel` 无法获取时返回 -1
+
+## 调用方式
+
+### 同步 API
+
+```typescript
+getDeviceInfoSync(_params?: object): GetDeviceInfoResult
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```typescript
+import { getDeviceInfoSync } from '@doubao-dev/framework/api';
+
+const result = getDeviceInfoSync();
+
+console.log(result.brand, result.model, result.system);
+console.log(result.platform, result.benchmarkLevel);
+```
+
+## 返回值
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>abi</code></td><td><code>string</code></td><td>否</td><td>豆包客户端二进制接口类型，仅 Android 支持。</td></tr>
+<tr><td><code>benchmarkLevel</code></td><td><code>number</code></td><td>是</td><td>设备性能等级，值越高性能越好；-1 表示未知。</td></tr>
+<tr><td><code>brand</code></td><td><code>string</code></td><td>是</td><td>设备品牌。</td></tr>
+<tr><td><code>cpuType</code></td><td><code>string</code></td><td>否</td><td>设备 CPU 型号，仅 Android 支持。</td></tr>
+<tr><td><code>deviceAbi</code></td><td><code>string</code></td><td>否</td><td>设备二进制接口类型，仅 Android 支持。</td></tr>
+<tr><td><code>memorySize</code></td><td><code>string</code></td><td>是</td><td>设备内存大小，单位 MB。</td></tr>
+<tr><td><code>model</code></td><td><code>string</code></td><td>是</td><td>设备型号。</td></tr>
+<tr><td><code>platform</code></td><td><code>string</code></td><td>是</td><td>客户端平台。</td></tr>
+<tr><td><code>system</code></td><td><code>string</code></td><td>是</td><td>操作系统及版本。</td></tr>
+</tbody>
+</table>
+
+### 返回示例
+
+```json
+{
+  "benchmarkLevel": 30,
+  "brand": "Apple",
+  "model": "iPhone 15 Pro",
+  "system": "iOS 17.5",
+  "platform": "ios",
+  "memorySize": "8192"
+}
+```
+
+## 平台差异
+
+- **Android**：`abi`、`deviceAbi`、`cpuType` 为可选字段，豆包无法获取时不返回
+- **iOS**：不返回 `abi`、`deviceAbi`、`cpuType`
+
+## 相关类型
+
+<a id="getdeviceinforesult"></a>
+### GetDeviceInfoResult
+
+设备基础信息。
+
+#### Properties
+
+• **abi?**: `string` - 豆包客户端二进制接口类型，仅 Android 支持
+• **deviceAbi?**: `string` - 设备二进制接口类型，仅 Android 支持
+• **benchmarkLevel**: `number` - 设备性能等级，值越高性能越好；-1 表示未知
+• **brand**: `string` - 设备品牌
+• **model**: `string` - 设备型号
+• **system**: `string` - 操作系统及版本
+• **platform**: `string` - 客户端平台
+• **cpuType?**: `string` - 设备 CPU 型号，仅 Android 支持
+• **memorySize**: `string` - 设备内存大小，单位 MB