Pages
An abstract class for pages objects.
This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory category | Instances |
---|
Member index 3
Description
An object which is essentially a table of pages, each of which is a sorted list of the key/value pairs.
History 10
- 573 Change ReturnType of AdvanceToNextPageAsync from void to null
- 553 Change Default of IsFinished from to
- 486 Change ThreadSafety of IsFinished from ReadOnly to ReadSafe
- 462 Change ThreadSafety of GetCurrentPage from to Unsafe
- 462 Change ThreadSafety of AdvanceToNextPageAsync from to Unsafe
- 462 Change ThreadSafety of IsFinished from to ReadOnly
- 138 Add GetCurrentPage
- 138 Add AdvanceToNextPageAsync
- 138 Add IsFinished
- 138 Add Pages
Members 3
AdvanceToNextPageAsync
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
null |
Iterates to the next page in the pages object, if possible. The request limit is the same of the endpoint originally called.
This function yields. It will block the calling thread until completion.
Thread safety | Unsafe |
---|
History 3
- 573 Change ReturnType of AdvanceToNextPageAsync from void to null
- 462 Change ThreadSafety of AdvanceToNextPageAsync from to Unsafe
- 138 Add AdvanceToNextPageAsync
GetCurrentPage
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
Array |
Returns the items on the current page. The keys in the item are determined by the source of this object.
Thread safety | Unsafe |
---|
History 2
- 462 Change ThreadSafety of GetCurrentPage from to Unsafe
- 138 Add GetCurrentPage
IsFinished
Type | Default | |
---|---|---|
bool |
Whether or not the current page is the last page available.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | false |
History 4
- 553 Change Default of IsFinished from to
- 486 Change ThreadSafety of IsFinished from ReadOnly to ReadSafe
- 462 Change ThreadSafety of IsFinished from to ReadOnly
- 138 Add IsFinished