Storage API
Storage API
在设备本地存储中保存/查询数据。
容量限制:
- 单个键最大: 1MB (1024KB)
- 总存储最大: 10MB (10240KB)
- 仅支持可 JSON 序列化的数据
参考: Storage 由 SDK 内部管理,当应用切换到后台或退出时会自动同步数据。
异步 API
setStorage(options)
将数据保存到本地存储。
选项:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
key | string | ✅ | 存储键 |
data | any | ✅ | 存储数据 |
success | function | - | 成功回调 |
fail | function | - | 失败回调 |
complete | function | - | 完成回调 |
TudadaSDK.setStorage({
key: 'userInfo',
data: { name: '洪吉童', level: 10 },
success: () => console.log('保存完成'),
fail: (err) => console.error('保存失败:', err.errMsg),
});
getStorage(options)
从本地存储中查询数据。
选项:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
key | string | ✅ | 查询键 |
success | function | - | 成功回调 |
fail | function | - | 失败回调 |
complete | function | - | 完成回调 |
成功响应:
| 字段 | 类型 | 说明 |
|---|---|---|
data | any | 存储的数据 |
TudadaSDK.getStorage({
key: 'userInfo',
success: (res) => console.log('数据:', res.data),
});
removeStorage(options)
从本地存储中删除数据。
选项:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
key | string | ✅ | 删除键 |
success | function | - | 成功回调 |
fail | function | - | 失败回调 |
complete | function | - | 完成回调 |
TudadaSDK.removeStorage({
key: 'tempData',
success: () => console.log('删除完成'),
});
clearStorage(options?)
删除本地存储中的所有数据。
选项:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
success | function | - | 成功回调 |
fail | function | - | 失败回调 |
complete | function | - | 完成回调 |
TudadaSDK.clearStorage({
success: () => console.log('全部删除完成'),
});
同步 API
setStorageSync(key, data)
将数据同步保存到本地存储。
参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
key | string | ✅ | 存储键 |
data | any | ✅ | 存储数据 |
TudadaSDK.setStorageSync('score', 1000);
// 或者
TudadaSDK.setStorageSync({ key: 'score', data: 1000 });
getStorageSync(key)
从本地存储同步查询数据。
参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
key | string | ✅ | 查询键 |
返回值:
| 字段 | 类型 | 说明 |
|---|---|---|
| (返回值) | any | 存储的数据(不存在时为 undefined) |
const score = TudadaSDK.getStorageSync('score');
// 或者
const score = TudadaSDK.getStorageSync({ key: 'score' });
removeStorageSync(key)
从本地存储同步删除数据。
参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
key | string | ✅ | 删除键 |
TudadaSDK.removeStorageSync('tempData');
clearStorageSync()
同步删除本地存储中的所有数据。
TudadaSDK.clearStorageSync();
getStorageInfoSync()
同步查询存储使用情况。
返回值:
| 字段 | 类型 | 说明 |
|---|---|---|
keys | string[] | 已存储的键列表 |
currentSize | number | 当前使用容量 (KB) |
limitSize | number | 最大容量 (KB) |
const info = TudadaSDK.getStorageInfoSync();
console.log('已存储的键:', info.keys); // ['score', 'userInfo', ...]
console.log('已用容量:', info.currentSize, 'KB'); // 12 KB
console.log('最大容量:', info.limitSize, 'KB'); // 10240 KB