jellyfin-server/MediaBrowser.Controller/Collections/ICollectionManager.cs

72 lines
2.5 KiB
C#
Raw Normal View History

2014-04-22 17:25:54 +00:00
using MediaBrowser.Controller.Entities;
using MediaBrowser.Controller.Entities.Movies;
2014-03-15 15:17:46 +00:00
using System;
using System.Collections.Generic;
2014-03-06 05:17:13 +00:00
using System.Threading.Tasks;
namespace MediaBrowser.Controller.Collections
{
public interface ICollectionManager
{
2014-07-08 01:41:03 +00:00
/// <summary>
/// Occurs when [collection created].
/// </summary>
event EventHandler<CollectionCreatedEventArgs> CollectionCreated;
/// <summary>
/// Occurs when [items added to collection].
/// </summary>
event EventHandler<CollectionModifiedEventArgs> ItemsAddedToCollection;
/// <summary>
/// Occurs when [items removed from collection].
/// </summary>
event EventHandler<CollectionModifiedEventArgs> ItemsRemovedFromCollection;
2014-03-06 05:17:13 +00:00
/// <summary>
/// Creates the collection.
/// </summary>
/// <param name="options">The options.</param>
/// <returns>Task.</returns>
2014-03-15 15:17:46 +00:00
Task<BoxSet> CreateCollection(CollectionCreationOptions options);
2014-03-06 05:17:13 +00:00
/// <summary>
/// Adds to collection.
/// </summary>
/// <param name="collectionId">The collection identifier.</param>
/// <param name="itemIds">The item ids.</param>
2014-03-06 05:17:13 +00:00
/// <returns>Task.</returns>
Task AddToCollection(Guid collectionId, IEnumerable<Guid> itemIds);
2014-03-06 05:17:13 +00:00
/// <summary>
/// Removes from collection.
/// </summary>
/// <param name="collectionId">The collection identifier.</param>
/// <param name="itemIds">The item ids.</param>
2014-03-06 05:17:13 +00:00
/// <returns>Task.</returns>
Task RemoveFromCollection(Guid collectionId, IEnumerable<Guid> itemIds);
2014-04-22 17:25:54 +00:00
/// <summary>
/// Collapses the items within box sets.
/// </summary>
/// <param name="items">The items.</param>
/// <param name="user">The user.</param>
/// <returns>IEnumerable{BaseItem}.</returns>
IEnumerable<BaseItem> CollapseItemsWithinBoxSets(IEnumerable<BaseItem> items, User user);
2014-07-01 04:06:28 +00:00
/// <summary>
/// Gets the collections folder.
/// </summary>
/// <param name="userId">The user identifier.</param>
/// <returns>Folder.</returns>
Folder GetCollectionsFolder(string userId);
2015-01-24 19:03:55 +00:00
/// <summary>
/// Gets the collections.
/// </summary>
/// <param name="user">The user.</param>
/// <returns>IEnumerable&lt;BoxSet&gt;.</returns>
IEnumerable<BoxSet> GetCollections(User user);
2014-03-06 05:17:13 +00:00
}
}