diff options
Diffstat (limited to 'MediaBrowser.Model/ApiClient/IApiClient.cs')
| -rw-r--r-- | MediaBrowser.Model/ApiClient/IApiClient.cs | 137 |
1 files changed, 111 insertions, 26 deletions
diff --git a/MediaBrowser.Model/ApiClient/IApiClient.cs b/MediaBrowser.Model/ApiClient/IApiClient.cs index 9faa8fced..ca49c6c5a 100644 --- a/MediaBrowser.Model/ApiClient/IApiClient.cs +++ b/MediaBrowser.Model/ApiClient/IApiClient.cs @@ -41,7 +41,7 @@ namespace MediaBrowser.Model.ApiClient /// Occurs when [authenticated]. /// </summary> event EventHandler<GenericEventArgs<AuthenticationResult>> Authenticated; - + /// <summary> /// Gets the API URL. /// </summary> @@ -201,7 +201,7 @@ namespace MediaBrowser.Model.ApiClient /// <param name="cancellationToken">The cancellation token.</param> /// <returns>Task<HttpResponse>.</returns> Task<HttpResponse> GetResponse(string url, CancellationToken cancellationToken = default(CancellationToken)); - + /// <summary> /// Updates the user configuration. /// </summary> @@ -225,7 +225,7 @@ namespace MediaBrowser.Model.ApiClient /// <param name="query">The query.</param> /// <returns>Task<QueryResult<BaseItemDto>>.</returns> Task<BaseItemDto[]> GetLatestItems(LatestItemsQuery query); - + /// <summary> /// Gets the intros async. /// </summary> @@ -324,7 +324,7 @@ namespace MediaBrowser.Model.ApiClient /// <param name="cancellationToken">The cancellation token.</param> /// <returns>Task<ItemsResult>.</returns> Task<ItemsResult> GetUserViews(string userId, CancellationToken cancellationToken = default(CancellationToken)); - + /// <summary> /// Gets the instant mix from song async. /// </summary> @@ -558,6 +558,13 @@ namespace MediaBrowser.Model.ApiClient Task<UserDto> GetUserAsync(string id); /// <summary> + /// Gets the offline user asynchronous. + /// </summary> + /// <param name="id">The identifier.</param> + /// <returns>Task<UserDto>.</returns> + Task<UserDto> GetOfflineUserAsync(string id); + + /// <summary> /// Gets the parental ratings async. /// </summary> /// <returns>Task{List{ParentalRating}}.</returns> @@ -754,7 +761,7 @@ namespace MediaBrowser.Model.ApiClient /// <param name="password">The password.</param> /// <returns>Task.</returns> /// <exception cref="ArgumentNullException">userId</exception> - Task<AuthenticationResult> AuthenticateUserAsync(string username, + Task<AuthenticationResult> AuthenticateUserAsync(string username, string password); /// <summary> @@ -867,7 +874,7 @@ namespace MediaBrowser.Model.ApiClient /// <param name="accessToken">The access token.</param> /// <param name="userId">The user identifier.</param> void SetAuthenticationInfo(string accessToken, string userId); - + /// <summary> /// Sets the authentication information. /// </summary> @@ -887,6 +894,35 @@ namespace MediaBrowser.Model.ApiClient void ChangeServerLocation(string address, bool keepExistingAuth = false); /// <summary> + /// Starts the receiving synchronize job updates. + /// </summary> + /// <param name="intervalMs">The interval ms.</param> + /// <param name="jobId">The job identifier.</param> + /// <returns>Task.</returns> + Task StartReceivingSyncJobUpdates(int intervalMs, string jobId); + + /// <summary> + /// Stops the receiving synchronize job updates. + /// </summary> + /// <returns>Task.</returns> + Task StopReceivingSyncJobUpdates(); + + /// <summary> + /// Starts the receiving synchronize jobs updates. + /// </summary> + /// <param name="intervalMs">The interval ms.</param> + /// <param name="userId">The user identifier.</param> + /// <param name="targetId">The target identifier.</param> + /// <returns>Task.</returns> + Task StartReceivingSyncJobsUpdates(int intervalMs, string userId, string targetId); + + /// <summary> + /// Stops the receiving synchronize jobs updates. + /// </summary> + /// <returns>Task.</returns> + Task StopReceivingSyncJobsUpdates(); + + /// <summary> /// Starts the receiving session updates. /// </summary> /// <param name="intervalMs">The interval ms.</param> @@ -898,7 +934,7 @@ namespace MediaBrowser.Model.ApiClient /// </summary> /// <returns>Task.</returns> Task StopReceivingSessionUpdates(); - + /// <summary> /// Gets the image URL. /// </summary> @@ -1317,24 +1353,6 @@ namespace MediaBrowser.Model.ApiClient Task<QueryResult<BaseItemDto>> GetPlaylistItems(PlaylistItemQuery query); /// <summary> - /// Gets the url needed to stream a video file - /// </summary> - /// <param name="options">The options.</param> - /// <returns>System.String.</returns> - /// <exception cref="ArgumentNullException">options</exception> - [Obsolete] - string GetVideoStreamUrl(VideoStreamOptions options); - - /// <summary> - /// Formulates a url for streaming video using the HLS protocol - /// </summary> - /// <param name="options">The options.</param> - /// <returns>System.String.</returns> - /// <exception cref="ArgumentNullException">options</exception> - [Obsolete] - string GetHlsVideoStreamUrl(VideoStreamOptions options); - - /// <summary> /// Sends the context message asynchronous. /// </summary> /// <param name="itemType">Type of the item.</param> @@ -1360,7 +1378,7 @@ namespace MediaBrowser.Model.ApiClient /// <param name="file">The file.</param> /// <param name="cancellationToken">The cancellation token.</param> /// <returns>Task.</returns> - Task UploadFile(Stream stream, + Task UploadFile(Stream stream, LocalFileInfo file, CancellationToken cancellationToken); @@ -1385,6 +1403,13 @@ namespace MediaBrowser.Model.ApiClient Task<SyncJob> CreateSyncJob(SyncJobRequest request); /// <summary> + /// Updates the synchronize job. + /// </summary> + /// <param name="job">The job.</param> + /// <returns>Task.</returns> + Task UpdateSyncJob(SyncJob job); + + /// <summary> /// Gets the synchronize jobs. /// </summary> /// <param name="query">The query.</param> @@ -1414,6 +1439,15 @@ namespace MediaBrowser.Model.ApiClient Task<Stream> GetSyncJobItemFile(string id, CancellationToken cancellationToken); /// <summary> + /// Gets the synchronize job item additional file. + /// </summary> + /// <param name="id">The identifier.</param> + /// <param name="name">The name.</param> + /// <param name="cancellationToken">The cancellation token.</param> + /// <returns>Task<Stream>.</returns> + Task<Stream> GetSyncJobItemAdditionalFile(string id, string name, CancellationToken cancellationToken); + + /// <summary> /// Opens the web socket. /// </summary> /// <param name="webSocketFactory">The web socket factory.</param> @@ -1440,5 +1474,56 @@ namespace MediaBrowser.Model.ApiClient /// <param name="request">The request.</param> /// <returns>Task<SyncDataResponse>.</returns> Task<SyncDataResponse> SyncData(SyncDataRequest request); + /// <summary> + /// Gets the synchronize job item file URL. + /// </summary> + /// <param name="id">The identifier.</param> + /// <returns>System.String.</returns> + string GetSyncJobItemFileUrl(string id); + /// <summary> + /// Marks the synchronize job item for removal. + /// </summary> + /// <param name="id">The identifier.</param> + /// <returns>Task.</returns> + Task MarkSyncJobItemForRemoval(string id); + /// <summary> + /// Unmarks the synchronize job item for removal. + /// </summary> + /// <param name="id">The identifier.</param> + /// <returns>Task.</returns> + Task UnmarkSyncJobItemForRemoval(string id); + /// <summary> + /// Queues the failed synchronize job item for retry. + /// </summary> + /// <param name="id">The identifier.</param> + /// <returns>Task.</returns> + Task QueueFailedSyncJobItemForRetry(string id); + /// <summary> + /// Cancels the synchronize job. + /// </summary> + /// <param name="id">The identifier.</param> + /// <returns>Task.</returns> + Task CancelSyncJob(string id); + /// <summary> + /// Cancels the synchronize job item. + /// </summary> + /// <param name="id">The identifier.</param> + /// <returns>Task.</returns> + Task CancelSyncJobItem(string id); + /// <summary> + /// Enables the cancelled synchronize job item. + /// </summary> + /// <param name="id">The identifier.</param> + /// <returns>Task.</returns> + Task EnableCancelledSyncJobItem(string id); + /// <summary> + /// Gets the synchronize options. + /// </summary> + /// <param name="userId">The user identifier.</param> + /// <param name="itemIds">The item ids.</param> + /// <param name="parentId">The parent identifier.</param> + /// <param name="category">The category.</param> + /// <returns>Task<SyncOptions>.</returns> + Task<SyncDialogOptions> GetSyncOptions(IEnumerable<string> itemIds, string userId, string parentId = null, SyncCategory? category = null); } }
\ No newline at end of file |