Pages

Show Deprecated
Not Creatable
Not Replicated

An object which is essentially a table of pages, each of which is a sorted list of the key/value pairs. When each page contains a list of multiple items, this iterator function may be handy:


1function iterPageItems(pages)
2 return coroutine.wrap(function()
3 local pagenum = 1
4 while true do
5 for _, item in ipairs(pages:GetCurrentPage()) do
6 coroutine.yield(item, pagenum)
7 end
8 if pages.IsFinished then
9 break
10 end
11 pages:AdvanceToNextPageAsync()
12 pagenum = pagenum + 1
13 end
14 end)
15end
16

Which can be used as


1for item, pageNo in iterPageItems(myPageObject) do
2 -- look at item. Pages will advance automatically
3end
4

Summary

Properties

Whether or not the current page is the last page available.

READ ONLY
NOT REPLICATED

Events

Methods


Returns the items on the current page. The keys in the item are determined by the source of this object.


Iterates to the next page in the pages object, if possible.

Properties

IsFinished

Read Only
Not Replicated

Whether or not the current page is the last page available.

Events

Methods

GetCurrentPage

Returns the items on the current page. The keys in the item are determined by the source of this object.


Returns

AdvanceToNextPageAsync

Yields

Iterates to the next page in the pages object, if possible.


Returns