commonMain.org.jraf.klibnotion.model.pagination.Pagination.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of klibnotion-jvm Show documentation

A Notion API client library for Kotlin, Java and more.

There is a newer version: 1.12.0

/*
 * This source is part of the
 *      _____  ___   ____
 *  __ / / _ \/ _ | / __/___  _______ _
 * / // / , _/ __ |/ _/_/ _ \/ __/ _ `/
 * \___/_/|_/_/ |_/_/ (_)___/_/  \_, /
 *                              /___/
 * repository.
 *
 * Copyright (C) 2021-present Benoit 'BoD' Lubek ([email protected])
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.jraf.klibnotion.model.pagination

/**
 * Used to specify a specific page to retrieve when doing a query.
 */
data class Pagination(
    /**
     * Cursor pointing to the first element of the page to retrieve.
     *
     * Use [FIRST_CURSOR] to the the first page.
     */
    val startCursor: String? = FIRST_CURSOR,
) {
    companion object {
        val FIRST_CURSOR: String? = null
    }
}