App/com.lagradost.cloudstream3.syncproviders.providers/SimklApi

SimklApi

class SimklApi : SyncAPI(source)

Constructors

constructor()

Types

object Companion

SimklEpisodeConstructor

class SimklEpisodeConstructor(simklId: Int?, type: String?, totalEpisodeCount: Int?, hasEnded: Boolean?)

Useful to get episodes on demand to prevent unnecessary requests.

SimklSyncStatus

class SimklSyncStatus(var status: SyncWatchType, var score: Score?, 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

createAccountUrl

open override val createAccountUrl: String

Link to a website for creating a new account

open val hasInApp: Boolean = false

Has in app login support, aka login with a dialog

open override val hasOAuth2: Boolean = true

Has OAuth2 login support, including login, loginRequest and refreshToken

open override val hasPin: Boolean = true

Has on device pin support, aka login with a QR code

open override val icon: ERROR CLASS: Unresolved name: simkl_logo

Drawable icon of the service

open override val idPrefix: String

inAppLoginRequirement

open val inAppLoginRequirement: AuthLoginRequirement? = null

The requirements to login in app

val key: String

open override var mainUrl: String

open override var name: String

redirectUrlIdentifier

open override val redirectUrlIdentifier: String

The sensitive redirect URL from OAuth should contain "/redirectUrlIdentifier" to trigger the login

requireLibraryRefresh

open override var requireLibraryRefresh: Boolean

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

open val requiresLogin: Boolean = true

If this service requires an account to use

supportedWatchTypes

open val supportedWatchTypes: Set<SyncWatchType>

Currently unused, but will be used to correctly render the UI. This should specify what sync watch types can be used with this service.

open override val syncIdName: SyncIdName

Allows certain providers to open pages from library links.

Functions

getPersonalLibrary

suspend fun ~~getPersonalLibrary~~(): SyncAPI.LibraryMetadata?

invalidateToken

open suspend fun invalidateToken(token: AuthToken): Nothing

An optional security measure to make sure that even if an attacker gets ahold of the token, it will be invalid.

isValidRedirectUrl

open fun isValidRedirectUrl(url: String): Boolean

Is this url a valid redirect url for this service?

open suspend override fun library(auth: AuthData?): SyncAPI.LibraryMetadata?

Get the current library/bookmarks of this service

open suspend override fun load(auth: AuthData?, id: String): SyncAPI.SyncResult?

Get metadata about an item

open suspend fun login(form: AuthLoginResponse): AuthToken?

In app login

open suspend override fun login(payload: AuthPinData): AuthToken?

Pin login, this will be called periodically while logging in to check if the pin has been verified by the user

open suspend override fun login(redirectUrl: String, payload: String?): AuthToken?

OAuth2 login from a valid redirectUrl, and payload given in loginRequest

fun ~~loginInfo~~(): AuthAPI.LoginInfo?

open override fun loginRequest(): AuthLoginPage?

OAuth2 login request, asking the service to provide a url to open in the browser

open suspend override fun pinRequest(): AuthPinData?

Pin login request, asking the service to provide an verificationUrl to display with a QR code

open suspend fun refreshToken(token: AuthToken): AuthToken?

OAuth2 token refresh, this ensures that all token passed to other functions will be valid

open suspend override fun search(auth: AuthData?, query: String): List<SyncAPI.SyncSearchResult>?

Search this service for any results for a given query

open suspend override fun status(auth: AuthData?, id: String): SyncAPI.AbstractSyncStatus?

Get the current status of an item

fun ~~toRepo~~(): AuthRepo

open suspend override fun updateStatus(auth: AuthData?, id: String, newStatus: SyncAPI.AbstractSyncStatus): Boolean

Modify the current status of an item

open override fun urlToId(url: String): String?

Helper function, may be used in the future

open suspend override fun user(token: AuthToken?): AuthUser?

Get the visible user account