@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/05-/345/255/230/345/202/250.md

@@ -0,0 +1,1176 @@
+# 豆包应用插件的端能力 API: 存储
+
+本地缓存；带 Sync 后缀的是同步 API。
+
+[返回目录](./groups.md) | [返回速查](./quick-reference.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [setStorage](#setstorage) | 将数据写入本地缓存。 |
+| [setStorageSync](#setstoragesync) | 将数据写入本地缓存。<br><br>同步 API。 |
+| [getStorage](#getstorage) | 从本地缓存读取数据。 |
+| [getStorageSync](#getstoragesync) | 从本地缓存同步读取数据。<br><br>同步 API。 |
+| [removeStorage](#removestorage) | 删除本地缓存中指定 key 的数据。 |
+| [removeStorageSync](#removestoragesync) | 删除本地缓存中指定 key 的数据。<br><br>同步 API。 |
+| [clearStorage](#clearstorage) | 清空本地缓存。 |
+| [clearStorageSync](#clearstoragesync) | 清空本地缓存。<br><br>同步 API。 |
+| [getStorageInfo](#getstorageinfo) | 获取本地缓存信息。 |
+| [getStorageInfoSync](#getstorageinfosync) | 同步获取本地缓存信息。<br><br>同步 API。 |
+
+## API 详情
+
+<a id="setstorage"></a>
+### setStorage()
+
+# setStorage
+
+将数据写入本地缓存。
+
+## 扫码预览
+![扫码预览 setStorage](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fstorage%252Fset-storage%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.17`。
+
+## 支持平台
+
+<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>
+
+## 使用说明
+
+- 数据按登录用户与应用插件双重隔离存储；单个 value 序列化后不超过 1MB，且全部数据总量不超过 10MB，超出会写入失败。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+setStorage<TData = unknown>(params: SetStorageParams<TData>): 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>TData</code></td><td>是</td><td>-</td><td>-</td><td>待存储的数据</td></tr>
+<tr><td><code>key</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>本地缓存键名</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { setStorage } from '@doubao-dev/framework/api';
+
+await setStorage({
+  key: 'profile',
+  data: { name: 'Tom', age: 18 },
+});
+```
+
+## 成功返回
+
+无返回字段。
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 失败示例
+
+```json
+{
+  "errNo": 1600001,
+  "errMsg": "exceed storage item max size"
+}
+```
+
+### 错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
+</thead>
+<tbody>
+<tr><td><code>1600001</code></td><td><code>exceed storage item max size</code></td><td>Android、iOS</td><td>单个 value 序列化后超过 1MB</td><td>减小单条数据体积后重试。</td></tr>
+<tr><td><code>1600002</code></td><td><code>total storage size exceeded</code></td><td>Android、iOS</td><td>写入后本地缓存总量超过 10MB</td><td>先清理无用缓存后重试。</td></tr>
+<tr><td><code>1600004</code></td><td><code>key is empty</code></td><td>Android、iOS</td><td>key 为空字符串</td><td>传入非空 key。</td></tr>
+<tr><td><code>1600005</code></td><td><code>key exceeds max length</code></td><td>Android、iOS</td><td>key 长度超过 1024</td><td>缩短 key 长度。</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>
+
+<a id="setstoragesync"></a>
+### setStorageSync()
+
+# setStorageSync
+
+将数据写入本地缓存。
+
+## 扫码预览
+![扫码预览 setStorageSync](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fstorage%252Fset-storage%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>
+
+## 使用说明
+
+- 数据按登录用户与应用插件双重隔离存储；单个 value 序列化后不超过 1MB，且全部数据总量不超过 10MB，超出会写入失败。
+
+## 调用方式
+
+### 同步 API
+
+```typescript
+setStorageSync<TData = unknown>(params: SetStorageParams<TData>): 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>TData</code></td><td>是</td><td>-</td><td>-</td><td>待存储的数据</td></tr>
+<tr><td><code>key</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>本地缓存键名</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { setStorageSync } from '@doubao-dev/framework/api';
+
+setStorageSync({
+  key: 'profile',
+  data: { name: 'Tom', age: 18 },
+});
+```
+
+## 返回值
+
+同步写入完成后返回。
+
+## 错误处理
+
+同步调用失败时抛出错误。错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 失败示例
+
+```json
+{
+  "errNo": 1600001,
+  "errMsg": "exceed storage item max size"
+}
+```
+
+### 错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
+</thead>
+<tbody>
+<tr><td><code>1600001</code></td><td><code>exceed storage item max size</code></td><td>Android、iOS</td><td>单个 value 序列化后超过 1MB</td><td>减小单条数据体积后重试。</td></tr>
+<tr><td><code>1600002</code></td><td><code>total storage size exceeded</code></td><td>Android、iOS</td><td>写入后本地缓存总量超过 10MB</td><td>先清理无用缓存后重试。</td></tr>
+<tr><td><code>1600004</code></td><td><code>key is empty</code></td><td>Android、iOS</td><td>key 为空字符串</td><td>传入非空 key。</td></tr>
+<tr><td><code>1600005</code></td><td><code>key exceeds max length</code></td><td>Android、iOS</td><td>key 长度超过 1024</td><td>缩短 key 长度。</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>
+
+<a id="getstorage"></a>
+### getStorage()
+
+# getStorage
+
+从本地缓存读取数据。
+
+## 扫码预览
+![扫码预览 getStorage](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fstorage%252Fset-storage%252Findex)
+
+## 使用限制
+
+> [!WARNING]
+> **Android、iOS**：key 不存在时 Android 返回 null、iOS 返回 nil，且均按成功返回，不抛出错误；调用方按必返字段使用会得到 undefined，且无法区分「未写入」与「写入了空值」。
+
+## 支持版本
+
+前端库版本不低于 `0.0.17`。
+
+## 支持平台
+
+<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>
+
+## 使用说明
+
+- 写入时会对 data 做 JSON 序列化，读取时按 JSON 反序列化，无法解析时原样返回字符串。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+getStorage<TData = unknown>(params: GetStorageParams): Promise<GetStorageResult<TData>>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>key</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>本地缓存键名</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { getStorage } from '@doubao-dev/framework/api';
+
+const result = await getStorage<{ name: string; age: number }>({
+  key: 'profile',
+});
+
+console.log(result.data.name, result.data.age);
+```
+
+## 成功返回
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>data</code></td><td><code>TData</code></td><td>是</td><td>key 对应的数据。Android、iOS：key 不存在时 Android 返回 null、iOS 返回 nil，且均按成功返回，不抛出错误。</td></tr>
+</tbody>
+</table>
+
+### 返回示例
+
+```json
+{
+  "data": {
+    "name": "Tom",
+    "age": 18
+  }
+}
+```
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 失败示例
+
+```json
+{
+  "errNo": 1600004,
+  "errMsg": "key is empty"
+}
+```
+
+### 错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
+</thead>
+<tbody>
+<tr><td><code>1600004</code></td><td><code>key is empty</code></td><td>Android、iOS</td><td>key 为空字符串</td><td>传入非空 key。</td></tr>
+<tr><td><code>1600005</code></td><td><code>key exceeds max length</code></td><td>Android、iOS</td><td>key 长度超过 1024</td><td>缩短 key 长度。</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>
+
+<a id="getstoragesync"></a>
+### getStorageSync()
+
+# getStorageSync
+
+从本地缓存同步读取数据。
+
+## 扫码预览
+![扫码预览 getStorageSync](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fstorage%252Fset-storage%252Findex)
+
+## 使用限制
+
+> [!WARNING]
+> **Android、iOS**：key 不存在时 Android 返回 null、iOS 返回 nil，且均按成功返回，不抛出错误；调用方按必返字段使用会得到 undefined，且无法区分「未写入」与「写入了空值」。
+
+## 支持版本
+
+前端库版本不低于 `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>
+
+## 使用说明
+
+- 写入时会对 data 做 JSON 序列化，读取时按 JSON 反序列化，无法解析时原样返回字符串。
+
+## 调用方式
+
+### 同步 API
+
+```typescript
+getStorageSync<TData = unknown>(params: GetStorageParams): GetStorageResult<TData>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>key</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>本地缓存键名</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { getStorageSync } from '@doubao-dev/framework/api';
+
+const result = getStorageSync<{ name: string; age: number }>({
+  key: 'profile',
+});
+
+console.log(result.data.name, result.data.age);
+```
+
+## 返回值
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>data</code></td><td><code>TData</code></td><td>是</td><td>key 对应的数据。Android、iOS：key 不存在时 Android 返回 null、iOS 返回 nil，且均按成功返回，不抛出错误。</td></tr>
+</tbody>
+</table>
+
+### 返回示例
+
+```json
+{
+  "data": {
+    "name": "Tom",
+    "age": 18
+  }
+}
+```
+
+## 错误处理
+
+同步调用失败时抛出错误。错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 失败示例
+
+```json
+{
+  "errNo": 1600004,
+  "errMsg": "key is empty"
+}
+```
+
+### 错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
+</thead>
+<tbody>
+<tr><td><code>1600004</code></td><td><code>key is empty</code></td><td>Android、iOS</td><td>key 为空字符串</td><td>传入非空 key。</td></tr>
+<tr><td><code>1600005</code></td><td><code>key exceeds max length</code></td><td>Android、iOS</td><td>key 长度超过 1024</td><td>缩短 key 长度。</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>
+
+<a id="removestorage"></a>
+### removeStorage()
+
+# removeStorage
+
+删除本地缓存中指定 key 的数据。
+
+## 扫码预览
+![扫码预览 removeStorage](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fstorage%252Fremove-storage%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.17`。
+
+## 支持平台
+
+<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>
+
+## 使用说明
+
+- key 不存在时删除操作也会成功返回。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+removeStorage(params: RemoveStorageParams): Promise<object>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>key</code></td><td><code>string</code></td><td>是</td><td>-</td><td>-</td><td>本地缓存键名</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { removeStorage } from '@doubao-dev/framework/api';
+
+await removeStorage({ key: 'profile' });
+```
+
+## 成功返回
+
+无返回字段。
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 失败示例
+
+```json
+{
+  "errNo": 1600004,
+  "errMsg": "key is empty"
+}
+```
+
+### 错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
+</thead>
+<tbody>
+<tr><td><code>1600004</code></td><td><code>key is empty</code></td><td>Android、iOS</td><td>key 为空字符串</td><td>传入非空 key。</td></tr>
+<tr><td><code>1600005</code></td><td><code>key exceeds max length</code></td><td>Android、iOS</td><td>key 长度超过 1024</td><td>缩短 key 长度。</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>
+
+<a id="removestoragesync"></a>
+### removeStorageSync()
+
+# removeStorageSync
+
+删除本地缓存中指定 key 的数据。
+
+## 扫码预览
+![扫码预览 removeStorageSync](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fstorage%252Fremove-storage%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>
+
+## 使用说明
+
+- key 不存在时删除操作也会成功返回。
+
+## 调用方式
+
+### 同步 API
+
+```typescript
+removeStorageSync(params?: RemoveStorageParams): object
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>key</code></td><td><code>string</code></td><td>否</td><td>-</td><td>-</td><td>本地缓存键名</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { removeStorageSync } from '@doubao-dev/framework/api';
+
+removeStorageSync({ key: 'profile' });
+```
+
+## 返回值
+
+同步删除完成后返回。
+
+## 错误处理
+
+同步调用失败时抛出错误。错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 失败示例
+
+```json
+{
+  "errNo": 1600004,
+  "errMsg": "key is empty"
+}
+```
+
+### 错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
+</thead>
+<tbody>
+<tr><td><code>1600004</code></td><td><code>key is empty</code></td><td>Android、iOS</td><td>key 为空字符串</td><td>传入非空 key。</td></tr>
+<tr><td><code>1600005</code></td><td><code>key exceeds max length</code></td><td>Android、iOS</td><td>key 长度超过 1024</td><td>缩短 key 长度。</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>
+
+<a id="clearstorage"></a>
+### clearStorage()
+
+# clearStorage
+
+清空本地缓存。
+
+## 扫码预览
+![扫码预览 clearStorage](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fstorage%252Fclear-storage%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.17`。
+
+## 支持平台
+
+<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
+clearStorage(params?: object): Promise<object>
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```typescript
+import { clearStorage } from '@doubao-dev/framework/api';
+
+await clearStorage();
+```
+
+## 成功返回
+
+无返回字段。
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./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="clearstoragesync"></a>
+### clearStorageSync()
+
+# clearStorageSync
+
+清空本地缓存。
+
+## 扫码预览
+![扫码预览 clearStorageSync](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fstorage%252Fclear-storage%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>
+
+## 使用说明
+
+- 只清空当前登录用户在当前应用插件下的缓存，不影响其他用户或其他应用插件的数据。
+
+## 调用方式
+
+### 同步 API
+
+```typescript
+clearStorageSync(params?: object): object
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```typescript
+import { clearStorageSync } from '@doubao-dev/framework/api';
+
+clearStorageSync();
+```
+
+## 返回值
+
+同步清空完成后返回。
+
+## 错误处理
+
+同步调用失败时抛出错误。错误对象和通用错误码见 [通用错误处理](./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="getstorageinfo"></a>
+### getStorageInfo()
+
+# getStorageInfo
+
+获取本地缓存信息。
+
+## 扫码预览
+![扫码预览 getStorageInfo](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fstorage%252Fget-storage-info%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.17`。
+
+## 支持平台
+
+<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>
+
+## 使用说明
+
+- currentSize 与 limitSize 均以 KB 为单位；limitSize 固定为 10240（即 10MB）。
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+getStorageInfo(params?: object): Promise<GetStorageInfoResult>
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```typescript
+import { getStorageInfo } from '@doubao-dev/framework/api';
+
+const result = await getStorageInfo();
+
+console.log(result.keys, result.currentSize, result.limitSize);
+```
+
+## 成功返回
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>currentSize</code></td><td><code>number</code></td><td>是</td><td>当前占用的空间大小，单位 KB</td></tr>
+<tr><td><code>keys</code></td><td><code>string[]</code></td><td>是</td><td>当前 storage 中所有的 key</td></tr>
+<tr><td><code>limitSize</code></td><td><code>number</code></td><td>是</td><td>限制的空间大小，单位 KB</td></tr>
+</tbody>
+</table>
+
+### 返回示例
+
+```json
+{
+  "keys": ["profile", "settings"],
+  "currentSize": 2,
+  "limitSize": 10240
+}
+```
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./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="getstorageinfosync"></a>
+### getStorageInfoSync()
+
+# getStorageInfoSync
+
+同步获取本地缓存信息。
+
+## 扫码预览
+![扫码预览 getStorageInfoSync](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fstorage%252Fget-storage-info%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>
+
+## 使用说明
+
+- currentSize 与 limitSize 均以 KB 为单位；limitSize 固定为 10240（即 10MB）。
+
+## 调用方式
+
+### 同步 API
+
+```typescript
+getStorageInfoSync(params?: object): GetStorageInfoResult
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```typescript
+import { getStorageInfoSync } from '@doubao-dev/framework/api';
+
+const result = getStorageInfoSync();
+
+console.log(result.keys, result.currentSize, result.limitSize);
+```
+
+## 返回值
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>currentSize</code></td><td><code>number</code></td><td>是</td><td>当前占用的空间大小，单位 KB</td></tr>
+<tr><td><code>keys</code></td><td><code>string[]</code></td><td>是</td><td>当前 storage 中所有的 key</td></tr>
+<tr><td><code>limitSize</code></td><td><code>number</code></td><td>是</td><td>限制的空间大小，单位 KB</td></tr>
+</tbody>
+</table>
+
+### 返回示例
+
+```json
+{
+  "keys": ["profile", "settings"],
+  "currentSize": 2,
+  "limitSize": 10240
+}
+```
+
+## 错误处理
+
+同步调用失败时抛出错误。错误对象和通用错误码见 [通用错误处理](./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="setstorageparams"></a>
+### SetStorageParams
+
+#### Properties
+
+• **key**: `string` - 本地缓存键名
+• **data**: `TData` - 待存储的数据
+
+<a id="getstorageparams"></a>
+### GetStorageParams
+
+#### Properties
+
+• **key**: `string` - 本地缓存键名
+
+<a id="getstorageresult"></a>
+### GetStorageResult
+
+#### Properties
+
+• **data**: `TData` - key 对应的数据
+
+<a id="removestorageparams"></a>
+### RemoveStorageParams
+
+#### Properties
+
+• **key**: `string` - 本地缓存键名
+
+<a id="getstorageinforesult"></a>
+### GetStorageInfoResult
+
+#### Properties
+
+• **keys**: `string[]` - 当前 storage 中所有的 key
+• **currentSize**: `number` - 当前占用的空间大小，单位 KB
+• **limitSize**: `number` - 限制的空间大小，单位 KB