@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/34-/351/234/207/345/212/250.md

@@ -0,0 +1,277 @@
+# 豆包应用插件的端能力 API: 震动
+
+触发短震动和长震动。
+
+[返回目录](./groups.md) | [返回速查](./quick-reference.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [vibrateShort](#vibrateshort) | 触发短震动。 |
+| [vibrateLong](#vibratelong) | 触发长震动。 |
+
+## API 详情
+
+<a id="vibrateshort"></a>
+### vibrateShort()
+
+# vibrateShort
+
+触发短震动。
+
+## 扫码预览
+![扫码预览 vibrateShort](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%252Fvibrate%252Findex)
+
+## 使用限制
+
+> [!WARNING]
+> **Android**：Android 要求必传 type，省略可能导致调用不生效；未显式传 type 的调用在 Android 上行为不确定。
+
+## 支持版本
+
+前端库版本不低于 `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>
+
+## 使用说明
+
+- 建议显式传入 type，避免在 Android 上因缺省参数导致震动不生效
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+vibrateShort(params?: VibrateShortParams): Promise<object>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>type</code></td><td><code>VibrateShortType</code></td><td>否</td><td><code>medium</code></td><td>heavy 为强震动，medium 为中等震动，light 为轻微震动</td><td>震动强度类型。Android：Android 要求必传 type，省略可能导致调用不生效。</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { vibrateShort } from '@doubao-dev/framework/api';
+
+await vibrateShort({ type: 'medium' });
+```
+
+## 成功返回
+
+无返回字段。
+
+### 返回示例
+
+```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>Android 设备无振动器或不支持震动能力，或 iOS 系统版本低于 13.0</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**：设备不支持震动或触发震动失败时返回 102 internal error；iOS 无对应失败错误码
+
+<a id="vibratelong"></a>
+### vibrateLong()
+
+# vibrateLong
+
+触发长震动。
+
+## 扫码预览
+![扫码预览 vibrateLong](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%252Fvibrate%252Findex)
+
+## 使用限制
+
+> [!WARNING]
+> **Android、iOS**：Android 固定震动约 400ms 且在设备不支持时可能失败，iOS 恒返回成功；依赖统一成功语义的调用方在双端体验不一致。
+
+## 支持版本
+
+前端库版本不低于 `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>
+
+## 使用说明
+
+- Android 长震动时长固定约 400ms，无法自定义
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+vibrateLong(params?: object): Promise<object>
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```typescript
+import { vibrateLong } from '@doubao-dev/framework/api';
+
+await vibrateLong();
+```
+
+## 成功返回
+
+无返回字段。
+
+### 返回示例
+
+```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</td><td>Android 设备无振动器或不支持震动能力</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>
+
+## 平台差异
+
+- **iOS**：长震动恒返回成功，无失败错误码
+
+## 相关类型
+
+<a id="vibrateshorttype"></a>
+### VibrateShortType
+
+短震动类型。
+
+#### Type
+
+`'heavy' | 'medium' | 'light'`
+
+<a id="vibrateshortparams"></a>
+### VibrateShortParams
+
+短震动请求参数。
+
+#### Properties
+
+• **type?**: `VibrateShortType` - 震动强度类型