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

KitsuApi

class KitsuApi : SyncAPI(source)

Constructors

constructor()

Types

object Companion

KitsuAnimeAttributes

data class KitsuAnimeAttributes(val titles: KitsuApi.KitsuTitles?, val canonicalTitle: String?, val posterImage: KitsuApi.KitsuPosterImage?, val synopsis: String?, val startDate: String?, val endDate: String?, val episodeCount: Int?, val episodeLength: Int?)

data class KitsuAnimeData(val id: String, val attributes: KitsuApi.KitsuAnimeAttributes)

data class KitsuLinks(val first: String?, val next: String?, val last: String?, val related: String?)

data class KitsuNode(val id: String, val attributes: KitsuApi.KitsuNodeAttributes, val relationships: KitsuApi.KitsuRelationships?, var anime: KitsuApi.KitsuAnimeData?)

KitsuNodeAttributes

data class KitsuNodeAttributes(val titles: KitsuApi.KitsuTitles?, val canonicalTitle: String?, val posterImage: KitsuApi.KitsuPosterImage?, val synopsis: String?, val startDate: String?, val endDate: String?, val episodeCount: Int?, val episodeLength: Int?, val name: String?, val location: String?, val createdAt: String?, val avatar: KitsuApi.KitsuUserAvatar?, val progress: Int?, val ratingTwenty: Float?, val updatedAt: String?, val status: String?)

KitsuPosterImage

data class KitsuPosterImage(val large: String?, val medium: String?)

KitsuRelationships

data class KitsuRelationships(val anime: KitsuApi.KitsuRelationshipsAnime?)

KitsuRelationshipsAnime

data class KitsuRelationshipsAnime(val links: KitsuApi.KitsuLinks?)

data class KitsuResponse(val links: KitsuApi.KitsuLinks?, val data: List<KitsuApi.KitsuNode>, val included: List<KitsuApi.KitsuAnimeData>?)

data class KitsuTitles(val enJp: String?, val jaJp: String?)

KitsuUserAvatar

data class KitsuUserAvatar(val original: String?)

data class ResponseToken(val tokenType: String, val expiresIn: Int, val accessToken: String, val refreshToken: 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: kitsu_icon

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 mainUrl: String

open override var name: String

redirectUrlIdentifier

open val redirectUrlIdentifier: String? = null

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

requireLibraryRefresh

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

getAnimeIdByTitle

suspend fun getAnimeIdByTitle(title: String): String?

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