jellyfin/MediaBrowser.Controller/Playlists/IPlaylistManager.cs

58 lines
2.1 KiB
C#
Raw Normal View History

2014-08-02 02:34:45 +00:00
using MediaBrowser.Controller.Entities;
2014-08-21 15:55:35 +00:00
using MediaBrowser.Model.Playlists;
2014-08-02 02:34:45 +00:00
using System.Collections.Generic;
using System.Threading.Tasks;
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(string userId);
/// <summary>
/// Creates the playlist.
/// </summary>
/// <param name="options">The options.</param>
/// <returns>Task&lt;Playlist&gt;.</returns>
2014-08-21 15:55:35 +00:00
Task<PlaylistCreationResult> CreatePlaylist(PlaylistCreationRequest options);
2014-08-02 02:34:45 +00:00
/// <summary>
/// Adds to playlist.
/// </summary>
/// <param name="playlistId">The playlist identifier.</param>
/// <param name="itemIds">The item ids.</param>
2014-08-22 02:24:38 +00:00
/// <param name="userId">The user identifier.</param>
2014-08-02 02:34:45 +00:00
/// <returns>Task.</returns>
2014-08-22 02:24:38 +00:00
Task AddToPlaylist(string playlistId, IEnumerable<string> itemIds, string userId);
2014-08-02 02:34:45 +00:00
/// <summary>
/// Removes from playlist.
/// </summary>
/// <param name="playlistId">The playlist identifier.</param>
2014-08-06 04:18:13 +00:00
/// <param name="entryIds">The entry ids.</param>
2014-08-02 02:34:45 +00:00
/// <returns>Task.</returns>
2014-08-06 04:18:13 +00:00
Task RemoveFromPlaylist(string playlistId, IEnumerable<string> entryIds);
2014-08-02 02:34:45 +00:00
/// <summary>
/// Gets the playlists folder.
/// </summary>
/// <param name="userId">The user identifier.</param>
/// <returns>Folder.</returns>
Folder GetPlaylistsFolder(string 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>
Task MoveItem(string playlistId, string entryId, int newIndex);
2014-08-02 02:34:45 +00:00
}
}