PlaylistsApi

class PlaylistsApi(api: ApiClient) : Api

Constructors

Link copied to clipboard
constructor(api: ApiClient)

Functions

Link copied to clipboard
suspend fun addItemToPlaylist(playlistId: UUID, ids: Collection<UUID>? = emptyList(), userId: UUID? = null): Response<Unit>

Adds items to a playlist.

Link copied to clipboard

For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete.

Link copied to clipboard
suspend fun createPlaylistDeprecated(name: String? = null, ids: Collection<UUID>? = emptyList(), userId: UUID? = null, mediaType: MediaType? = null, data: CreatePlaylistDto? = null): Response<PlaylistCreationResult>

For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete.

Link copied to clipboard
suspend fun getPlaylist(playlistId: UUID): Response<PlaylistDto>

Get a playlist.

Link copied to clipboard
suspend fun getPlaylistItems(playlistId: UUID, userId: UUID? = null, startIndex: Int? = null, limit: Int? = null, fields: Collection<ItemFields>? = emptyList(), enableImages: Boolean? = null, enableUserData: Boolean? = null, imageTypeLimit: Int? = null, enableImageTypes: Collection<ImageType>? = emptyList()): Response<BaseItemDtoQueryResult>

Gets the original items of a playlist.

Link copied to clipboard
suspend fun getPlaylistUser(playlistId: UUID, userId: UUID): Response<PlaylistUserPermissions>

Get a playlist user.

Link copied to clipboard

Get a playlist's users.

Link copied to clipboard
suspend fun moveItem(playlistId: String, itemId: String, newIndex: Int): Response<Unit>

Moves a playlist item.

Link copied to clipboard
suspend fun removeItemFromPlaylist(playlistId: String, entryIds: Collection<String>? = emptyList()): Response<Unit>

Removes items from a playlist.

Link copied to clipboard
suspend fun removeUserFromPlaylist(playlistId: UUID, userId: UUID): Response<Unit>

Remove a user from a playlist's users.

Link copied to clipboard
suspend fun updatePlaylist(playlistId: UUID, data: UpdatePlaylistDto): Response<Unit>

Updates a playlist.

Link copied to clipboard
suspend fun updatePlaylistUser(playlistId: UUID, userId: UUID, data: UpdatePlaylistUserDto): Response<Unit>

Modify a user of a playlist's users.