TTMSMCPCursor Class

Translates between a position inside a list of published entries and the opaque cursor string a client sends back to ask for the page that follows it.

API unit family: TMS.MCP.Pagination

Syntax

TTMSMCPCursor = class

Remarks

Paging is opt-in. A server whose default page size is left at 0 answers every listing request with the complete collection in one response and never emits a cursor, so these routines only come into play once a page size has been set. A cursor holds the zero-based index of the first entry of the next page, written as decimal text and then Base64-encoded; clients are expected to treat it as an opaque token and hand it back unchanged rather than parse it.

Methods

Name	Description
Decode	Recovers the position that a cursor string was encoded from.
Encode	Encodes a position in a listing into the cursor string published with a page.