App/com.lagradost.cloudstream3.syncproviders/SubtitleAPI

SubtitleAPI

abstract class SubtitleAPI : AuthAPI(source)

Stateless subtitle class for external subtitles.

All non-null AuthToken will be non-expired when each function is called.

Inheritors

Constructors

SubtitleAPI

constructor()

Properties

createAccountUrl

open val createAccountUrl: String? = null

Link to a website for creating a new account

hasInApp

open val hasInApp: Boolean = false

Has in app login support, aka login with a dialog

hasOAuth2

open val hasOAuth2: Boolean = false

Has OAuth2 login support, including login, loginRequest and refreshToken

hasPin

open val hasPin: Boolean = false

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

icon

open val icon: Int? = null

Drawable icon of the service

idPrefix

open val idPrefix: String

inAppLoginRequirement

open val inAppLoginRequirement: AuthLoginRequirement? = null

The requirements to login in app

name

open val name: String

redirectUrlIdentifier

open val redirectUrlIdentifier: String? = null

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

requiresLogin

open val requiresLogin: Boolean = true

If this service requires an account to use

Functions

getPersonalLibrary

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

getResources

@WorkerThread

open suspend fun SubtitleResource.getResources(auth: AuthData?, subtitle: AbstractSubtitleEntities.SubtitleEntity)

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?

load

@WorkerThread

open suspend fun load(auth: AuthData?, subtitle: AbstractSubtitleEntities.SubtitleEntity): String?

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

In app login

open suspend 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 fun login(redirectUrl: String, payload: String?): AuthToken?

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

loginInfo

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

loginRequest

open fun loginRequest(): AuthLoginPage?

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

pinRequest

open suspend fun pinRequest(): AuthPinData?

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

refreshToken

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

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

resource

@WorkerThread

suspend fun resource(auth: AuthData?, subtitle: AbstractSubtitleEntities.SubtitleEntity): SubtitleResource

@WorkerThread

open suspend fun search(auth: AuthData?, query: AbstractSubtitleEntities.SubtitleSearch): List<AbstractSubtitleEntities.SubtitleEntity>?

toRepo

fun ~~toRepo~~(): AuthRepo

user

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

Get the visible user account