jellyfin-api/org.jellyfin.sdk.api.client/ApiClient

ApiClient

abstract class ApiClient

Constructors

constructor()

Types

object Companion

Properties

abstract val accessToken: String?

Access token to use for requests. Appended to all requests if set.

val ApiClient.activityLogApi: ActivityLogApi

val ApiClient.apiKeyApi: ApiKeyApi

val ApiClient.artistsApi: ArtistsApi

val ApiClient.audioApi: AudioApi

abstract val baseUrl: String?

URL to use as base for API endpoints. Should include the protocol and may contain a path.

val ApiClient.brandingApi: BrandingApi

val ApiClient.channelsApi: ChannelsApi

abstract val clientInfo: <Error class: unknown class>

Information about the client / application send in all API requests.

val ApiClient.clientLogApi: ClientLogApi

val ApiClient.collectionApi: CollectionApi

configurationApi

val ApiClient.configurationApi: ConfigurationApi

val ApiClient.dashboardApi: DashboardApi

abstract val deviceInfo: <Error class: unknown class>

Information about the device send in all API requests. Only a single session is allowed per device id.

val ApiClient.devicesApi: DevicesApi

displayPreferencesApi

val ApiClient.displayPreferencesApi: DisplayPreferencesApi

val ApiClient.dynamicHlsApi: DynamicHlsApi

val ApiClient.environmentApi: EnvironmentApi

val ApiClient.filterApi: FilterApi

val ApiClient.genresApi: GenresApi

val ApiClient.hlsSegmentApi: HlsSegmentApi

httpClientOptions

abstract val httpClientOptions: HttpClientOptions

HTTP Options for this ApiClient.

val ApiClient.imageApi: ImageApi

val ApiClient.instantMixApi: InstantMixApi

val ApiClient.itemLookupApi: ItemLookupApi

val ApiClient.itemRefreshApi: ItemRefreshApi

val ApiClient.itemsApi: ItemsApi

val ApiClient.itemUpdateApi: ItemUpdateApi

val ApiClient.libraryApi: LibraryApi

libraryStructureApi

val ApiClient.libraryStructureApi: LibraryStructureApi

val ApiClient.liveTvApi: LiveTvApi

localizationApi

val ApiClient.localizationApi: LocalizationApi

val ApiClient.lyricsApi: LyricsApi

val ApiClient.mediaInfoApi: MediaInfoApi

mediaSegmentsApi

val ApiClient.mediaSegmentsApi: MediaSegmentsApi

val ApiClient.moviesApi: MoviesApi

val ApiClient.musicGenresApi: MusicGenresApi

val ApiClient.packageApi: PackageApi

val ApiClient.personsApi: PersonsApi

val ApiClient.playlistsApi: PlaylistsApi

val ApiClient.playStateApi: PlayStateApi

val ApiClient.pluginsApi: PluginsApi

quickConnectApi

val ApiClient.quickConnectApi: QuickConnectApi

val ApiClient.remoteImageApi: RemoteImageApi

scheduledTasksApi

val ApiClient.scheduledTasksApi: ScheduledTasksApi

val ApiClient.searchApi: SearchApi

val ApiClient.sessionApi: SessionApi

val ApiClient.startupApi: StartupApi

val ApiClient.studiosApi: StudiosApi

val ApiClient.subtitleApi: SubtitleApi

val ApiClient.suggestionsApi: SuggestionsApi

val ApiClient.syncPlayApi: SyncPlayApi

val ApiClient.systemApi: SystemApi

val ApiClient.timeSyncApi: TimeSyncApi

val ApiClient.tmdbApi: TmdbApi

val ApiClient.trailersApi: TrailersApi

val ApiClient.trickplayApi: TrickplayApi

val ApiClient.tvShowsApi: TvShowsApi

universalAudioApi

val ApiClient.universalAudioApi: UniversalAudioApi

val ApiClient.userApi: UserApi

val ApiClient.userLibraryApi: UserLibraryApi

val ApiClient.userViewsApi: UserViewsApi

videoAttachmentsApi

val ApiClient.videoAttachmentsApi: VideoAttachmentsApi

val ApiClient.videosApi: VideosApi

abstract val webSocket: SocketApi

Get the instance of the SocketApi for this ApiClient.

val ApiClient.yearsApi: YearsApi

Functions

open fun createUrl(pathTemplate: String, pathParameters: Map<String, Any?> = emptyMap(), queryParameters: Map<String, Any?> = emptyMap(), ignorePathParameters: Boolean = false): String

Create a complete url based on the baseUrl and given parameters. Uses UrlBuilder to create the path from the pathTemplate and pathParameters.

inline suspend fun <T : Any> ApiClient.delete(pathTemplate: String, pathParameters: Map<String, Any?> = emptyMap(), queryParameters: Map<String, Any?> = emptyMap(), requestBody: Any? = null): Response<T>

inline suspend fun <T : Any> ApiClient.get(pathTemplate: String, pathParameters: Map<String, Any?> = emptyMap(), queryParameters: Map<String, Any?> = emptyMap(), requestBody: Any? = null): Response<T>

inline fun <T : Api> getOrCreateApi(noinline create: (apiClient: ApiClient) -> T): T

fun <T : Api> getOrCreateApi(kclass: KClass<T>, create: (apiClient: ApiClient) -> T): T

inline suspend fun <T : Any> ApiClient.post(pathTemplate: String, pathParameters: Map<String, Any?> = emptyMap(), queryParameters: Map<String, Any?> = emptyMap(), requestBody: Any? = null): Response<T>

abstract suspend fun request(method: HttpMethod = HttpMethod.GET, pathTemplate: String, pathParameters: Map<String, Any?> = emptyMap(), queryParameters: Map<String, Any?> = emptyMap(), requestBody: Any? = null): RawResponse

abstract fun update(baseUrl: String? = this.baseUrl, accessToken: String? = this.accessToken, clientInfo: <Error class: unknown class> = this.clientInfo, deviceInfo: <Error class: unknown class> = this.deviceInfo)

Change the authorization values used in this ApiClient instance.