jellyfin-api/org.jellyfin.sdk.api.operations/PluginApi

PluginApi

class PluginApi(api: ApiClient) : Api

Constructors

PluginApi

constructor(api: ApiClient)

Functions

cancelPackageInstallation

suspend fun cancelPackageInstallation(packageId: UUID): Response<Unit>

Cancels a package installation.

disablePlugin

suspend fun disablePlugin(pluginId: UUID, version: String): Response<Unit>

Disable a plugin.

enablePlugin

suspend fun enablePlugin(pluginId: UUID, version: String): Response<Unit>

Enables a disabled plugin.

getConfigurationPages

suspend fun getConfigurationPages(enableInMainMenu: Boolean? = null): Response<List<ConfigurationPageInfo>>

Gets the configuration pages.

getDashboardConfigurationPage

suspend fun getDashboardConfigurationPage(name: String? = null): Response<String>

Gets a dashboard configuration page.

getPackageInfo

suspend fun getPackageInfo(name: String, assemblyGuid: UUID? = null): Response<PackageInfo>

Gets a package by name or assembly GUID.

getPackages

suspend fun getPackages(): Response<List<PackageInfo>>

Gets available packages.

getPluginConfiguration

suspend fun getPluginConfiguration(pluginId: UUID): Response<BasePluginConfiguration>

Gets plugin configuration.

getPluginImage

suspend fun getPluginImage(pluginId: UUID, version: String): Response<ByteArray>

Gets a plugin's image.

getPluginImageUrl

fun getPluginImageUrl(pluginId: UUID, version: String): String

Gets a plugin's image.

getPluginManifest

suspend fun getPluginManifest(pluginId: UUID): Response<Unit>

Gets a plugin's manifest.

getPlugins

suspend fun getPlugins(): Response<List<PluginInfo>>

Gets a list of currently installed plugins.

getRepositories

suspend fun getRepositories(): Response<List<RepositoryInfo>>

Gets all package repositories.

installPackage

suspend fun installPackage(name: String, assemblyGuid: UUID? = null, version: String? = null, repositoryUrl: String? = null): Response<Unit>

Installs a package.

setRepositories

suspend fun setRepositories(data: List<RepositoryInfo>): Response<Unit>

Sets the enabled and existing package repositories.

uninstallPlugin

suspend fun uninstallPlugin(pluginId: UUID): Response<Unit>

Uninstalls a plugin.

uninstallPluginByVersion

suspend fun uninstallPluginByVersion(pluginId: UUID, version: String): Response<Unit>

Uninstalls a plugin by version.

updatePluginConfiguration

suspend fun updatePluginConfiguration(pluginId: UUID): Response<Unit>

Accepts plugin configuration as JSON body.