jellyfin/MediaBrowser.Controller/Sync/ISyncManager.cs

201 lines
7.0 KiB
C#
Raw Normal View History

2014-12-11 06:20:28 +00:00
using MediaBrowser.Controller.Entities;
2015-01-21 03:54:45 +00:00
using MediaBrowser.Model.Events;
2014-07-22 16:36:34 +00:00
using MediaBrowser.Model.Querying;
2014-07-15 04:12:26 +00:00
using MediaBrowser.Model.Sync;
2014-12-31 06:24:49 +00:00
using MediaBrowser.Model.Users;
2015-01-21 03:54:45 +00:00
using System;
2014-07-15 04:12:26 +00:00
using System.Collections.Generic;
using System.Threading.Tasks;
namespace MediaBrowser.Controller.Sync
{
public interface ISyncManager
{
2015-01-28 04:04:26 +00:00
event EventHandler<GenericEventArgs<SyncJobCreationResult>> SyncJobCreated;
2015-01-21 03:54:45 +00:00
event EventHandler<GenericEventArgs<SyncJob>> SyncJobCancelled;
2015-02-04 19:13:00 +00:00
event EventHandler<GenericEventArgs<SyncJob>> SyncJobUpdated;
2015-02-05 03:01:37 +00:00
event EventHandler<GenericEventArgs<SyncJobItem>> SyncJobItemUpdated;
event EventHandler<GenericEventArgs<SyncJobItem>> SyncJobItemCreated;
2014-07-15 04:12:26 +00:00
/// <summary>
/// Creates the job.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Task.</returns>
2014-07-26 17:30:15 +00:00
Task<SyncJobCreationResult> CreateJob(SyncJobRequest request);
2014-07-15 04:12:26 +00:00
/// <summary>
/// Gets the jobs.
/// </summary>
/// <returns>QueryResult&lt;SyncJob&gt;.</returns>
2014-12-31 06:24:49 +00:00
Task<QueryResult<SyncJob>> GetJobs(SyncJobQuery query);
2014-07-15 04:12:26 +00:00
2014-12-17 05:52:34 +00:00
/// <summary>
/// Gets the job items.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>QueryResult&lt;SyncJobItem&gt;.</returns>
QueryResult<SyncJobItem> GetJobItems(SyncJobItemQuery query);
2015-02-05 03:01:37 +00:00
2014-07-17 22:21:35 +00:00
/// <summary>
/// Gets the job.
/// </summary>
/// <param name="id">The identifier.</param>
/// <returns>SyncJob.</returns>
SyncJob GetJob(string id);
2014-12-13 03:56:30 +00:00
2014-12-31 06:24:49 +00:00
/// <summary>
/// Updates the job.
/// </summary>
/// <param name="job">The job.</param>
/// <returns>Task.</returns>
Task UpdateJob(SyncJob job);
2015-01-21 03:54:45 +00:00
/// <summary>
/// Res the enable job item.
/// </summary>
/// <param name="id">The identifier.</param>
/// <returns>Task.</returns>
Task ReEnableJobItem(string id);
/// <summary>
/// Cnacels the job item.
/// </summary>
/// <param name="id">The identifier.</param>
/// <returns>Task.</returns>
Task CancelJobItem(string id);
2015-02-05 03:01:37 +00:00
2014-07-15 04:12:26 +00:00
/// <summary>
/// Cancels the job.
/// </summary>
/// <param name="id">The identifier.</param>
/// <returns>Task.</returns>
Task CancelJob(string id);
2015-04-04 01:24:49 +00:00
/// <summary>
/// Cancels the items.
/// </summary>
/// <param name="targetId">The target identifier.</param>
/// <param name="itemIds">The item ids.</param>
/// <returns>Task.</returns>
Task CancelItems(string targetId, IEnumerable<string> itemIds);
2014-07-22 01:29:06 +00:00
/// <summary>
/// Adds the parts.
/// </summary>
void AddParts(IEnumerable<ISyncProvider> providers);
/// <summary>
/// Gets the synchronize targets.
/// </summary>
2014-07-22 16:36:34 +00:00
IEnumerable<SyncTarget> GetSyncTargets(string userId);
2017-07-15 20:19:58 +00:00
IEnumerable<SyncTarget> GetSyncTargets(string userId, bool? supportsRemoteSync);
2014-07-22 16:36:34 +00:00
/// <summary>
/// Supportses the synchronize.
/// </summary>
/// <param name="item">The item.</param>
/// <returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
bool SupportsSync(BaseItem item);
2014-12-13 03:56:30 +00:00
2014-12-17 05:30:31 +00:00
/// <summary>
/// Reports the synchronize job item transferred.
/// </summary>
/// <param name="id">The identifier.</param>
/// <returns>Task.</returns>
Task ReportSyncJobItemTransferred(string id);
/// <summary>
/// Gets the job item.
/// </summary>
/// <param name="id">The identifier.</param>
/// <returns>SyncJobItem.</returns>
SyncJobItem GetJobItem(string id);
2014-12-26 17:45:06 +00:00
/// <summary>
/// Reports the offline action.
/// </summary>
/// <param name="action">The action.</param>
/// <returns>Task.</returns>
Task ReportOfflineAction(UserAction action);
2014-12-27 22:52:41 +00:00
/// <summary>
/// Gets the ready synchronize items.
/// </summary>
/// <param name="targetId">The target identifier.</param>
/// <returns>List&lt;SyncedItem&gt;.</returns>
2015-02-19 17:46:18 +00:00
Task<List<SyncedItem>> GetReadySyncItems(string targetId);
2014-12-29 05:56:55 +00:00
/// <summary>
/// Synchronizes the data.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Task&lt;SyncDataResponse&gt;.</returns>
Task<SyncDataResponse> SyncData(SyncDataRequest request);
2015-01-21 04:56:00 +00:00
/// <summary>
/// Marks the job item for removal.
/// </summary>
/// <param name="id">The identifier.</param>
/// <returns>Task.</returns>
Task MarkJobItemForRemoval(string id);
/// <summary>
/// Unmarks the job item for removal.
/// </summary>
/// <param name="id">The identifier.</param>
/// <returns>Task.</returns>
Task UnmarkJobItemForRemoval(string id);
2015-01-24 19:03:55 +00:00
/// <summary>
/// Gets the library item ids.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>QueryResult&lt;System.String&gt;.</returns>
2016-08-03 06:38:19 +00:00
Dictionary<string, SyncedItemProgress> GetSyncedItemProgresses(SyncJobItemQuery query);
2015-02-03 18:14:53 +00:00
2015-02-05 05:29:37 +00:00
/// <summary>
/// Reports the synchronize job item transfer beginning.
/// </summary>
/// <param name="id">The identifier.</param>
/// <returns>Task.</returns>
Task ReportSyncJobItemTransferBeginning(string id);
/// <summary>
/// Reports the synchronize job item transfer failed.
/// </summary>
/// <param name="id">The identifier.</param>
/// <returns>Task.</returns>
Task ReportSyncJobItemTransferFailed(string id);
2015-03-12 04:47:16 +00:00
/// <summary>
/// Gets the quality options.
/// </summary>
/// <param name="targetId">The target identifier.</param>
/// <returns>IEnumerable&lt;SyncQualityOption&gt;.</returns>
IEnumerable<SyncQualityOption> GetQualityOptions(string targetId);
2015-04-05 15:01:57 +00:00
/// <summary>
/// Gets the quality options.
/// </summary>
/// <param name="targetId">The target identifier.</param>
/// <param name="user">The user.</param>
/// <returns>IEnumerable&lt;SyncQualityOption&gt;.</returns>
IEnumerable<SyncQualityOption> GetQualityOptions(string targetId, User user);
2015-03-15 01:42:09 +00:00
/// <summary>
/// Gets the profile options.
/// </summary>
/// <param name="targetId">The target identifier.</param>
/// <returns>IEnumerable&lt;SyncQualityOption&gt;.</returns>
2015-03-15 04:17:35 +00:00
IEnumerable<SyncProfileOption> GetProfileOptions(string targetId);
2015-04-05 15:01:57 +00:00
/// <summary>
/// Gets the profile options.
/// </summary>
/// <param name="targetId">The target identifier.</param>
/// <param name="user">The user.</param>
/// <returns>IEnumerable&lt;SyncProfileOption&gt;.</returns>
IEnumerable<SyncProfileOption> GetProfileOptions(string targetId, User user);
2014-07-15 04:12:26 +00:00
}
}