TorrentSearch/torrentsearch/TorrentProvider

TorrentProvider

interface TorrentProvider

TorrentProviders define how to communicate with a single torrent provider.

Inheritors

BaseTorrentProvider

Properties

abstract val baseUrl: String

The Provider's base url. (ex. https://provider.link)

abstract val categories: Map<Category, String>

Maps a url safe string of provider categories to a Category.

abstract val isEnabled: Boolean

True if the provider is enabled.

abstract val name: String

The Provider's name.

open val resultsPerPage: Int

The result limit for search requests.

abstract val searchParams: Map<SearchParam, String>

The Provider's available query parameters and names.

abstract val searchPath: String

The Provider's path to search data.

abstract val tokenPath: String

The Provider's path to acquire a token.

Functions

abstract fun disable()

Disable this provider, so it cannot be used until enable is called.

abstract fun enable(username: String? = null, password: String? = null, cookies: List<String> = emptyList())

Enable this provider using the provided authentication details.

open suspend fun resolve(torrents: List<TorrentDescription>): ResolveResult

Resolve missing details such as the torrent hash/magnetUrl for TorrentDescriptions which require an additional request to obtain.

abstract suspend fun search(query: TorrentQuery): ProviderResult

Execute a search for the given query in category, returning TorrentDescriptions for each of the Provider's entries.