SimklApi

Constructors

Link copied to clipboard
constructor(index: Int)

Types

Link copied to clipboard
object Companion
Link copied to clipboard
class SimklEpisodeConstructor(simklId: Int?, type: String?, totalEpisodeCount: Int?, hasEnded: Boolean?)

Useful to get episodes on demand to prevent unnecessary requests.

Link copied to clipboard
class SimklSyncStatus(var status: SyncWatchType, var score: Int?, val oldScore: Int?, var watchedEpisodes: Int?, val episodeConstructor: SimklApi.SimklEpisodeConstructor, var isFavorite: Boolean? = null, var maxEpisodes: Int? = null, val oldEpisodes: Int, val oldStatus: String?) : SyncAPI.AbstractSyncStatus

Properties

Link copied to clipboard
Link copied to clipboard
open override val createAccountUrl: String
Link copied to clipboard
open override val icon: Int
Link copied to clipboard
open override val idPrefix: String
Link copied to clipboard
open override val key: String
Link copied to clipboard
open override var mainUrl: String
Link copied to clipboard
open override var name: String
Link copied to clipboard
open override val redirectUrl: String
Link copied to clipboard
open override var requireLibraryRefresh: Boolean

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

Link copied to clipboard
open override val requiresLogin: Boolean = false
Link copied to clipboard
open override val syncIdName: SyncIdName

Allows certain providers to open pages from library links.

Functions

Link copied to clipboard
open override fun authenticate(activity: FragmentActivity?)
Link copied to clipboard
fun changeAccount(index: Int)
Link copied to clipboard
Link copied to clipboard
open override fun getIdFromUrl(url: String): String
Link copied to clipboard
open suspend override fun getPersonalLibrary(): SyncAPI.LibraryMetadata?
Link copied to clipboard
open suspend override fun getResult(id: String): SyncAPI.SyncResult?
Link copied to clipboard
open suspend override fun getStatus(id: String): SyncAPI.AbstractSyncStatus?
Link copied to clipboard
open suspend override fun handleRedirect(url: String): Boolean
Link copied to clipboard
fun init()
Link copied to clipboard
open override fun loginInfo(): AuthAPI.LoginInfo?
Link copied to clipboard
open override fun logOut()
Link copied to clipboard
open suspend override 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
open suspend override fun search(name: String): List<SyncAPI.SyncSearchResult>?
Link copied to clipboard

See https://simkl.docs.apiary.io/#reference/search/id-lookup/get-items-by-id