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

UserLibraryApi

class UserLibraryApi(api: ApiClient) : Api

Constructors

constructor(api: ApiClient)

Functions

deleteUserItemRating

suspend fun deleteUserItemRating(itemId: UUID, userId: UUID? = null): Response<UserItemDataDto>

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

suspend fun getIntros(itemId: UUID, userId: UUID? = null): Response<BaseItemDtoQueryResult>

Gets intros to play before the main media item plays.

suspend fun getItem(itemId: UUID, userId: UUID? = null): Response<BaseItemDto>

Gets an item from a user's library.

suspend fun getLatestMedia(request: GetLatestMediaRequest = GetLatestMediaRequest()): Response<List<BaseItemDto>>

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

Gets latest media.

getLocalTrailers

suspend fun getLocalTrailers(itemId: UUID, userId: UUID? = null): Response<List<BaseItemDto>>

Gets local trailers for an item.

suspend fun getRootFolder(userId: UUID? = null): Response<BaseItemDto>

Gets the root folder from a user's library.

getSpecialFeatures

suspend fun getSpecialFeatures(itemId: UUID, userId: UUID? = null): Response<List<BaseItemDto>>

Gets special features for an item.

markFavoriteItem

suspend fun markFavoriteItem(itemId: UUID, userId: UUID? = null): Response<UserItemDataDto>

Marks an item as a favorite.

unmarkFavoriteItem

suspend fun unmarkFavoriteItem(itemId: UUID, userId: UUID? = null): Response<UserItemDataDto>

Unmarks item as a favorite.

updateUserItemRating

suspend fun updateUserItemRating(itemId: UUID, userId: UUID? = null, likes: Boolean? = null): Response<UserItemDataDto>

Updates a user's rating for an item.