commonMain.models.TorrentQuery.kt Maven / Gradle / Ivy

Go to download

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

Torrent Provider API client written in Kotlin.

The newest version!

package torrentsearch.models

/**
 * [TorrentQuery] contains all the required details to search for
 * a specific torrent across all enabled providers.
 */
public data class TorrentQuery(
    /** The text query to run on each [torrentsearch.TorrentProvider]. */
    var content: String? = null,
    /** The [Category] to filter torrent results for. */
    var category: Category? = null,
    /** The imdb.com id to filter torrent results for. */
    var imdbId: String? = null,
    /** The themoviedb.org id to filter torrent results for. */
    var tmdbId: Int? = null,
    /** The thetvdb.com id to filter torrent results for. */
    var tvdbId: Int? = null,
    /** When true, ignore cached results and do not cache results for this query. */
    val skipCache: Boolean = false,
    /** The page to request from each provider, must greater than zero. */
    var page: Int = 1,
    /**
     * The limit applied to each provider query, expect a higher
     * [TorrentDescription] count when more than one provider
     * is enabled.
     */
    var limit: Int = -1,
) {
    init {
        require(page > 0) { "Search query page must be greater than zero." }
    }
}