Skip to content

Pages

分页迭代器,提供通用的分页数据访问能力,由 DataStore 的 ListKeysAsync 等分页方法返回。

概览

分页迭代器,用于按页读取数量较多的列表型结果。通过 GetCurrentPage 获取当前页数据,AdvanceToNextPageAsync 推进到下一页并返回是否成功,IsFinished 用于判断是否已遍历完毕。该类型实例通常由数据存取服务中支持分页的列表接口返回,本身不提供直接构造入口。

不可实例化,由接口返回

函数

GetCurrentPage

签名:GetCurrentPage() -> Array

返回当前页的数据列表;具体元素结构由创建该分页对象的列表接口决定。

注意: Pages 通常由 OrderedDataStore:GetSortedAsync() 返回;当前 Editor 运行包缺少该排序查询的底层绑定,暂无可验证的公开获取路径,因此暂不提供可运行示例。

返回值 Array — 当前页的数据数组;没有更多数据时返回空数组

AdvanceToNextPageAsync

签名:AdvanceToNextPageAsync() -> Bool

尝试将分页位置推进到下一页,并返回是否成功。若仍有下一页数据则返回 true;若已没有更多数据则返回 false。

注意: Pages 通常由 OrderedDataStore:GetSortedAsync() 返回;当前 Editor 运行包缺少该排序查询的底层绑定,暂无可验证的公开获取路径,因此暂不提供可运行示例。

返回值 Bool — 是否成功翻到下一页;已无更多数据时返回 false

属性

名称类型默认值说明
IsFinishedBoolfalse指示当前分页迭代是否已经完毕。(只读)