@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/01-/345/237/272/347/241/200.md

@@ -0,0 +1,1389 @@
+# 豆包应用插件的端能力 API: 基础
+
+账号、授权、豆包客户端信息、窗口信息和能力可用性。
+
+[返回目录](./groups.md) | [返回速查](./quick-reference.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getAccountInfo](#getaccountinfo) | 异步获取账号信息。 |
+| [getAccountInfoSync](#getaccountinfosync) | 同步获取账号信息。<br><br>同步 API。 |
+| [authorize](#authorize) | 提前向用户发起指定 scope 的授权；scope.healthData 仅用于选择 iOS HealthKit 系统授权路径。 |
+| [arrayBufferToBase64](#arraybuffertobase64) | 将 ArrayBuffer 转换为 Base64 字符串。 |
+| [base64ToArrayBuffer](#base64toarraybuffer) | 将 Base64 字符串转换为 ArrayBuffer。 |
+| [canIUse](#caniuse) | 检测当前环境是否支持指定 API 或能力。 |
+| [getPerformance](#getperformance) | 获取当前应用插件的性能数据。 Entry 由客户端保存；getEntries*() 同步查询当前快照，observer 只接收新完成的 Entry。 |
+| [getSetting](#getsetting) | 获取用户当前的应用授权设置。 |
+| [openSetting](#opensetting) | 打开应用插件授权设置页面。 |
+| [getUserIdentifiers](#getuseridentifiers) | 获取当前用户的加密设备标识，参数可省略或传入空对象。 |
+
+## API 详情
+
+<a id="getaccountinfo"></a>
+### getAccountInfo()
+
+# getAccountInfo
+
+异步获取账号信息。
+
+## 扫码预览
+![扫码预览 getAccountInfo](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fbasic%252Fget-account-info%252Findex)
+
+## 使用限制
+
+> [!WARNING]
+> **Android、iOS**：仅返回 develop 或 release，永远不会返回 trial；依赖 trial 判断体验版环境的逻辑不会生效。
+
+## 支持版本
+
+前端库版本不低于 `0.0.18`。
+
+## 支持平台
+
+<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
+getAccountInfo(params?: object): Promise<GetAccountInfoResult>
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```typescript
+import { getAccountInfo } from '@doubao-dev/framework/api';
+
+const result = await getAccountInfo();
+console.log(result.miniProgram.appId, result.miniProgram.envVersion, result.miniProgram.version);
+```
+
+## 成功返回
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>miniProgram</code></td><td><code>DoubaoAppAccountInfo</code></td><td>是</td><td>-</td><td>应用插件账号信息</td></tr>
+<tr><td><code>miniProgram.appId</code></td><td><code>string</code></td><td>是</td><td>-</td><td>应用插件 appId</td></tr>
+<tr><td><code>miniProgram.envVersion</code></td><td><code>&quot;develop&quot; | &quot;trial&quot; | &quot;release&quot;</code></td><td>是</td><td>Android、iOS 当前只返回 develop 或 release，不会返回 trial</td><td>当前应用插件的版本类型。<br><br>- develop：开发版<br>- trial：体验版<br>- release：正式版。Android、iOS：仅返回 develop 或 release，永远不会返回 trial。</td></tr>
+<tr><td><code>miniProgram.version</code></td><td><code>string</code></td><td>是</td><td>-</td><td>应用插件版本号。</td></tr>
+<tr><td><code>plugin</code></td><td><code>PluginAccountInfo</code></td><td>否</td><td>-</td><td>插件账号信息（仅在插件中调用时包含）</td></tr>
+<tr><td><code>plugin.appId</code></td><td><code>string</code></td><td>否</td><td>-</td><td>插件 appId</td></tr>
+<tr><td><code>plugin.version</code></td><td><code>string</code></td><td>否</td><td>-</td><td>插件版本号，'a.b.c' 形式</td></tr>
+</tbody>
+</table>
+
+### 返回示例
+
+```json
+{
+  "miniProgram": {
+    "appId": "7000000000000000000",
+    "envVersion": "release",
+    "version": "1.0.0"
+  }
+}
+```
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./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="getaccountinfosync"></a>
+### getAccountInfoSync()
+
+# getAccountInfoSync
+
+同步获取账号信息。
+
+## 扫码预览
+![扫码预览 getAccountInfoSync](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fbasic%252Fget-account-info%252Findex)
+
+## 使用限制
+
+> [!WARNING]
+> **Android、iOS**：仅返回 develop 或 release，永远不会返回 trial；依赖 trial 判断体验版环境的逻辑不会生效。
+
+## 支持版本
+
+前端库版本不低于 `0.0.18`。
+
+## 支持平台
+
+<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
+getAccountInfoSync(params?: object): GetAccountInfoResult
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```typescript
+import { getAccountInfoSync } from '@doubao-dev/framework/api';
+
+const result = getAccountInfoSync();
+console.log(result.miniProgram.appId, result.miniProgram.envVersion, result.miniProgram.version);
+```
+
+## 返回值
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>miniProgram</code></td><td><code>DoubaoAppAccountInfo</code></td><td>是</td><td>-</td><td>应用插件账号信息</td></tr>
+<tr><td><code>miniProgram.appId</code></td><td><code>string</code></td><td>是</td><td>-</td><td>应用插件 appId</td></tr>
+<tr><td><code>miniProgram.envVersion</code></td><td><code>&quot;develop&quot; | &quot;trial&quot; | &quot;release&quot;</code></td><td>是</td><td>Android、iOS 当前只返回 develop 或 release，不会返回 trial</td><td>当前应用插件的版本类型。<br><br>- develop：开发版<br>- trial：体验版<br>- release：正式版。Android、iOS：仅返回 develop 或 release，永远不会返回 trial。</td></tr>
+<tr><td><code>miniProgram.version</code></td><td><code>string</code></td><td>是</td><td>-</td><td>应用插件版本号。</td></tr>
+<tr><td><code>plugin</code></td><td><code>PluginAccountInfo</code></td><td>否</td><td>-</td><td>插件账号信息（仅在插件中调用时包含）</td></tr>
+<tr><td><code>plugin.appId</code></td><td><code>string</code></td><td>否</td><td>-</td><td>插件 appId</td></tr>
+<tr><td><code>plugin.version</code></td><td><code>string</code></td><td>否</td><td>-</td><td>插件版本号，'a.b.c' 形式</td></tr>
+</tbody>
+</table>
+
+### 返回示例
+
+```json
+{
+  "miniProgram": {
+    "appId": "7000000000000000000",
+    "envVersion": "release",
+    "version": "1.0.0"
+  }
+}
+```
+
+## 错误处理
+
+同步调用失败时抛出错误。错误对象和通用错误码见 [通用错误处理](./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="authorize"></a>
+### authorize()
+
+# authorize
+
+提前向用户发起指定 scope 的授权；scope.healthData 仅用于选择 iOS HealthKit 系统授权路径。
+
+## 扫码预览
+![扫码预览 authorize](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fbasic%252Fauthorize%252Findex)
+
+## 使用限制
+
+> [!WARNING]
+> **Android、iOS**：传入 scope.payment 时被判为非法 scope 并直接失败；依赖 scope.payment 发起授权的调用无法成功。
+
+## 支持版本
+
+前端库版本不低于 `0.0.18`。
+
+## 支持平台
+
+<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.healthData 的 scope</code></td><td>必须</td><td>Android、iOS</td><td>按传入 scope 发起对应的应用授权。</td></tr>
+<tr><td>应用权限</td><td><code>scope.healthData</code></td><td>否</td><td>iOS</td><td>不校验 manifest，也不查询或更新服务端应用插件的 scope 状态。</td></tr>
+<tr><td>系统权限</td><td>HealthKit read</td><td>必须</td><td>iOS</td><td>scope.healthData 会申请 options.types 对应的系统读取权限。</td></tr>
+</tbody>
+</table>
+
+### 授权行为
+
+- **Android**：非健康 scope 会发起应用插件及相应系统授权；当前不支持 scope.healthData。
+- **iOS**：非健康 scope 会发起应用插件及相应系统授权；scope.healthData 仅可能展示 HealthKit 系统授权框。
+
+### 前置条件
+
+- **Android**：非健康 scope 需要在应用权限声明中配置；当前不支持 scope.healthData
+- **iOS**：非健康 scope 需要在应用权限声明中配置；scope.healthData 不需要 manifest 声明
+
+## 使用说明
+
+- **Android**：非健康 scope 的授权状态可通过 `getSetting` 查询；当前不支持 scope.healthData。
+- **iOS**：非健康 scope 的授权状态可通过 `getSetting` 查询；scope.healthData 的逐类型系统状态通过 `getAppAuthorizeSetting` 查询。
+- **iOS**：HealthKit 授权成功表示系统授权流程已完成；Apple 不向应用公开每个读取类型是否被用户拒绝。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+authorize(params: AuthorizeRequest): Promise<object>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>options</code></td><td><code>HealthDataAuthorizeOptions</code></td><td>否</td><td><code>-</code></td><td>-</td><td>权限扩展参数；仅 scope.healthData 生效，用于传入 HealthKit 读取类型，其他 scope 会忽略该字段。</td></tr>
+<tr><td><code>options.types</code></td><td><code>HealthDataType[]</code></td><td>否</td><td>-</td><td>-</td><td>健康数据类型列表；用于申请对应的 HealthKit 读取权限。</td></tr>
+<tr><td><code>scope</code></td><td><code>Scope</code></td><td>是</td><td>-</td><td>-</td><td>授权范围。Android、iOS：传入 scope.payment 时被判为非法 scope 并直接失败。</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { authorize } from '@doubao-dev/framework/api';
+
+await authorize({ scope: 'scope.userLocation' });
+await authorize({
+  scope: 'scope.healthData',
+  options: { types: ['heart_rate', 'step_count'] }
+});
+```
+
+## 成功返回
+
+无返回字段。
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 失败示例
+
+```json
+{
+  "errNo": 107,
+  "errMsg": "user permission denied"
+}
+```
+
+### 错误码
+
+<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>传入的 scope 为空或不受支持（如 scope.payment）</td><td>检查并传入受支持的 scope 后重试。</td></tr>
+<tr><td><code>104</code></td><td><code>invalid parameter</code></td><td>iOS</td><td>scope.healthData 未传 options.types、列表为空或包含不支持类型</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>说明能力用途后再次调用 `authorize` 重新发起授权。</td></tr>
+<tr><td><code>114</code></td><td><code>operation cancelled</code></td><td>Android、iOS</td><td>用户取消了授权弹窗</td><td>用户需要时可再次调用 `authorize` 重新发起授权。</td></tr>
+<tr><td><code>301</code></td><td><code>network request cancelled</code></td><td>iOS</td><td>授权过程中的网络请求被取消</td><td>确认应用和网络状态后重试。</td></tr>
+<tr><td><code>302</code></td><td><code>connection timed out</code></td><td>iOS</td><td>授权过程中的网络连接超时</td><td>检查网络连接后重试。</td></tr>
+<tr><td><code>303</code></td><td><code>no network connection</code></td><td>iOS</td><td>当前无可用网络连接</td><td>恢复网络连接后重试。</td></tr>
+<tr><td><code>305</code></td><td><code>network failure</code></td><td>Android、iOS</td><td>授权过程中发生其他网络错误</td><td>检查网络连接，稍后重试。</td></tr>
+<tr><td><code>112</code></td><td><code>invalid result</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>
+
+## 平台差异
+
+- **iOS**：网络类失败会细分为 301/302/303/305，并可能返回 112；Android 的网络类失败统一返回 305。
+
+<a id="arraybuffertobase64"></a>
+### arrayBufferToBase64()
+
+# arrayBufferToBase64
+
+将 ArrayBuffer 转换为 Base64 字符串。
+
+## 扫码预览
+![扫码预览 arrayBufferToBase64](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fbasic%252Fbase64%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.1.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>
+
+## 调用方式
+
+### 同步 API
+
+```typescript
+arrayBufferToBase64(buffer: ArrayBuffer): string
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>buffer</code></td><td><code>ArrayBuffer</code></td><td>是</td><td>-</td><td>-</td><td>需要编码的二进制数据。</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { arrayBufferToBase64 } from '@doubao-dev/framework/api';
+
+const base64 = arrayBufferToBase64(new Uint8Array([1, 2, 3, 4]).buffer);
+console.log(base64); // AQIDBA==
+```
+
+## 返回值
+
+标准 Base64 编码字符串。
+
+### 返回示例
+
+```json
+"AQIDBA=="
+```
+
+<a id="base64toarraybuffer"></a>
+### base64ToArrayBuffer()
+
+# base64ToArrayBuffer
+
+将 Base64 字符串转换为 ArrayBuffer。
+
+## 扫码预览
+![扫码预览 base64ToArrayBuffer](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fbasic%252Fbase64%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.1.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>
+
+## 调用方式
+
+### 同步 API
+
+```typescript
+base64ToArrayBuffer(base64: string): ArrayBuffer
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>base64</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>需要解码的标准 Base64 字符串。</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { base64ToArrayBuffer } from '@doubao-dev/framework/api';
+
+const buffer = base64ToArrayBuffer('AQIDBA==');
+console.log(Array.from(new Uint8Array(buffer))); // [1, 2, 3, 4]
+```
+
+## 返回值
+
+解码后的二进制数据。
+
+### 返回示例
+
+```json
+{
+  "byteLength": 4
+}
+```
+
+<a id="caniuse"></a>
+### canIUse()
+
+# canIUse
+
+检测当前环境是否支持指定 API 或能力。
+
+## 支持版本
+
+前端库版本不低于 `0.0.14`。
+
+## 支持平台
+
+<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>
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+canIUse(params: CanIUseParams): Promise<CanIUseResult>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>schema</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>需要检测的能力标识，例如 API 名称</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { canIUse } from '@doubao-dev/framework/api';
+
+const { result } = await canIUse({ schema: 'doubao.getLocation' });
+console.log('是否支持 getLocation:', result);
+```
+
+## 成功返回
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>result</code></td><td><code>boolean</code></td><td>是</td><td>是否支持所检测的能力</td></tr>
+</tbody>
+</table>
+
+### 返回示例
+
+```json
+{
+  "result": true
+}
+```
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 失败示例
+
+```json
+{
+  "errNo": 600001,
+  "errMsg": "invalid parameter"
+}
+```
+
+### 错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
+</thead>
+<tbody>
+<tr><td><code>600001</code></td><td><code>invalid parameter</code></td><td>Android、iOS</td><td>schema 为空或格式不合法</td><td>传入有效的 schema 字符串，格式为&quot;命名空间.方法名&quot;</td></tr>
+</tbody>
+</table>
+
+<a id="getperformance"></a>
+### getPerformance()
+
+# getPerformance
+
+获取当前应用插件的性能数据。
+
+Entry 由客户端保存；`getEntries*()` 同步查询当前快照，observer 只接收新完成的 Entry。
+
+## 支持版本
+
+前端库版本不低于 `0.0.42`。
+
+## 支持平台
+
+<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>
+
+## 使用说明
+
+- 仅在需要接收后续新完成的 Entry 时创建 observer；不再需要时调用 disconnect。
+
+## 调用方式
+
+### 同步 API
+
+```typescript
+getPerformance(): Performance
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```typescript
+import { getPerformance } from '@doubao-dev/framework/api';
+
+const performance = getPerformance();
+const observer = performance.createObserver((entryList) => {
+  console.log(entryList.getEntries());
+});
+
+performance.setBufferSize(100);
+observer.observe({ entryTypes: ['render'] });
+console.log(performance.getEntriesByType('render'));
+observer.disconnect();
+```
+
+## 返回值
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>createObserver</code></td><td><code>(callback: PerformanceObserverCallback) =&gt; PerformanceObserver</code></td><td>是</td><td>创建性能观察者。调用返回对象的 `observe` 后，回调会接收之后新完成且匹配的 Entry。</td></tr>
+<tr><td><code>getEntries</code></td><td><code>() =&gt; PerformanceEntry[]</code></td><td>是</td><td>返回当前应用插件已记录的全部性能 Entry。</td></tr>
+<tr><td><code>getEntriesByName</code></td><td><code>(name: string, entryType?: string) =&gt; PerformanceEntry[]</code></td><td>是</td><td>返回指定名称的性能 Entry；传入 entryType 时同时按类型筛选。</td></tr>
+<tr><td><code>getEntriesByType</code></td><td><code>(entryType: string) =&gt; PerformanceEntry[]</code></td><td>是</td><td>返回指定 entryType 的性能 Entry。</td></tr>
+<tr><td><code>setBufferSize</code></td><td><code>(size: number) =&gt; void</code></td><td>是</td><td>设置客户端最多保留的性能 Entry 数量。</td></tr>
+</tbody>
+</table>
+
+### 返回示例
+
+```json
+[
+  {
+    "entryType": "render",
+    "name": "firstRender",
+    "startTime": 1730000000000,
+    "duration": 42,
+    "path": "pages/index/index",
+    "pageId": 1
+  }
+]
+```
+
+<a id="getsetting"></a>
+### getSetting()
+
+# getSetting
+
+获取用户当前的应用授权设置。
+
+## 扫码预览
+![扫码预览 getSetting](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fbasic%252Fget-setting%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.36`。
+
+## 支持平台
+
+<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>
+
+## 使用说明
+
+- authSetting 只表示当前应用插件的 scope 授权，不表示操作系统权限；HealthKit 逐类型系统状态通过 getAppAuthorizeSetting 查询。
+- authSetting 只包含已向用户请求过且状态明确的权限；豆包当前不支持订阅模板，不要传入 withSubscriptions: true。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+getSetting(params?: GetSettingParams): Promise<GetSettingResult>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>withSubscriptions</code></td><td><code>false</code></td><td>否</td><td><code>false</code></td><td>豆包 Android、iOS 当前不支持订阅模板，仅支持 false</td><td>是否同时获取用户订阅消息的订阅状态；当前仅支持 false。</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { getSetting } from '@doubao-dev/framework/api';
+
+const result = await getSetting();
+console.log(result.authSetting['scope.userLocation']);
+```
+
+## 成功返回
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>authSetting</code></td><td><code>AuthSetting</code></td><td>是</td><td>用户授权结果，key 为权限 scope，value 表示是否已授权</td></tr>
+<tr><td><code>subscriptionsSetting</code></td><td><code>SubscriptionsSetting</code></td><td>否</td><td>预留的订阅消息设置字段。豆包当前仅支持 `withSubscriptions: false`，因此不会返回该字段。</td></tr>
+<tr><td><code>subscriptionsSetting.itemSettings</code></td><td><code>Record&lt;string, SubscriptionSettingStatus&gt;</code></td><td>否</td><td>一次性订阅消息模板的订阅状态</td></tr>
+<tr><td><code>subscriptionsSetting.mainSwitch</code></td><td><code>boolean</code></td><td>否</td><td>设置页订阅消息总开关</td></tr>
+<tr><td><code>subscriptionsSetting.templateSettings</code></td><td><code>Record&lt;string, SubscriptionTemplateSetting&gt;</code></td><td>否</td><td>模板订阅状态</td></tr>
+</tbody>
+</table>
+
+### 返回示例
+
+```json
+{
+  "authSetting": {
+    "scope.userLocation": true,
+    "scope.record": 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、iOS</td><td>传入 withSubscriptions: true，豆包当前不支持订阅消息模板</td><td>不要传入 withSubscriptions: true，仅使用默认的 false</td></tr>
+<tr><td><code>116</code></td><td><code>resource not found</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>
+
+## 平台差异
+
+- **iOS**：iOS 不返回 errNo 116（resource not found），相应失败场景统一以 errNo 102（internal error）返回。
+
+<a id="opensetting"></a>
+### openSetting()
+
+# openSetting
+
+打开应用插件授权设置页面
+
+## 扫码预览
+![扫码预览 openSetting](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fbasic%252Fopen-setting%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.39`。
+
+## 支持平台
+
+<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>
+
+## 接入准备
+
+### 前置条件
+
+- 无额外前置条件，不要求在用户点击事件中调用
+
+## 使用说明
+
+该接口不要求在用户点击事件中调用。
+JavaScript 调用方也不要传入 `withSubscriptions: true`，否则豆包会返回 `subscription templates are not supported yet`。
+
+- 设置页只能修改当前应用插件的 scope，不承载 HealthKit 系统权限设置。
+- 豆包当前不支持订阅模板，不要传入 withSubscriptions: true。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+openSetting(params?: OpenSettingOptions): Promise<OpenSettingResult>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>withSubscriptions</code></td><td><code>false</code></td><td>否</td><td><code>false</code></td><td>豆包 Android、iOS 当前不支持订阅模板，仅支持 false</td><td>是否同时获取用户订阅消息的订阅状态；当前仅支持 false。</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { openSetting } from '@doubao-dev/framework/api';
+
+try {
+  const result = await openSetting();
+  console.log(result.authSetting['scope.userLocation']);
+} catch (error) {
+  console.error(error);
+}
+```
+
+## 成功返回
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>authSetting</code></td><td><code>AuthSetting</code></td><td>是</td><td>用户授权结果，key 为权限 scope，value 表示是否已授权</td></tr>
+<tr><td><code>subscriptionsSetting</code></td><td><code>SubscriptionsSetting</code></td><td>否</td><td>预留的订阅消息设置字段。豆包当前仅支持 `withSubscriptions: false`，因此不会返回该字段。</td></tr>
+<tr><td><code>subscriptionsSetting.itemSettings</code></td><td><code>Record&lt;string, SubscriptionSettingStatus&gt;</code></td><td>否</td><td>一次性订阅消息模板的订阅状态</td></tr>
+<tr><td><code>subscriptionsSetting.mainSwitch</code></td><td><code>boolean</code></td><td>否</td><td>设置页订阅消息总开关</td></tr>
+<tr><td><code>subscriptionsSetting.templateSettings</code></td><td><code>Record&lt;string, SubscriptionTemplateSetting&gt;</code></td><td>否</td><td>模板订阅状态</td></tr>
+</tbody>
+</table>
+
+### 返回示例
+
+```json
+{
+  "authSetting": {
+    "scope.userLocation": true,
+    "scope.record": false
+  }
+}
+```
+
+<a id="getuseridentifiers"></a>
+### getUserIdentifiers()
+
+---
+internal: true
+---
+
+# getUserIdentifiers
+
+获取当前用户的加密设备标识，参数可省略或传入空对象。
+
+## 扫码预览
+![扫码预览 getUserIdentifiers](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fbasic%252Fget-user-identifiers%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.5.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>
+
+## 接入准备
+
+### 前置条件
+
+- 用户已登录且标识服务可用
+
+## 使用说明
+
+- 同一用户、设备和应用插件的成功结果在进程内缓存。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+getUserIdentifiers(params?: object): Promise<GetUserIdentifiersResult>
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```typescript
+import { getUserIdentifiers } from '@doubao-dev/framework/api';
+const { edid } = await getUserIdentifiers({});
+```
+
+## 成功返回
+
+:::public
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
+</thead>
+<tbody>
+</tbody>
+</table>
+:::
+
+:::internal
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>edid</code></td><td><code>string</code></td><td>是</td><td>用户加密设备标识，成功时非空。</td></tr>
+</tbody>
+</table>
+:::
+
+### 返回示例
+
+```json
+{ "edid": "example-encrypted-identifier" }
+```
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 失败示例
+
+```json
+{ "errNo": 303, "errMsg": "no network connection" }
+```
+
+### 错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
+</thead>
+<tbody>
+<tr><td><code>302</code></td><td><code>connection timed out</code></td><td>Android、iOS</td><td>请求超时</td><td>稍后重试</td></tr>
+<tr><td><code>303</code></td><td><code>no network connection</code></td><td>Android、iOS</td><td>无网络连接</td><td>联网后重试</td></tr>
+<tr><td><code>305</code></td><td><code>network failure</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>
+<tr><td><code>103</code></td><td><code>feature not support</code></td><td>当前环境不支持该能力</td><td>Android、iOS</td></tr>
+<tr><td><code>104</code></td><td><code>invalid parameter</code></td><td>参数不合法</td><td>Android、iOS</td></tr>
+<tr><td><code>105</code></td><td><code>authentication fail</code></td><td>身份认证失败</td><td>Android、iOS</td></tr>
+<tr><td><code>112</code></td><td><code>invalid result</code></td><td>返回结果无效</td><td>Android、iOS</td></tr>
+</tbody>
+</table>
+
+## 相关类型
+
+<a id="doubaoappaccountinfo"></a>
+### DoubaoAppAccountInfo
+
+应用插件账号信息。
+
+#### Properties
+
+• **appId**: `string` - 应用插件 appId
+• **envVersion**: `'develop' | 'trial' | 'release'` - 当前应用插件的版本类型。 - develop：开发版 - trial：体验版 - release：正式版
+• **version**: `string` - 应用插件版本号
+
+<a id="pluginaccountinfo"></a>
+### PluginAccountInfo
+
+插件账号信息（仅在插件中调用时包含）。
+
+#### Properties
+
+• **appId**: `string` - 插件 appId
+• **version**: `string` - 插件版本号，'a.b.c' 形式
+
+<a id="getaccountinforesult"></a>
+### GetAccountInfoResult
+
+获取当前账号信息。
+
+#### Properties
+
+• **miniProgram**: `DoubaoAppAccountInfo` - 应用插件账号信息
+• **plugin?**: `PluginAccountInfo` - 插件账号信息（仅在插件中调用时包含）
+
+<a id="healthdatatype"></a>
+### HealthDataType
+
+#### Type
+
+`BridgeHealthDataType`
+
+<a id="scope"></a>
+### Scope
+
+#### Type
+
+`| 'scope.userLocation'
+  | 'scope.userFuzzyLocation'
+  | 'scope.userLocationBackground'
+  | 'scope.payment'
+  | 'scope.record'
+  | 'scope.bluetooth'
+  | 'scope.camera'
+  | 'scope.addPhoneContact'
+  | 'scope.addPhoneCalendar'
+  | 'scope.healthData'`
+
+<a id="healthdataauthorizeoptions"></a>
+### HealthDataAuthorizeOptions
+
+#### Properties
+
+• **types**: `HealthDataType[]` - 健康数据类型列表；用于申请对应的 HealthKit 读取权限
+
+<a id="authorizerequest"></a>
+### AuthorizeRequest
+
+#### Properties
+
+• **scope**: `Scope` - 授权范围
+• **options?**: `HealthDataAuthorizeOptions` - 权限扩展参数；仅 scope.healthData 生效，用于传入 HealthKit 读取类型，其他 scope 会忽略该字段
+
+<a id="caniuseparams"></a>
+### CanIUseParams
+
+#### Properties
+
+• **schema**: `string` - 需要检测的能力标识，例如 API 名称
+
+<a id="caniuseresult"></a>
+### CanIUseResult
+
+#### Properties
+
+• **result**: `boolean` - 是否支持所检测的能力
+
+<a id="performanceentry"></a>
+### PerformanceEntry
+
+#### Properties
+
+• **entryType**: `PerformanceEntryType` - 性能指标所属类别
+• **name**: `string` - 性能指标名称，例如 appLaunch、route、evaluateScript 或 firstRender
+• **startTime**: `number` - 指标开始或发生时刻的 Unix 时间戳，单位为毫秒
+• **duration?**: `number` - 指标持续时间，单位为毫秒；仅耗时类指标提供
+• **path?**: `string` - 页面路径；仅页面的 navigation 和 render 类型指标提供
+• **pageId?**: `number` - path 对应的页面实例 Id（随机生成，不保证递增）；仅页面相关指标提供
+• **referrerPath?**: `string` - 路由来源页面的路径；仅 navigation / route 指标提供
+• **referrerPageId?**: `number` - 路由来源页面的实例 ID；仅 navigation / route 指标提供
+• **navigationStart?**: `number` - 路由开始被渲染层处理的 Unix 时间戳，单位为毫秒；仅 navigation 类型指标提供
+• **navigationType?**: `string` - 路由类型。仅 navigation 类型的 Entry 有效
+• **moduleName?**: `string` - 被执行脚本的模块名称；仅 script / evaluateScript 指标提供
+• **viewLayerReadyTime?**: `number` - 视图层准备完成的 Unix 时间戳，单位为毫秒；仅 render / firstRender 指标提供
+• **viewLayerRenderStartTime?**: `number` - 视图层首次渲染开始的 Unix 时间戳，单位为毫秒；仅 render / firstRender 指标提供
+• **viewLayerRenderEndTime?**: `number` - 视图层首次渲染结束的 Unix 时间戳，单位为毫秒；仅 render / firstRender 指标提供
+• **widgetId?**: `string` - Widget 标识；仅 Widget 的 render 类型指标提供
+• **widgetInstanceId?**: `string` - Widget 实例 Id（随机生成，不保证递增）；仅 Widget 的 render 类型指标提供
+• **isAppColdLaunch?**: `boolean` - Widget 关联的应用是否冷启动；仅 Widget 的 render 类型指标提供
+
+<a id="performanceobservercallback"></a>
+### PerformanceObserverCallback
+
+#### Type
+
+`(entryList: PerformanceObserverEntryList) => void`
+
+<a id="performanceobserver"></a>
+### PerformanceObserver
+
+#### Properties
+
+• **observe**: `(options: PerformanceObserverOptions) => void`
+• **disconnect**: `() => void`
+
+<a id="performance"></a>
+### Performance
+
+#### Properties
+
+• **createObserver**: `(callback: PerformanceObserverCallback) => PerformanceObserver` - 创建性能观察者。调用返回对象的 observe 后，回调会接收之后新完成且匹配的 Entry
+• **setBufferSize**: `(size: number) => void` - 设置客户端最多保留的性能 Entry 数量
+• **getEntries**: `() => PerformanceEntry[]` - 返回当前应用插件已记录的全部性能 Entry
+• **getEntriesByType**: `(entryType: string) => PerformanceEntry[]` - 返回指定 entryType 的性能 Entry
+• **getEntriesByName**: `(name: string, entryType?: string) => PerformanceEntry[]` - 返回指定名称的性能 Entry；传入 entryType 时同时按类型筛选
+
+<a id="performanceentrytype"></a>
+### PerformanceEntryType
+
+#### Type
+
+`'navigation' | 'script' | 'render'`
+
+<a id="performanceobserverentrylist"></a>
+### PerformanceObserverEntryList
+
+#### Properties
+
+• **getEntries**: `() => PerformanceEntry[]`
+• **getEntriesByType**: `(entryType: string) => PerformanceEntry[]`
+• **getEntriesByName**: `(name: string, entryType?: string) => PerformanceEntry[]`
+
+<a id="performanceobserveroptions"></a>
+### PerformanceObserverOptions
+
+#### Properties
+
+• **entryTypes**: `string[]`
+
+<a id="getsettingparams"></a>
+### GetSettingParams
+
+#### Properties
+
+• **withSubscriptions?**: `false` - 是否同时获取用户订阅消息的订阅状态；当前仅支持 false
+
+<a id="authsetting"></a>
+### AuthSetting
+
+#### Type
+
+`Record<string, boolean>`
+
+<a id="subscriptionsettingstatus"></a>
+### SubscriptionSettingStatus
+
+#### Type
+
+`'accept' | 'reject' | 'ban' | 'filter'`
+
+<a id="subscriptiontemplatesetting"></a>
+### SubscriptionTemplateSetting
+
+#### Properties
+
+• **status**: `SubscriptionSettingStatus` - 订阅结果
+• **alwaysSubscribe?**: `boolean` - 是否为长期订阅状态
+• **allowReminderWay?**: `SubscriptionReminderWay[]` - 模板支持的提醒方式对应的用户授权结果
+
+<a id="subscriptionssetting"></a>
+### SubscriptionsSetting
+
+#### Properties
+
+• **mainSwitch**: `boolean` - 设置页订阅消息总开关
+• **itemSettings?**: `Record<string, SubscriptionSettingStatus>` - 一次性订阅消息模板的订阅状态
+• **templateSettings?**: `Record<string, SubscriptionTemplateSetting>` - 模板订阅状态
+
+<a id="getsettingresult"></a>
+### GetSettingResult
+
+#### Properties
+
+• **authSetting**: `AuthSetting` - 用户授权结果，key 为权限 scope，value 表示是否已授权
+• **subscriptionsSetting?**: `SubscriptionsSetting` - 预留的订阅消息设置字段。豆包当前仅支持 withSubscriptions: false，因此不会返回该字段
+
+<a id="subscriptionreminderway"></a>
+### SubscriptionReminderWay
+
+#### Properties
+
+• **reminderType**: `SubscriptionReminderType` - 提醒方式
+• **reminderStatus**: `SubscriptionReminderStatus` - 提醒授权结果
+
+<a id="subscriptionremindertype"></a>
+### SubscriptionReminderType
+
+#### Type
+
+`'message_notice' | 'feed' | 'push'`
+
+<a id="subscriptionreminderstatus"></a>
+### SubscriptionReminderStatus
+
+#### Type
+
+`'accept' | 'reject'`
+
+<a id="opensettingoptions"></a>
+### OpenSettingOptions
+
+#### Properties
+
+• **withSubscriptions?**: `false` - 是否同时获取用户订阅消息的订阅状态；当前仅支持 false
+
+<a id="opensettingresult"></a>
+### OpenSettingResult
+
+#### Properties
+
+• **authSetting**: `AuthSetting` - 用户授权结果，key 为权限 scope，value 表示是否已授权
+• **subscriptionsSetting?**: `SubscriptionsSetting` - 预留的订阅消息设置字段。豆包当前仅支持 withSubscriptions: false，因此不会返回该字段
+
+<a id="getuseridentifiersresult"></a>
+### GetUserIdentifiersResult
+
+#### Properties
+
+• **edid**: `string` - 用户加密设备标识，成功时非空