This object defines the pagination structure.

MatterSpecification.v13.Cluster § 6.6.5.11

interface PageToken {
    after?: string;
    before?: string;
    limit?: number;
}

Hierarchy (view full)

Properties

Properties

after?: string

This field shall indicate the cursor that pinpoints the start of the upcoming data page. In a Cursor- based pagination system, the field acts as a reference point, ensuring the set of results corresponds directly to the data following the specified cursor. In a Offset-based pagination system, the field, along with limit, indicate the offset from which entries in the program guide will be retrieved.

MatterSpecification.v13.Cluster § 6.6.5.11.2

before?: string

This field shall indicate the cursor that pinpoints the end of the upcoming data page. In a Cursor- based pagination system, the field acts as a reference point, ensuring the set of results corresponds directly to the data preceding the specified cursor. In a Offset-based pagination system, the field, along with limit, indicate the offset from which entries in the program guide will be retrieved.

MatterSpecification.v13.Cluster § 6.6.5.11.3

limit?: number

This field shall indicate the maximum number of entries that should be retrieved from the program guide in a single response. It allows clients to specify the size of the paginated result set based on their needs.

MatterSpecification.v13.Cluster § 6.6.5.11.1