@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/30-/346/227/245/345/216/206.md

@@ -0,0 +1,417 @@
+# 豆包应用插件的端能力 API: 日历
+
+向系统日历添加事件和重复事件。
+
+[返回目录](./groups.md) | [返回速查](./quick-reference.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [addPhoneCalendar](#addphonecalendar) | 向系统日历添加事件。 |
+| [addPhoneRepeatCalendar](#addphonerepeatcalendar) | 向系统日历添加重复事件。 |
+| [deletePhoneCalendar](#deletephonecalendar) | 按标题和原始时间删除全部匹配的系统日历事件。 |
+
+## API 详情
+
+<a id="addphonecalendar"></a>
+### addPhoneCalendar()
+
+# addPhoneCalendar
+
+向系统日历添加事件。
+
+## 扫码预览
+![扫码预览 addPhoneCalendar](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%252Fadd-phone-calendar%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.19`。
+
+## 支持平台
+
+<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>scope.addPhoneCalendar</code></td><td>必须</td><td>Android、iOS</td><td>需要在 manifest 中声明 scope.addPhoneCalendar，并由用户授权写入系统日历。</td></tr>
+</tbody>
+</table>
+
+### 授权行为
+
+- **Android**：首次调用会依次申请应用日历授权和系统日历读写权限；用户拒绝、取消或权限被撤销后调用失败，可通过重新发起授权或系统设置恢复。
+- **iOS**：首次调用会依次申请应用日历授权和系统日历写入权限；用户拒绝、取消或权限被撤销后调用失败，可通过重新发起授权或系统设置恢复。
+
+### 前置条件
+
+- **iOS**：设备需要存在可写入的系统日历账户
+
+## 使用说明
+
+- startTime、endTime 使用 Unix 秒级时间戳；alarmOffset 单位为秒，Android 系统日历提醒粒度会按分钟处理。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+addPhoneCalendar(params: AddPhoneCalendarParams): Promise<object>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>alarm</code></td><td><code>boolean</code></td><td>否</td><td><code>true</code></td><td>-</td><td>是否提醒。</td></tr>
+<tr><td><code>alarmOffset</code></td><td><code>number</code></td><td>否</td><td><code>0</code></td><td>-</td><td>提前提醒时间，单位秒。0 表示开始时提醒。</td></tr>
+<tr><td><code>allDay</code></td><td><code>boolean</code></td><td>否</td><td><code>false</code></td><td>-</td><td>是否为全天事件。</td></tr>
+<tr><td><code>description</code></td><td><code>string</code></td><td>否</td><td><code>-</code></td><td>-</td><td>事件描述。</td></tr>
+<tr><td><code>endTime</code></td><td><code>number</code></td><td>否</td><td><code>startTime</code></td><td>-</td><td>结束时间的 Unix 秒级时间戳。</td></tr>
+<tr><td><code>location</code></td><td><code>string</code></td><td>否</td><td><code>-</code></td><td>-</td><td>事件位置。</td></tr>
+<tr><td><code>path</code></td><td><code>string</code></td><td>否</td><td><code>-</code></td><td>-</td><td>跳转链接或客户端路由。传入后按原值追加到日历备注。</td></tr>
+<tr><td><code>startTime</code></td><td><code>number</code></td><td>是</td><td>-</td><td>-</td><td>开始时间的 Unix 秒级时间戳。</td></tr>
+<tr><td><code>title</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>日历事件标题。</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { addPhoneCalendar } from '@doubao-dev/framework/api';
+
+const startTime = Math.floor(Date.now() / 1000) + 3600;
+
+await addPhoneCalendar({
+  title: '项目评审',
+  startTime,
+  endTime: startTime + 1800,
+  alarm: true,
+  alarmOffset: 300
+});
+```
+
+## 成功返回
+
+无返回字段。
+
+<a id="addphonerepeatcalendar"></a>
+### addPhoneRepeatCalendar()
+
+# addPhoneRepeatCalendar
+
+向系统日历添加重复事件。
+
+## 扫码预览
+![扫码预览 addPhoneRepeatCalendar](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%252Fadd-phone-repeat-calendar%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>scope.addPhoneCalendar</code></td><td>必须</td><td>Android、iOS</td><td>需要在 manifest 中声明 scope.addPhoneCalendar，并由用户授权写入系统日历。</td></tr>
+</tbody>
+</table>
+
+### 授权行为
+
+- **Android**：首次调用会依次申请应用日历授权和系统日历读写权限；用户拒绝、取消或权限被撤销后调用失败，可通过重新发起授权或系统设置恢复。
+- **iOS**：首次调用会依次申请应用日历授权和系统日历写入权限；用户拒绝、取消或权限被撤销后调用失败，可通过重新发起授权或系统设置恢复。
+
+### 前置条件
+
+- **iOS**：设备需要存在可写入的系统日历账户
+- repeatInterval 为 month 时，startTime 所在日期不能大于 28 日
+
+## 使用说明
+
+- repeatInterval 默认 month；repeatEndTime 不传表示一直重复；startTime、endTime、repeatEndTime 使用 Unix 秒级时间戳。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+addPhoneRepeatCalendar(params: AddPhoneRepeatCalendarParams): Promise<object>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>alarm</code></td><td><code>boolean</code></td><td>否</td><td><code>true</code></td><td>-</td><td>是否提醒。</td></tr>
+<tr><td><code>alarmOffset</code></td><td><code>number</code></td><td>否</td><td><code>0</code></td><td>-</td><td>提前提醒时间，单位秒。0 表示开始时提醒。</td></tr>
+<tr><td><code>allDay</code></td><td><code>boolean</code></td><td>否</td><td><code>false</code></td><td>-</td><td>是否为全天事件。</td></tr>
+<tr><td><code>description</code></td><td><code>string</code></td><td>否</td><td><code>-</code></td><td>-</td><td>事件描述。</td></tr>
+<tr><td><code>endTime</code></td><td><code>number</code></td><td>否</td><td><code>startTime</code></td><td>-</td><td>结束时间的 Unix 秒级时间戳。</td></tr>
+<tr><td><code>location</code></td><td><code>string</code></td><td>否</td><td><code>-</code></td><td>-</td><td>事件位置。</td></tr>
+<tr><td><code>path</code></td><td><code>string</code></td><td>否</td><td><code>-</code></td><td>-</td><td>跳转链接或客户端路由。传入后按原值追加到日历备注。</td></tr>
+<tr><td><code>repeatEndTime</code></td><td><code>number</code></td><td>否</td><td><code>-</code></td><td>-</td><td>重复结束时间的 Unix 秒级时间戳。</td></tr>
+<tr><td><code>repeatInterval</code></td><td><code>CalendarRepeatInterval</code></td><td>否</td><td><code>month</code></td><td>-</td><td>重复周期。</td></tr>
+<tr><td><code>startTime</code></td><td><code>number</code></td><td>是</td><td>-</td><td>-</td><td>开始时间的 Unix 秒级时间戳。</td></tr>
+<tr><td><code>title</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>日历事件标题。</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { addPhoneRepeatCalendar } from '@doubao-dev/framework/api';
+
+const startTime = Math.floor(Date.now() / 1000) + 3600;
+
+await addPhoneRepeatCalendar({
+  title: '每周例会',
+  startTime,
+  endTime: startTime + 1800,
+  repeatInterval: 'week'
+});
+```
+
+## 成功返回
+
+无返回字段。
+
+<a id="deletephonecalendar"></a>
+### deletePhoneCalendar()
+
+# deletePhoneCalendar
+
+按标题和原始时间删除全部匹配的系统日历事件。
+
+## 扫码预览
+![扫码预览 deletePhoneCalendar](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%252Fdelete-phone-calendar%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.6.0`。
+
+## 支持平台
+
+<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>scope.addPhoneCalendar</code></td><td>必须</td><td>Android、iOS</td><td>复用系统日历写入授权。</td></tr>
+</tbody>
+</table>
+
+### 授权行为
+
+- **Android**：申请应用授权和日历写入权限，拒绝或撤销后调用失败。
+- **iOS**：申请应用授权和日历完整访问权限，拒绝或撤销后调用失败。
+
+### 前置条件
+
+- 传入创建时的原始参数；重复事件使用系列首个事件的参数
+
+## 使用说明
+
+- 重复事件删除整个系列；事件不存在也成功；暂不支持全天事件。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+deletePhoneCalendar(params: DeletePhoneCalendarParams): Promise<object>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>endTime</code></td><td><code>number</code></td><td>否</td><td><code>startTime</code></td><td>-</td><td>创建时的结束时间，Unix 秒级时间戳。</td></tr>
+<tr><td><code>startTime</code></td><td><code>number</code></td><td>是</td><td>-</td><td>-</td><td>创建时的开始时间，Unix 秒级时间戳。</td></tr>
+<tr><td><code>title</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>创建时的标题。</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { deletePhoneCalendar } from '@doubao-dev/framework/api';
+await deletePhoneCalendar({ title: '项目评审', startTime: 1770000000, endTime: 1770001800 });
+```
+
+## 成功返回
+
+无返回字段。
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 失败示例
+
+```json
+{
+  "errNo": 102,
+  "errMsg": "internal error"
+}
+```
+
+### 错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
+</thead>
+<tbody>
+<tr><td><code>102</code></td><td><code>internal error</code></td><td>Android、iOS</td><td>系统日历存储删除失败</td><td>稍后重试</td></tr>
+<tr><td><code>104</code></td><td><code>invalid parameter</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、iOS</td><td>无系统日历权限</td><td>在系统设置中授权</td></tr>
+<tr><td><code>107</code></td><td><code>user permission denied</code></td><td>Android、iOS</td><td>应用插件授权被拒绝或取消</td><td>重新授权</td></tr>
+</tbody>
+</table>
+
+## 相关类型
+
+<a id="addphonecalendarparams"></a>
+### AddPhoneCalendarParams
+
+添加系统日历事件的请求参数。
+
+#### Properties
+
+• **title**: `string` - 日历事件标题
+• **startTime**: `number` - 开始时间的 Unix 秒级时间戳
+• **allDay?**: `boolean` - 是否为全天事件
+• **description?**: `string` - 事件描述
+• **location?**: `string` - 事件位置
+• **endTime?**: `number` - 结束时间的 Unix 秒级时间戳
+• **alarm?**: `boolean` - 是否提醒
+• **alarmOffset?**: `number` - 提前提醒时间，单位秒。0 表示开始时提醒
+• **path?**: `string` - 跳转链接或客户端路由。传入后按原值追加到日历备注
+
+<a id="calendarrepeatinterval"></a>
+### CalendarRepeatInterval
+
+日历重复周期。
+
+#### Type
+
+`'day' | 'week' | 'month' | 'year'`
+
+<a id="addphonerepeatcalendarparams"></a>
+### AddPhoneRepeatCalendarParams
+
+添加重复日历事件的请求参数。
+
+#### Properties
+
+• **repeatInterval?**: `CalendarRepeatInterval` - 重复周期
+• **repeatEndTime?**: `number` - 重复结束时间的 Unix 秒级时间戳
+
+<a id="deletephonecalendarparams"></a>
+### DeletePhoneCalendarParams
+
+删除系统日历事件的请求参数。
+
+#### Properties
+
+• **title**: `string` - 创建时的标题
+• **startTime**: `number` - 创建时的开始时间，Unix 秒级时间戳
+• **endTime?**: `number` - 创建时的结束时间，Unix 秒级时间戳

package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/31-/347/224/265/350/257/235.md

@@ -0,0 +1,144 @@
+# 豆包应用插件的端能力 API: 电话
+
+拨打电话。
+
+[返回目录](./groups.md) | [返回速查](./quick-reference.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [makePhoneCall](#makephonecall) | 拨打电话。 |
+
+## API 详情
+
+<a id="makephonecall"></a>
+### makePhoneCall()
+
+# makePhoneCall
+
+拨打电话。
+
+## 扫码预览
+![扫码预览 makePhoneCall](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%252Fmake-phone-call%252Findex)
+
+## 使用限制
+
+> [!WARNING]
+> **Android、iOS**：Android 通过 ACTION_DIAL 打开拨号盘即成功，iOS 通过 open(tel:) 唤起，是否进入拨号盘取决于系统处理结果；相同调用在双端&quot;成功&quot;代表的实际状态不同。
+
+## 支持版本
+
+前端库版本不低于 `0.0.19`。
+
+## 支持平台
+
+<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
+makePhoneCall(params: MakePhoneCallParams): Promise<object>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>phoneNumber</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>需要拨打的电话号码</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { makePhoneCall } from '@doubao-dev/framework/api';
+
+await makePhoneCall({ phoneNumber: '13800000000' });
+```
+
+## 成功返回
+
+无返回字段。
+
+### 返回示例
+
+```json
+{}
+```
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 失败示例
+
+```json
+{
+  "errNo": 104,
+  "errMsg": "invalid parameter"
+}
+```
+
+### 错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
+</thead>
+<tbody>
+<tr><td><code>104</code></td><td><code>invalid parameter</code></td><td>Android、iOS</td><td>phoneNumber 为空，或在 iOS 上无法拼接为有效的拨号 URL</td><td>传入合法的电话号码后重试。</td></tr>
+<tr><td><code>103</code></td><td><code>feature not support</code></td><td>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="makephonecallparams"></a>
+### MakePhoneCallParams
+
+#### Properties
+
+• **phoneNumber**: `string` - 需要拨打的电话号码