PlaylistsApi

class PlaylistsApi(api: ApiClient) : Api

Constructors

Link copied to clipboard
constructor(api: ApiClient)

Functions

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

Adds items to a playlist.

Link copied to clipboard
suspend fun createPlaylist(data: ERROR CLASS: Symbol not found for CreatePlaylistDto?? = null): Response<ERROR CLASS: Symbol not found for 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 createPlaylistDeprecated(name: String? = null, ids: Collection<ERROR CLASS: Symbol not found for UUID>? = emptyList(), userId: ERROR CLASS: Symbol not found for UUID?? = null, mediaType: ERROR CLASS: Symbol not found for MediaType?? = null, data: ERROR CLASS: Symbol not found for CreatePlaylistDto?? = null): Response<ERROR CLASS: Symbol not found for 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: ERROR CLASS: Symbol not found for UUID): Response<ERROR CLASS: Symbol not found for PlaylistDto>

Get a playlist.

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

Gets the original items of a playlist.

Link copied to clipboard
suspend fun getPlaylistUser(playlistId: ERROR CLASS: Symbol not found for UUID, userId: ERROR CLASS: Symbol not found for UUID): Response<ERROR CLASS: Symbol not found for PlaylistUserPermissions>

Get a playlist user.

Link copied to clipboard
suspend fun getPlaylistUsers(playlistId: ERROR CLASS: Symbol not found for UUID): Response<List<ERROR CLASS: Symbol not found for PlaylistUserPermissions>>

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: ERROR CLASS: Symbol not found for UUID, userId: ERROR CLASS: Symbol not found for UUID): Response<Unit>

Remove a user from a playlist's users.

Link copied to clipboard
suspend fun updatePlaylist(playlistId: ERROR CLASS: Symbol not found for UUID, data: ERROR CLASS: Symbol not found for UpdatePlaylistDto): Response<Unit>

Updates a playlist.

Link copied to clipboard
suspend fun updatePlaylistUser(playlistId: ERROR CLASS: Symbol not found for UUID, userId: ERROR CLASS: Symbol not found for UUID, data: ERROR CLASS: Symbol not found for UpdatePlaylistUserDto): Response<Unit>

Modify a user of a playlist's users.