App/com.lagradost.cloudstream3.syncproviders/BackupAPI

BackupAPI

abstract class BackupAPI : AuthAPI(source)

Work in progress

Constructors

BackupAPI

constructor()

Properties

createAccountUrl

open val createAccountUrl: String? = null

Link to a website for creating a new account

filename

open val filename: String

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

downloadFile

open suspend fun downloadFile(auth: AuthData?): String?

Get the backup file as a JSON string from the remote storage. Return null if not found/empty

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

toRepo

fun ~~toRepo~~(): AuthRepo

uploadFile

open suspend fun uploadFile(auth: AuthData?, data: String): String?

Get the backup file as a JSON string from the remote storage.

user

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

Get the visible user account