jellyfin/MediaBrowser.Controller/Playlists/IPlaylistManager.cs

61 lines
2.1 KiB
C#
Raw Normal View History

#pragma warning disable CS1591
using System;
2018-12-27 23:27:57 +00:00
using System.Collections.Generic;
using System.Threading.Tasks;
using MediaBrowser.Controller.Entities;
using MediaBrowser.Model.Playlists;
2018-12-27 23:27:57 +00:00
namespace MediaBrowser.Controller.Playlists
{
public interface IPlaylistManager
{
/// <summary>
/// Gets the playlists.
/// </summary>
/// <param name="userId">The user identifier.</param>
/// <returns>IEnumerable&lt;Playlist&gt;.</returns>
IEnumerable<Playlist> GetPlaylists(Guid userId);
/// <summary>
/// Creates the playlist.
/// </summary>
/// <param name="options">The options.</param>
/// <returns>Task&lt;Playlist&gt;.</returns>
Task<PlaylistCreationResult> CreatePlaylist(PlaylistCreationRequest options);
/// <summary>
/// Adds to playlist.
/// </summary>
/// <param name="playlistId">The playlist identifier.</param>
/// <param name="itemIds">The item ids.</param>
/// <param name="userId">The user identifier.</param>
/// <returns>Task.</returns>
2020-08-21 20:19:16 +00:00
Task AddToPlaylistAsync(Guid playlistId, ICollection<Guid> itemIds, Guid userId);
2018-12-27 23:27:57 +00:00
/// <summary>
/// Removes from playlist.
/// </summary>
/// <param name="playlistId">The playlist identifier.</param>
/// <param name="entryIds">The entry ids.</param>
/// <returns>Task.</returns>
2020-08-21 20:01:19 +00:00
Task RemoveFromPlaylistAsync(string playlistId, IEnumerable<string> entryIds);
2018-12-27 23:27:57 +00:00
/// <summary>
/// Gets the playlists folder.
/// </summary>
/// <param name="userId">The user identifier.</param>
/// <returns>Folder.</returns>
Folder GetPlaylistsFolder(Guid userId);
/// <summary>
/// Moves the item.
/// </summary>
/// <param name="playlistId">The playlist identifier.</param>
/// <param name="entryId">The entry identifier.</param>
/// <param name="newIndex">The new index.</param>
/// <returns>Task.</returns>
2020-08-21 20:01:19 +00:00
Task MoveItemAsync(string playlistId, string entryId, int newIndex);
2018-12-27 23:27:57 +00:00
}
}