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

SubDlApi

class SubDlApi : SubtitleAPI(source)

Constructors

constructor()

Types

data class ApiKeyResponse(val ok: Boolean? = false, val apiKey: String, val usage: SubDlApi.Usage? = null)

data class ApiResponse(val status: Boolean? = null, val results: List<SubDlApi.Result>? = null, val subtitles: List<SubDlApi.Subtitle>? = null)

object Companion

OAuthTokenResponse

data class OAuthTokenResponse(val token: String, val userData: SubDlApi.UserData? = null, val status: Boolean? = null, val message: String? = null)

data class Result(val sdId: Int? = null, val type: String? = null, val name: String? = null, val imdbId: String? = null, val tmdbId: Long? = null, val firstAirDate: String? = null, val year: Int? = null)

data class Subtitle(val releaseName: String, val name: String, val lang: String, val author: String? = null, val url: String? = null, val subtitlePage: String? = null, val season: Int? = null, val episode: Int? = null, val language: String? = null, val hearingImpaired: Boolean? = null)

SubtitleOAuthEntity

data class SubtitleOAuthEntity(var userEmail: String, var pass: String, var name: String? = null, var accessToken: String? = null, var apiKey: String? = null)

data class Usage(val total: Long? = 0, val today: Long? = 0)

data class UserData(val email: String, val name: String, val country: String, val scStepCode: String, val scVerified: Boolean, val username: String? = null, val scUsername: String)

Properties

createAccountUrl

open override val createAccountUrl: String

Link to a website for creating a new account

open override val hasInApp: Boolean = true

Has in app login support, aka login with a dialog

open val hasOAuth2: Boolean = false

Has OAuth2 login support, including login, loginRequest and refreshToken

open val hasPin: Boolean = false

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

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

Drawable icon of the service

open override val idPrefix: String

inAppLoginRequirement

open override val inAppLoginRequirement: AuthLoginRequirement

The requirements to login in app

open override val name: String

redirectUrlIdentifier

open val redirectUrlIdentifier: String? = null

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

open override val requiresLogin: Boolean = true

If this service requires an account to use

Functions

getPersonalLibrary

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

open suspend override 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?

@WorkerThread

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

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

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

In app login

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

open fun loginRequest(): AuthLoginPage?

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

open suspend 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

@WorkerThread

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

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

fun ~~toRepo~~(): AuthRepo

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

Get the visible user account