Skip to main content

OffsetPageInfo

Pagination metadata returned alongside a page of records that was paged using offset/limit arguments.

Used by *Paged query fields (for example, Event.registrationsPaged) to expose the total number of matching records and whether further pages exist, in a single round trip with the items themselves.

The offset and limit values echo back the arguments that produced this page so clients can correlate the metadata with the request that produced it.

type OffsetPageInfo {
  hasNextPage: Boolean!
  hasPreviousPage: Boolean!
  limit: PaginationLimit!
  offset: NonNegativeInt!
  totalCount: Int!
}

Fields​

OffsetPageInfo.hasNextPage ● Boolean! non-null scalar​

true when there are more records after this page (i.e. offset + items.length < totalCount).

OffsetPageInfo.hasPreviousPage ● Boolean! non-null scalar​

true when there are records before this page (i.e. offset > 0 and totalCount > 0).

OffsetPageInfo.limit ● PaginationLimit! non-null scalar​

Echoes back the limit argument that produced this page.

OffsetPageInfo.offset ● NonNegativeInt! non-null scalar​

Echoes back the offset argument that produced this page.

OffsetPageInfo.totalCount ● Int! non-null scalar​

The total number of records matching the query's filter, ignoring offset and limit.

Member Of​

AgendaItemAttendancePage object ● CeContactStoreContactPage object ● CeContactStoreCourseRegistrationPage object ● CeContactStoreFunctionRegistrationPage object ● CeContactStoreNotePage object ● CeContactStoreNoteTypePage object ● CeContactStoreSurveyPage object ● CeContactStoreSurveyResponsePage object ● ContactPage object ● ContactStoreContactPage object ● ContactStoreNotePage object ● ContactStoreNoteTypePage object ● CustomFieldPage object ● EventCourseRegistrationPage object ● EventNotePage object ● EventNoteTypePage object ● ExhibitionBookingPage object ● ExhibitionFloorPlanStandPage object ● FunctionRegistrationPage object ● HotelBookingPage object ● InvoicePage object ● MembershipContactStoreContactPage object ● MembershipContactStoreCourseRegistrationPage object ● MembershipContactStoreFunctionRegistrationPage object ● MembershipContactStoreNotePage object ● MembershipContactStoreNoteTypePage object ● MembershipContactStoreSurveyPage object ● MembershipContactStoreSurveyResponsePage object ● MembershipRegistrationPage object ● MiscellaneousChargePage object ● PaymentPage object ● PresentationPage object ● RegistrationPage object ● SessionPage object ● SponsorshipPackagePage object ● SponsorshipPage object ● SurveyPage object ● SurveyResponsePage object ● TravelBookingPage object