SyncAPI

Types

Link copied to clipboard
abstract class AbstractSyncStatus
Link copied to clipboard
data class LibraryItem(val name: String, val url: String, val syncId: String, val episodesCompleted: Int?, val episodesTotal: Int?, val personalRating: Int?, val lastUpdatedUnixTime: Long?, val apiName: String, var type: TvType?, var posterUrl: String?, var posterHeaders: Map<String, String>?, var quality: SearchQuality?, var id: Int? = null, val plot: String? = null, val rating: Int? = null, val tags: List<String>? = null) : SearchResponse
Link copied to clipboard
data class LibraryList(val name: UiText, val items: List<SyncAPI.LibraryItem>)
Link copied to clipboard
data class LibraryMetadata(val allLibraryLists: List<SyncAPI.LibraryList>, val supportedListSorting: Set<ListSorting>)
Link copied to clipboard
data class Page(val title: UiText, var items: List<SyncAPI.LibraryItem>)
Link copied to clipboard
data class SyncResult(var id: String, var totalEpisodes: Int? = null, var title: String? = null, var publicScore: Int? = null, var duration: Int? = null, var synopsis: String? = null, var airStatus: ShowStatus? = null, var nextAiring: NextAiring? = null, var studio: List<String>? = null, var genres: List<String>? = null, var synonyms: List<String>? = null, var trailers: List<String>? = null, var isAdult: Boolean? = null, var posterUrl: String? = null, var backgroundPosterUrl: String? = null, var startDate: Long? = null, var endDate: Long? = null, var recommendations: List<SyncAPI.SyncSearchResult>? = null, var nextSeason: SyncAPI.SyncSearchResult? = null, var prevSeason: SyncAPI.SyncSearchResult? = null, var actors: List<ActorData>? = null)
Link copied to clipboard
data class SyncSearchResult(val name: String, val apiName: String, var syncId: String, val url: String, var posterUrl: String?, var type: TvType? = null, var quality: SearchQuality? = null, var posterHeaders: Map<String, String>? = null, var id: Int? = null) : SearchResponse
Link copied to clipboard
data class SyncStatus(var status: SyncWatchType, var score: Int?, var watchedEpisodes: Int?, var isFavorite: Boolean? = null, var maxEpisodes: Int? = null) : SyncAPI.AbstractSyncStatus

Properties

Link copied to clipboard
abstract val createAccountUrl: String?
Link copied to clipboard
abstract val icon: Int?
Link copied to clipboard
abstract val idPrefix: String
Link copied to clipboard
abstract val key: String
Link copied to clipboard
abstract val mainUrl: String
Link copied to clipboard
abstract val name: String
Link copied to clipboard
abstract val redirectUrl: String
Link copied to clipboard

Set this to true if the user updates something on the list like watch status or score

Link copied to clipboard
abstract val requiresLogin: Boolean
Link copied to clipboard
abstract val syncIdName: SyncIdName

Allows certain providers to open pages from library links.

Functions

Link copied to clipboard
abstract fun authenticate(activity: FragmentActivity?)
Link copied to clipboard
abstract fun getIdFromUrl(url: String): String
Link copied to clipboard
Link copied to clipboard
abstract suspend fun getResult(id: String): SyncAPI.SyncResult?
Link copied to clipboard
abstract suspend fun getStatus(id: String): SyncAPI.AbstractSyncStatus?
Link copied to clipboard
abstract suspend fun handleRedirect(url: String): Boolean
Link copied to clipboard
abstract fun loginInfo(): AuthAPI.LoginInfo?
Link copied to clipboard
abstract fun logOut()
Link copied to clipboard
abstract suspend fun score(id: String, status: SyncAPI.AbstractSyncStatus): Boolean

-1 -> None 0 -> Watching 1 -> Completed 2 -> OnHold 3 -> Dropped 4 -> PlanToWatch 5 -> ReWatching

Link copied to clipboard
abstract suspend fun search(name: String): List<SyncAPI.SyncSearchResult>?