jellyfin-server/MediaBrowser.Controller/Sync/ISyncDataProvider.cs

59 lines
2.3 KiB
C#
Raw Normal View History

2015-02-28 13:42:47 +00:00
using MediaBrowser.Model.Sync;
using System.Collections.Generic;
using System.Threading.Tasks;
namespace MediaBrowser.Controller.Sync
{
public interface ISyncDataProvider
{
/// <summary>
2015-04-13 05:12:02 +00:00
/// Gets the local items.
2015-02-28 13:42:47 +00:00
/// </summary>
/// <param name="target">The target.</param>
/// <param name="serverId">The server identifier.</param>
2015-04-13 05:12:02 +00:00
/// <returns>Task&lt;List&lt;LocalItem&gt;&gt;.</returns>
Task<List<LocalItem>> GetLocalItems(SyncTarget target, string serverId);
2015-04-04 01:24:49 +00:00
2015-02-28 13:42:47 +00:00
/// <summary>
/// Adds the or update.
/// </summary>
/// <param name="target">The target.</param>
/// <param name="item">The item.</param>
/// <returns>Task.</returns>
Task AddOrUpdate(SyncTarget target, LocalItem item);
/// <summary>
/// Deletes the specified identifier.
/// </summary>
/// <param name="target">The target.</param>
/// <param name="id">The identifier.</param>
/// <returns>Task.</returns>
Task Delete(SyncTarget target, string id);
/// <summary>
/// Gets the specified identifier.
/// </summary>
/// <param name="target">The target.</param>
/// <param name="id">The identifier.</param>
/// <returns>Task&lt;LocalItem&gt;.</returns>
Task<LocalItem> Get(SyncTarget target, string id);
2015-03-08 05:37:48 +00:00
/// <summary>
/// Gets the cached item.
/// </summary>
/// <param name="target">The target.</param>
2015-03-10 18:10:38 +00:00
/// <param name="serverId">The server identifier.</param>
/// <param name="itemId">The item identifier.</param>
2015-03-08 05:37:48 +00:00
/// <returns>Task&lt;LocalItem&gt;.</returns>
2015-04-04 01:24:49 +00:00
Task<List<LocalItem>> GetItems(SyncTarget target, string serverId, string itemId);
2015-03-31 18:50:08 +00:00
/// <summary>
/// Gets the cached items by synchronize job item identifier.
/// </summary>
/// <param name="target">The target.</param>
/// <param name="serverId">The server identifier.</param>
/// <param name="syncJobItemId">The synchronize job item identifier.</param>
/// <returns>Task&lt;List&lt;LocalItem&gt;&gt;.</returns>
2015-04-04 01:24:49 +00:00
Task<List<LocalItem>> GetItemsBySyncJobItemId(SyncTarget target, string serverId, string syncJobItemId);
2015-02-28 13:42:47 +00:00
}
}