@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/27-/347/224/265/346/261/240.md

@@ -0,0 +1,235 @@
+# 豆包应用插件的端能力 API: 电池
+
+电池信息读取与变化监听。
+
+[返回目录](./groups.md) | [返回速查](./quick-reference.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getBatteryInfo](#getbatteryinfo) | 获取电池信息。 |
+| [onBatteryInfoChange](#onbatteryinfochange) | 监听电池信息变化事件。<br><br>返回取消监听函数。 |
+
+## API 详情
+
+<a id="getbatteryinfo"></a>
+### getBatteryInfo()
+
+# getBatteryInfo
+
+获取电池信息。
+
+## 扫码预览
+![扫码预览 getBatteryInfo](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-battery-info%252Findex)
+
+## 使用限制
+
+> [!WARNING]
+> **Android、iOS**：Android 返回 0 到 100，iOS 由系统电量换算后可能返回 0；依赖固定下限的调用方在低电量时可能误判。
+
+## 支持版本
+
+前端库版本不低于 `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>
+
+## 使用说明
+
+- 电量为瞬时快照，需要持续跟踪省电模式时改用 `onBatteryInfoChange`
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+getBatteryInfo(params?: object): Promise<GetBatteryInfoResult>
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```typescript
+import { getBatteryInfo } from '@doubao-dev/framework/api';
+
+const { isCharging, level } = await getBatteryInfo();
+
+console.log(isCharging, level);
+```
+
+## 成功返回
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>isCharging</code></td><td><code>boolean</code></td><td>是</td><td>-</td><td>是否正在充电。</td></tr>
+<tr><td><code>level</code></td><td><code>number</code></td><td>是</td><td>取值范围 0 到 100 的整数</td><td>当前电量百分比。Android、iOS：Android 返回 0 到 100，iOS 由系统电量换算后可能返回 0。</td></tr>
+</tbody>
+</table>
+
+### 返回示例
+
+```json
+{
+  "isCharging": false,
+  "level": 82
+}
+```
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 错误码
+
+#### 通用错误码
+
+<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>
+
+<a id="onbatteryinfochange"></a>
+### onBatteryInfoChange()
+
+# onBatteryInfoChange
+
+监听电池信息变化事件。
+
+## 扫码预览
+![扫码预览 onBatteryInfoChange](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-battery-info%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>
+<tr><td>卡片</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 使用说明
+
+- 取消函数只移除本地回调，不影响系统省电模式状态
+
+## 调用方式
+
+### 事件监听 API
+
+```typescript
+onBatteryInfoChange(callback: (event: BatteryInfoChangeEvent) => void): () => void
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```ts
+import { onBatteryInfoChange } from '@doubao-dev/framework/api';
+
+const off = onBatteryInfoChange(({ isLowPowerModeEnabled }) => {
+  console.log(isLowPowerModeEnabled);
+});
+
+off();
+```
+
+## 回调参数
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>event.isLowPowerModeEnabled</code></td><td><code>boolean</code></td><td>是</td><td>是否处于省电模式。</td></tr>
+</tbody>
+</table>
+
+## 返回值
+
+返回取消当前监听函数的函数。
+
+### 回调示例
+
+```json
+{
+  "isLowPowerModeEnabled": true
+}
+```
+
+## 相关类型
+
+<a id="getbatteryinforesult"></a>
+### GetBatteryInfoResult
+
+电池信息。
+
+#### Properties
+
+• **isCharging**: `boolean` - 是否正在充电
+• **level**: `number` - 当前电量百分比
+
+<a id="batteryinfochangeevent"></a>
+### BatteryInfoChangeEvent
+
+电池信息变化事件。
+
+#### Properties
+
+• **isLowPowerModeEnabled**: `boolean` - 是否处于省电模式

package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/28-/345/211/252/350/264/264/346/235/277.md

@@ -0,0 +1,303 @@
+# 豆包应用插件的端能力 API: 剪贴板
+
+读取和设置系统剪贴板内容。
+
+[返回目录](./groups.md) | [返回速查](./quick-reference.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getClipboardData](#getclipboarddata) | 获取剪贴板内容。 |
+| [setClipboardData](#setclipboarddata) | 设置系统剪贴板内容。 |
+
+## API 详情
+
+<a id="getclipboarddata"></a>
+### getClipboardData()
+
+# getClipboardData
+
+获取剪贴板内容。
+
+## 扫码预览
+![扫码预览 getClipboardData](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%252Fclipboard%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>
+<tr><td>卡片</td><td>支持</td></tr>
+</tbody>
+</table>
+
+## 接入准备
+
+### 权限要求
+
+<table>
+<thead>
+<tr><th>类型</th><th>标识</th><th>是否必须</th><th>平台</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td>豆包能力</td><td><code>剪贴板能力</code></td><td>按条件</td><td>Android、iOS</td><td>需要豆包提供剪贴板能力，未开通时调用失败</td></tr>
+</tbody>
+</table>
+
+### 授权行为
+
+- 该接口不主动弹出授权，仅在豆包已提供剪贴板能力时读取；能力缺失时调用直接失败，需在支持该能力的豆包版本中调用
+
+## 使用说明
+
+- 剪贴板内容属于敏感信息，请仅在用户明确操作后读取
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+getClipboardData(params?: object): Promise<GetClipboardDataResult>
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```typescript
+import { getClipboardData } from '@doubao-dev/framework/api';
+
+const { data } = await getClipboardData();
+
+console.log(data);
+```
+
+## 成功返回
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>data</code></td><td><code>string</code></td><td>是</td><td>当前剪贴板内容。</td></tr>
+</tbody>
+</table>
+
+### 返回示例
+
+```json
+{
+  "data": "hello doubao"
+}
+```
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./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、iOS</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、iOS</td></tr>
+</tbody>
+</table>
+
+<a id="setclipboarddata"></a>
+### setClipboardData()
+
+# setClipboardData
+
+设置系统剪贴板内容。
+
+## 扫码预览
+![扫码预览 setClipboardData](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%252Fclipboard%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.20`。
+
+## 支持平台
+
+<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>
+
+## 接入准备
+
+### 权限要求
+
+<table>
+<thead>
+<tr><th>类型</th><th>标识</th><th>是否必须</th><th>平台</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td>豆包能力</td><td><code>剪贴板能力</code></td><td>按条件</td><td>Android、iOS</td><td>需要豆包提供剪贴板能力，未开通时调用失败</td></tr>
+</tbody>
+</table>
+
+### 授权行为
+
+- 该接口不主动弹出授权，仅在豆包已提供剪贴板能力时写入；能力缺失时调用直接失败，需在支持该能力的豆包版本中调用
+
+## 使用说明
+
+- 写入剪贴板前建议向用户说明，避免在无感知情况下修改系统剪贴板
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+setClipboardData(params: SetClipboardDataParams): Promise<object>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>data</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>需要设置的剪贴板内容</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { setClipboardData } from '@doubao-dev/framework/api';
+
+await setClipboardData({ data: '复制内容' });
+```
+
+## 成功返回
+
+无返回字段。
+
+### 返回示例
+
+```json
+{}
+```
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./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、iOS</td><td>当前豆包版本不支持写入剪贴板</td><td>升级至支持剪贴板能力的豆包版本后重试。</td></tr>
+<tr><td><code>106</code></td><td><code>system permission denied</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、iOS</td></tr>
+</tbody>
+</table>
+
+## 相关类型
+
+<a id="getclipboarddataresult"></a>
+### GetClipboardDataResult
+
+剪贴板读取结果。
+
+#### Properties
+
+• **data**: `string` - 当前剪贴板内容
+
+<a id="setclipboarddataparams"></a>
+### SetClipboardDataParams
+
+#### Properties
+
+• **data**: `string` - 需要设置的剪贴板内容

package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/29-/345/212/240/345/257/206.md

@@ -0,0 +1,126 @@
+# 豆包应用插件的端能力 API: 加密
+
+安全随机数能力。
+
+[返回目录](./groups.md) | [返回速查](./quick-reference.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getRandomValues](#getrandomvalues) | 获取安全随机数。 |
+
+## API 详情
+
+<a id="getrandomvalues"></a>
+### getRandomValues()
+
+# getRandomValues
+
+获取安全随机数。
+
+## 扫码预览
+![扫码预览 getRandomValues](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-random-values%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>
+<tr><td>卡片</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 使用说明
+
+- 生成的字节数越大耗时越长，建议按实际需要申请长度
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+getRandomValues(params: GetRandomValuesParams): Promise<GetRandomValuesResult>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>length</code></td><td><code>number</code></td><td>是</td><td>-</td><td>取值范围 0 到 1048576 的整数，超出范围会抛出 RangeError</td><td>需要生成的字节数。</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { getRandomValues } from '@doubao-dev/framework/api';
+
+const { randomValues } = await getRandomValues({ length: 16 });
+const bytes = new Uint8Array(randomValues);
+
+console.log(bytes);
+```
+
+## 成功返回
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>randomValues</code></td><td><code>ArrayBuffer</code></td><td>是</td><td>生成的随机字节。</td></tr>
+</tbody>
+</table>
+
+### 返回示例
+
+```json
+{
+  "randomValues": {}
+}
+```
+
+## 相关类型
+
+<a id="getrandomvaluesparams"></a>
+### GetRandomValuesParams
+
+获取安全随机数的请求参数。
+
+#### Properties
+
+• **length**: `number` - 需要生成的字节数
+
+<a id="getrandomvaluesresult"></a>
+### GetRandomValuesResult
+
+获取安全随机数的返回结果。
+
+#### Properties
+
+• **randomValues**: `ArrayBuffer` - 生成的随机字节