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

LocalList

class LocalList : SyncAPI(source)

Constructors

LocalList

constructor()

Properties

createAccountUrl

open override val createAccountUrl: Nothing? = 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 override val icon: Int

Drawable icon of the service

idPrefix

open override val idPrefix: String

inAppLoginRequirement

open val inAppLoginRequirement: AuthLoginRequirement? = null

The requirements to login in app

mainUrl

open val mainUrl: String

name

open override val name: String

redirectUrlIdentifier

open val redirectUrlIdentifier: String? = null

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

requiresLogin

open override val requiresLogin: Boolean = false

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.

syncIdName

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?

library

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

Get the current library/bookmarks of this service

load

@WorkerThread

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

@WorkerThread

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

Search this service for any results for a given query

status

@WorkerThread

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

Get the current status of an item

toRepo

fun ~~toRepo~~(): AuthRepo

updateStatus

@WorkerThread

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

Modify the current status of an item

urlToId

open fun urlToId(url: String): String?

Helper function, may be used in the future

user

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

Get the visible user account