History 模块(历史记录)
History 模块复用 Cloud 的后端接口,提供列表查询和管理功能。
API 列表
| 方法 | 返回值 | 说明 |
|---|---|---|
sdk.history.getList(options?) | Promise<HistoryListResult> | 获取历史记录列表(分页) |
sdk.history.getDetail(id) | Promise<CloudRecord> | 获取单条详情(含完整 snapshot) |
sdk.history.delete(id) | Promise<void> | 删除历史记录 |
详细用法
获取列表
typescript
const list = await sdk.history.getList({
page: 1, // 默认 1
pageSize: 20, // 默认 20,最大 50
})
console.log('总数:', list.total)
list.items.forEach(item => {
console.log(item.id, item.title, item.cover, item.createdAt)
})TIP
当前后端接口直接返回数组,不含分页 total 字段。SDK 使用数组长度作为 total。
获取详情
typescript
const detail = await sdk.history.getDetail(123)
// 返回 CloudRecord,与 sdk.cloud.restore() 相同结构删除
typescript
await sdk.history.delete(123)HistoryItem 与 CloudRecord 的区别
| 字段 | HistoryItem(列表项) | CloudRecord(详情) |
|---|---|---|
| id | ✅ | ✅ |
| title | ✅ | ✅ |
| cover | ✅ | ✅ |
| createdAt | ✅ | ✅ |
| updatedAt | ✅ | ✅ |
| snapshot | ❌ | ✅ |
| originImageUrl | ❌ | ✅ |
列表接口只返回元数据(不含 snapshot),减少网络传输。需要完整数据时调用 getDetail()。