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

UserLibraryApi

class UserLibraryApi(api: ApiClient) : Api

Constructors

constructor(api: ApiClient)

Functions

suspend fun deleteUserItemRating(itemId: ERROR CLASS: Symbol not found for UUID, userId: ERROR CLASS: Symbol not found for UUID?? = null): Response<ERROR CLASS: Symbol not found for UserItemDataDto>

Deletes a user's saved personal rating for an item.

getIntros

suspend fun getIntros(itemId: ERROR CLASS: Symbol not found for UUID, userId: ERROR CLASS: Symbol not found for UUID?? = null): Response<ERROR CLASS: Symbol not found for BaseItemDtoQueryResult>

Gets intros to play before the main media item plays.

getItem

suspend fun getItem(itemId: ERROR CLASS: Symbol not found for UUID, userId: ERROR CLASS: Symbol not found for UUID?? = null): Response<ERROR CLASS: Symbol not found for BaseItemDto>

Gets an item from a user's library.

getLatestMedia

suspend fun getLatestMedia(request: ERROR CLASS: Symbol not found for GetLatestMediaRequest = GetLatestMediaRequest()): Response<List<ERROR CLASS: Symbol not found for BaseItemDto>>

suspend fun getLatestMedia(userId: ERROR CLASS: Symbol not found for UUID?? = null, parentId: ERROR CLASS: Symbol not found for UUID?? = null, fields: Collection<ERROR CLASS: Symbol not found for ItemFields>? = emptyList(), includeItemTypes: Collection<ERROR CLASS: Symbol not found for BaseItemKind>? = emptyList(), isPlayed: Boolean? = null, enableImages: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ERROR CLASS: Symbol not found for ImageType>? = emptyList(), enableUserData: Boolean? = null, limit: Int? = 20, groupItems: Boolean? = true): Response<List<ERROR CLASS: Symbol not found for BaseItemDto>>

Gets latest media.

getLocalTrailers

suspend fun getLocalTrailers(itemId: ERROR CLASS: Symbol not found for UUID, userId: ERROR CLASS: Symbol not found for UUID?? = null): Response<List<ERROR CLASS: Symbol not found for BaseItemDto>>

Gets local trailers for an item.

getRootFolder

suspend fun getRootFolder(userId: ERROR CLASS: Symbol not found for UUID?? = null): Response<ERROR CLASS: Symbol not found for BaseItemDto>

Gets the root folder from a user's library.

getSpecialFeatures

suspend fun getSpecialFeatures(itemId: ERROR CLASS: Symbol not found for UUID, userId: ERROR CLASS: Symbol not found for UUID?? = null): Response<List<ERROR CLASS: Symbol not found for BaseItemDto>>

Gets special features for an item.

markFavoriteItem

suspend fun markFavoriteItem(itemId: ERROR CLASS: Symbol not found for UUID, userId: ERROR CLASS: Symbol not found for UUID?? = null): Response<ERROR CLASS: Symbol not found for UserItemDataDto>

Marks an item as a favorite.

unmarkFavoriteItem

suspend fun unmarkFavoriteItem(itemId: ERROR CLASS: Symbol not found for UUID, userId: ERROR CLASS: Symbol not found for UUID?? = null): Response<ERROR CLASS: Symbol not found for UserItemDataDto>

Unmarks item as a favorite.

updateUserItemRating

suspend fun updateUserItemRating(itemId: ERROR CLASS: Symbol not found for UUID, userId: ERROR CLASS: Symbol not found for UUID?? = null, likes: Boolean? = null): Response<ERROR CLASS: Symbol not found for UserItemDataDto>

Updates a user's rating for an item.