mirror of
https://github.com/jellyfin/jellyfin.git
synced 2024-09-06 19:37:55 +02:00
183 lines
6.3 KiB
C#
183 lines
6.3 KiB
C#
using MediaBrowser.Controller.Entities;
|
|
using MediaBrowser.Model.Events;
|
|
using MediaBrowser.Model.Querying;
|
|
using MediaBrowser.Model.Sync;
|
|
using MediaBrowser.Model.Users;
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace MediaBrowser.Controller.Sync
|
|
{
|
|
public interface ISyncManager
|
|
{
|
|
event EventHandler<GenericEventArgs<SyncJobCreationResult>> SyncJobCreated;
|
|
event EventHandler<GenericEventArgs<SyncJob>> SyncJobCancelled;
|
|
event EventHandler<GenericEventArgs<SyncJob>> SyncJobUpdated;
|
|
event EventHandler<GenericEventArgs<SyncJobItem>> SyncJobItemUpdated;
|
|
event EventHandler<GenericEventArgs<SyncJobItem>> SyncJobItemCreated;
|
|
event EventHandler<GenericEventArgs<SyncJobItem>> SyncJobItemCancelled;
|
|
|
|
/// <summary>
|
|
/// Creates the job.
|
|
/// </summary>
|
|
/// <param name="request">The request.</param>
|
|
/// <returns>Task.</returns>
|
|
Task<SyncJobCreationResult> CreateJob(SyncJobRequest request);
|
|
|
|
/// <summary>
|
|
/// Gets the jobs.
|
|
/// </summary>
|
|
/// <returns>QueryResult<SyncJob>.</returns>
|
|
Task<QueryResult<SyncJob>> GetJobs(SyncJobQuery query);
|
|
|
|
/// <summary>
|
|
/// Gets the job items.
|
|
/// </summary>
|
|
/// <param name="query">The query.</param>
|
|
/// <returns>QueryResult<SyncJobItem>.</returns>
|
|
QueryResult<SyncJobItem> GetJobItems(SyncJobItemQuery query);
|
|
|
|
/// <summary>
|
|
/// Gets the job.
|
|
/// </summary>
|
|
/// <param name="id">The identifier.</param>
|
|
/// <returns>SyncJob.</returns>
|
|
SyncJob GetJob(string id);
|
|
|
|
/// <summary>
|
|
/// Updates the job.
|
|
/// </summary>
|
|
/// <param name="job">The job.</param>
|
|
/// <returns>Task.</returns>
|
|
Task UpdateJob(SyncJob job);
|
|
|
|
/// <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);
|
|
|
|
/// <summary>
|
|
/// Cancels the job.
|
|
/// </summary>
|
|
/// <param name="id">The identifier.</param>
|
|
/// <returns>Task.</returns>
|
|
Task CancelJob(string id);
|
|
|
|
/// <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, string[] itemIds);
|
|
|
|
/// <summary>
|
|
/// Adds the parts.
|
|
/// </summary>
|
|
void AddParts(IEnumerable<ISyncProvider> providers);
|
|
|
|
/// <summary>
|
|
/// Gets the synchronize targets.
|
|
/// </summary>
|
|
List<SyncTarget> GetSyncTargets(string userId);
|
|
|
|
List<SyncTarget> GetSyncTargets(string userId, bool? supportsRemoteSync);
|
|
|
|
/// <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);
|
|
|
|
/// <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);
|
|
|
|
/// <summary>
|
|
/// Reports the offline action.
|
|
/// </summary>
|
|
/// <param name="action">The action.</param>
|
|
/// <returns>Task.</returns>
|
|
Task ReportOfflineAction(UserAction action);
|
|
|
|
/// <summary>
|
|
/// Gets the ready synchronize items.
|
|
/// </summary>
|
|
/// <param name="targetId">The target identifier.</param>
|
|
/// <returns>List<SyncedItem>.</returns>
|
|
Task<List<SyncedItem>> GetReadySyncItems(string targetId);
|
|
|
|
/// <summary>
|
|
/// Synchronizes the data.
|
|
/// </summary>
|
|
/// <param name="request">The request.</param>
|
|
/// <returns>Task<SyncDataResponse>.</returns>
|
|
Task<SyncDataResponse> SyncData(SyncDataRequest request);
|
|
|
|
/// <summary>
|
|
/// Gets the library item ids.
|
|
/// </summary>
|
|
/// <param name="query">The query.</param>
|
|
/// <returns>QueryResult<System.String>.</returns>
|
|
Dictionary<string, SyncedItemProgress> GetSyncedItemProgresses(SyncJobItemQuery query);
|
|
|
|
/// <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);
|
|
|
|
/// <summary>
|
|
/// Gets the quality options.
|
|
/// </summary>
|
|
/// <param name="targetId">The target identifier.</param>
|
|
List<SyncQualityOption> GetQualityOptions(string targetId);
|
|
/// <summary>
|
|
/// Gets the quality options.
|
|
/// </summary>
|
|
/// <param name="targetId">The target identifier.</param>
|
|
/// <param name="user">The user.</param>
|
|
List<SyncQualityOption> GetQualityOptions(string targetId, User user);
|
|
|
|
/// <summary>
|
|
/// Gets the profile options.
|
|
/// </summary>
|
|
/// <param name="targetId">The target identifier.</param>
|
|
List<SyncProfileOption> GetProfileOptions(string targetId);
|
|
/// <summary>
|
|
/// Gets the profile options.
|
|
/// </summary>
|
|
/// <param name="targetId">The target identifier.</param>
|
|
/// <param name="user">The user.</param>
|
|
List<SyncProfileOption> GetProfileOptions(string targetId, User user);
|
|
}
|
|
}
|