2014-05-31 17:13:07 +02:00
using MediaBrowser.Model.Channels ;
using MediaBrowser.Model.Configuration ;
2014-10-11 22:38:13 +02:00
using MediaBrowser.Model.Devices ;
2013-06-03 02:21:35 +02:00
using MediaBrowser.Model.Dto ;
using MediaBrowser.Model.Entities ;
2014-10-04 05:18:57 +02:00
using MediaBrowser.Model.Events ;
2013-06-03 02:21:35 +02:00
using MediaBrowser.Model.Globalization ;
2014-01-15 06:38:08 +01:00
using MediaBrowser.Model.LiveTv ;
2014-11-19 03:45:12 +01:00
using MediaBrowser.Model.MediaInfo ;
2014-12-26 18:45:06 +01:00
using MediaBrowser.Model.Net ;
2013-07-07 06:48:26 +02:00
using MediaBrowser.Model.Notifications ;
2014-08-21 17:55:35 +02:00
using MediaBrowser.Model.Playlists ;
2013-06-03 02:21:35 +02:00
using MediaBrowser.Model.Plugins ;
using MediaBrowser.Model.Querying ;
2013-08-07 21:15:55 +02:00
using MediaBrowser.Model.Search ;
2013-06-03 02:21:35 +02:00
using MediaBrowser.Model.Serialization ;
using MediaBrowser.Model.Session ;
2014-12-11 07:20:28 +01:00
using MediaBrowser.Model.Sync ;
2013-06-03 02:21:35 +02:00
using MediaBrowser.Model.System ;
using MediaBrowser.Model.Tasks ;
2013-07-27 17:48:35 +02:00
using MediaBrowser.Model.Users ;
2013-06-03 02:21:35 +02:00
using System ;
using System.Collections.Generic ;
using System.IO ;
2013-08-12 21:13:36 +02:00
using System.Threading ;
2013-06-03 02:21:35 +02:00
using System.Threading.Tasks ;
2013-06-03 02:27:31 +02:00
namespace MediaBrowser.Model.ApiClient
2013-06-03 02:21:35 +02:00
{
2013-09-11 19:54:59 +02:00
/// <summary>
/// Interface IApiClient
/// </summary>
2014-10-03 05:48:59 +02:00
public interface IApiClient : IServerEvents , IDisposable
2013-06-03 02:21:35 +02:00
{
2013-07-09 04:38:18 +02:00
/// <summary>
2014-10-04 05:18:57 +02:00
/// Occurs when [remote logged out].
2013-07-09 04:38:18 +02:00
/// </summary>
2014-10-29 00:17:55 +01:00
event EventHandler < GenericEventArgs < RemoteLogoutReason > > RemoteLoggedOut ;
2013-07-09 04:38:18 +02:00
2013-09-21 23:00:04 +02:00
/// <summary>
/// Gets the API URL.
/// </summary>
/// <param name="handler">The handler.</param>
/// <returns>System.String.</returns>
2013-09-11 19:54:59 +02:00
string GetApiUrl ( string handler ) ;
2013-09-21 23:00:04 +02:00
/// <summary>
/// Gets the game system summaries async.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{List{GameSystemSummary}}.</returns>
2014-08-07 08:18:48 +02:00
Task < List < GameSystemSummary > > GetGameSystemSummariesAsync ( CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2013-09-21 23:00:04 +02:00
2013-09-11 19:54:59 +02:00
/// <summary>
/// Gets the async.
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="url">The URL.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{``0}.</returns>
2014-08-07 08:18:48 +02:00
Task < T > GetAsync < T > ( string url , CancellationToken cancellationToken = default ( CancellationToken ) )
2013-09-11 19:54:59 +02:00
where T : class ;
2013-09-10 20:56:00 +02:00
2014-01-05 07:25:46 +01:00
/// <summary>
/// Reports the capabilities.
/// </summary>
/// <param name="capabilities">The capabilities.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
2014-08-07 08:18:48 +02:00
Task ReportCapabilities ( ClientCapabilities capabilities , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-01-05 07:25:46 +01:00
2014-07-13 06:55:56 +02:00
/// <summary>
/// Logouts this instance.
/// </summary>
/// <returns>Task.</returns>
Task Logout ( ) ;
2013-10-06 05:03:08 +02:00
/// <summary>
/// Gets the index of the game players.
/// </summary>
/// <param name="userId">The user id.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{List{ItemIndex}}.</returns>
2014-08-07 08:18:48 +02:00
Task < List < ItemIndex > > GetGamePlayerIndex ( string userId , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2013-10-06 05:03:08 +02:00
/// <summary>
/// Gets the index of the year.
/// </summary>
/// <param name="userId">The user id.</param>
/// <param name="includeItemTypes">The include item types.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{List{ItemIndex}}.</returns>
2014-08-07 08:18:48 +02:00
Task < List < ItemIndex > > GetYearIndex ( string userId , string [ ] includeItemTypes , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2013-10-09 03:54:56 +02:00
2013-07-21 16:20:57 +02:00
/// <summary>
/// Gets the critic reviews.
/// </summary>
/// <param name="itemId">The item id.</param>
2013-09-11 19:54:59 +02:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-07-21 16:20:57 +02:00
/// <param name="startIndex">The start index.</param>
/// <param name="limit">The limit.</param>
/// <returns>Task{ItemReviewsResult}.</returns>
2014-08-07 08:18:48 +02:00
Task < QueryResult < ItemReview > > GetCriticReviews ( string itemId , CancellationToken cancellationToken = default ( CancellationToken ) , int? startIndex = null , int? limit = null ) ;
2013-07-21 16:20:57 +02:00
2013-07-10 22:06:11 +02:00
/// <summary>
/// Gets the theme songs async.
/// </summary>
/// <param name="userId">The user id.</param>
/// <param name="itemId">The item id.</param>
/// <param name="inheritFromParents">if set to <c>true</c> [inherit from parents].</param>
2013-09-11 19:54:59 +02:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-07-10 22:06:11 +02:00
/// <returns>Task{ThemeMediaResult}.</returns>
2014-08-07 08:18:48 +02:00
Task < ThemeMediaResult > GetThemeSongsAsync ( string userId , string itemId , bool inheritFromParents , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2013-07-10 22:06:11 +02:00
2013-08-07 21:15:55 +02:00
/// <summary>
/// Gets the search hints async.
/// </summary>
2014-01-07 21:12:39 +01:00
/// <param name="query">The query.</param>
2013-08-07 21:15:55 +02:00
/// <returns>Task{SearchHintResult}.</returns>
2014-01-07 21:12:39 +01:00
Task < SearchHintResult > GetSearchHintsAsync ( SearchQuery query ) ;
2013-08-07 21:15:55 +02:00
2014-11-11 04:41:55 +01:00
/// <summary>
/// Gets the filters.
/// </summary>
/// <param name="userId">The user identifier.</param>
/// <param name="parentId">The parent identifier.</param>
/// <param name="mediaTypes">The media types.</param>
/// <param name="itemTypes">The item types.</param>
/// <returns>Task<QueryFilters>.</returns>
Task < QueryFilters > GetFilters ( string userId , string parentId , string [ ] mediaTypes , string [ ] itemTypes ) ;
2013-07-10 22:06:11 +02:00
/// <summary>
/// Gets the theme videos async.
/// </summary>
/// <param name="userId">The user id.</param>
/// <param name="itemId">The item id.</param>
/// <param name="inheritFromParents">if set to <c>true</c> [inherit from parents].</param>
2013-09-11 19:54:59 +02:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-07-10 22:06:11 +02:00
/// <returns>Task{ThemeMediaResult}.</returns>
2014-08-07 08:18:48 +02:00
Task < ThemeMediaResult > GetThemeVideosAsync ( string userId , string itemId , bool inheritFromParents , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2013-07-10 22:06:11 +02:00
/// <summary>
/// Gets all theme media async.
/// </summary>
/// <param name="userId">The user id.</param>
/// <param name="itemId">The item id.</param>
/// <param name="inheritFromParents">if set to <c>true</c> [inherit from parents].</param>
2013-09-11 19:54:59 +02:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-07-10 22:06:11 +02:00
/// <returns>Task{AllThemeMediaResult}.</returns>
2014-08-07 08:18:48 +02:00
Task < AllThemeMediaResult > GetAllThemeMediaAsync ( string userId , string itemId , bool inheritFromParents , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2013-07-21 16:20:57 +02:00
2013-07-07 06:48:26 +02:00
/// <summary>
/// Marks the notifications read.
/// </summary>
/// <param name="userId">The user id.</param>
/// <param name="notificationIdList">The notification id list.</param>
/// <param name="isRead">if set to <c>true</c> [is read].</param>
/// <returns>Task.</returns>
2014-05-08 22:09:53 +02:00
Task MarkNotificationsRead ( string userId , IEnumerable < string > notificationIdList , bool isRead ) ;
2013-07-07 06:48:26 +02:00
/// <summary>
/// Gets the notifications summary.
/// </summary>
/// <param name="userId">The user id.</param>
/// <returns>Task{NotificationsSummary}.</returns>
Task < NotificationsSummary > GetNotificationsSummary ( string userId ) ;
/// <summary>
2013-07-07 06:54:16 +02:00
/// Gets the notifications async.
2013-07-07 06:48:26 +02:00
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{NotificationResult}.</returns>
2013-07-07 06:54:16 +02:00
Task < NotificationResult > GetNotificationsAsync ( NotificationQuery query ) ;
2013-07-07 06:48:26 +02:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets an image stream based on a url
/// </summary>
/// <param name="url">The URL.</param>
2013-08-12 21:13:36 +02:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task{Stream}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">url</exception>
2014-08-07 08:18:48 +02:00
Task < Stream > GetImageStreamAsync ( string url , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2013-06-03 02:21:35 +02:00
2014-12-26 18:45:06 +01:00
/// <summary>
/// Gets the stream.
/// </summary>
/// <param name="url">The URL.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task<Stream>.</returns>
Task < Stream > GetStream ( string url , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
/// <summary>
/// Gets the response.
/// </summary>
/// <param name="url">The URL.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task<HttpResponse>.</returns>
Task < HttpResponse > GetResponse ( string url , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2015-02-07 04:25:23 +01:00
2014-12-19 05:20:07 +01:00
/// <summary>
/// Updates the user configuration.
/// </summary>
/// <param name="userId">The user identifier.</param>
/// <param name="configuration">The configuration.</param>
/// <returns>Task.</returns>
Task UpdateUserConfiguration ( string userId , UserConfiguration configuration ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets a BaseItem
/// </summary>
/// <param name="id">The id.</param>
/// <param name="userId">The user id.</param>
/// <returns>Task{BaseItemDto}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">id</exception>
2013-06-03 02:21:35 +02:00
Task < BaseItemDto > GetItemAsync ( string id , string userId ) ;
2014-08-14 15:24:30 +02:00
/// <summary>
/// Gets the latest items.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task<QueryResult<BaseItemDto>>.</returns>
2014-08-28 03:36:59 +02:00
Task < BaseItemDto [ ] > GetLatestItems ( LatestItemsQuery query ) ;
2015-02-07 04:25:23 +01:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets the intros async.
/// </summary>
/// <param name="itemId">The item id.</param>
/// <param name="userId">The user id.</param>
2013-10-04 19:04:18 +02:00
/// <returns>Task{ItemsResult}.</returns>
Task < ItemsResult > GetIntrosAsync ( string itemId , string userId ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets a BaseItem
/// </summary>
/// <param name="userId">The user id.</param>
/// <returns>Task{BaseItemDto}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-06-03 02:21:35 +02:00
Task < BaseItemDto > GetRootFolderAsync ( string userId ) ;
2014-05-27 23:17:48 +02:00
/// <summary>
/// Gets the additional parts.
/// </summary>
/// <param name="itemId">The item identifier.</param>
2014-07-01 23:13:32 +02:00
/// <param name="userId">The user identifier.</param>
2014-05-27 23:17:48 +02:00
/// <returns>Task{BaseItemDto[]}.</returns>
2014-06-01 21:41:35 +02:00
Task < ItemsResult > GetAdditionalParts ( string itemId , string userId ) ;
2014-07-28 00:01:29 +02:00
2014-11-19 03:45:12 +01:00
/// <summary>
2015-03-14 05:50:23 +01:00
/// Gets the playback information.
2014-11-19 03:45:12 +01:00
/// </summary>
2015-03-31 20:50:08 +02:00
/// <param name="request">The request.</param>
2014-11-19 03:45:12 +01:00
/// <returns>Task<LiveMediaInfoResult>.</returns>
2015-03-31 20:50:08 +02:00
Task < PlaybackInfoResponse > GetPlaybackInfo ( PlaybackInfoRequest request ) ;
2014-11-19 03:45:12 +01:00
2013-06-03 02:21:35 +02:00
/// <summary>
2013-06-03 04:17:13 +02:00
/// Gets the users async.
2013-06-03 02:21:35 +02:00
/// </summary>
2013-09-11 19:54:59 +02:00
/// <param name="query">The query.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task{UserDto[]}.</returns>
2013-07-09 20:37:41 +02:00
Task < UserDto [ ] > GetUsersAsync ( UserQuery query ) ;
2013-06-03 02:21:35 +02:00
2013-07-09 18:11:16 +02:00
/// <summary>
/// Gets the public users async.
/// </summary>
2013-09-11 19:54:59 +02:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-07-09 18:11:16 +02:00
/// <returns>Task{UserDto[]}.</returns>
2014-08-07 08:18:48 +02:00
Task < UserDto [ ] > GetPublicUsersAsync ( CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2013-07-21 16:20:57 +02:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets active client sessions.
/// </summary>
2013-09-21 23:00:04 +02:00
/// <param name="query">The query.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task{SessionInfoDto[]}.</returns>
2013-09-19 22:03:14 +02:00
Task < SessionInfoDto [ ] > GetClientSessionsAsync ( SessionQuery query ) ;
2013-06-03 02:21:35 +02:00
2014-07-01 23:13:32 +02:00
/// <summary>
/// Gets the client session asynchronous.
/// </summary>
/// <returns>Task{SessionInfoDto}.</returns>
2014-08-07 08:18:48 +02:00
Task < SessionInfoDto > GetCurrentSessionAsync ( CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-07-28 00:01:29 +02:00
2013-06-22 20:15:31 +02:00
/// <summary>
/// Gets the item counts async.
/// </summary>
2013-10-21 05:01:22 +02:00
/// <param name="query">The query.</param>
2013-06-22 20:15:31 +02:00
/// <returns>Task{ItemCounts}.</returns>
2013-10-21 05:01:22 +02:00
Task < ItemCounts > GetItemCountsAsync ( ItemCountsQuery query ) ;
2013-07-07 06:48:26 +02:00
2013-11-22 16:33:14 +01:00
/// <summary>
/// Gets the episodes asynchronous.
/// </summary>
/// <param name="query">The query.</param>
2014-08-01 02:37:06 +02:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-11-22 16:33:14 +01:00
/// <returns>Task{ItemsResult}.</returns>
2014-08-07 08:18:48 +02:00
Task < ItemsResult > GetEpisodesAsync ( EpisodeQuery query , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2013-11-28 19:27:29 +01:00
/// <summary>
/// Gets the seasons asynchronous.
/// </summary>
/// <param name="query">The query.</param>
2014-08-01 02:37:06 +02:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-11-28 19:27:29 +01:00
/// <returns>Task{ItemsResult}.</returns>
2014-08-07 08:18:48 +02:00
Task < ItemsResult > GetSeasonsAsync ( SeasonQuery query , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-03-13 10:18:32 +01:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Queries for items
/// </summary>
/// <param name="query">The query.</param>
2014-08-01 02:37:06 +02:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task{ItemsResult}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">query</exception>
2014-08-07 08:18:48 +02:00
Task < ItemsResult > GetItemsAsync ( ItemQuery query , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2013-06-03 02:21:35 +02:00
2014-08-01 04:58:37 +02:00
/// <summary>
/// Gets the user views.
/// </summary>
/// <param name="userId">The user identifier.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task<ItemsResult>.</returns>
2014-08-07 08:18:48 +02:00
Task < ItemsResult > GetUserViews ( string userId , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2015-02-07 04:25:23 +01:00
2013-08-10 03:16:31 +02:00
/// <summary>
/// Gets the instant mix from song async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
Task < ItemsResult > GetInstantMixFromSongAsync ( SimilarItemsQuery query ) ;
/// <summary>
/// Gets the instant mix from album async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
Task < ItemsResult > GetInstantMixFromAlbumAsync ( SimilarItemsQuery query ) ;
/// <summary>
/// Gets the instant mix from artist async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
2015-03-13 18:25:28 +01:00
Task < ItemsResult > GetInstantMixFromArtistAsync ( SimilarItemsQuery query ) ;
2013-08-10 03:16:31 +02:00
/// <summary>
/// Gets the instant mix from music genre async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
2015-03-13 18:25:28 +01:00
Task < ItemsResult > GetInstantMixFromMusicGenreAsync ( SimilarItemsQuery query ) ;
2013-08-21 22:08:42 +02:00
2013-06-04 04:02:49 +02:00
/// <summary>
/// Gets the similar movies async.
/// </summary>
/// <param name="query">The query.</param>
2014-08-01 02:37:06 +02:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-04 04:02:49 +02:00
/// <returns>Task{ItemsResult}.</returns>
2015-08-21 04:36:30 +02:00
Task < ItemsResult > GetSimilarItemsAsync ( SimilarItemsQuery query , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2013-07-07 06:48:26 +02:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets the people async.
/// </summary>
/// <param name="query">The query.</param>
2014-08-01 02:37:06 +02:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task{ItemsResult}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">userId</exception>
2014-08-07 08:18:48 +02:00
Task < ItemsResult > GetPeopleAsync ( PersonsQuery query , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets the artists.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-06-03 02:21:35 +02:00
Task < ItemsResult > GetArtistsAsync ( ArtistsQuery query ) ;
2014-06-23 18:05:19 +02:00
/// <summary>
/// Gets the album artists asynchronous.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
Task < ItemsResult > GetAlbumArtistsAsync ( ArtistsQuery query ) ;
2014-07-28 00:01:29 +02:00
2013-06-17 03:48:55 +02:00
/// <summary>
/// Gets the next up async.
/// </summary>
/// <param name="query">The query.</param>
2014-08-01 02:37:06 +02:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-17 03:48:55 +02:00
/// <returns>Task{ItemsResult}.</returns>
2014-08-07 08:18:48 +02:00
Task < ItemsResult > GetNextUpEpisodesAsync ( NextUpQuery query , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2013-07-07 06:48:26 +02:00
2014-03-06 06:23:06 +01:00
/// <summary>
/// Gets the upcoming episodes asynchronous.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
2014-12-03 04:13:03 +01:00
Task < ItemsResult > GetUpcomingEpisodesAsync ( UpcomingEpisodesQuery query ) ;
2014-03-13 10:18:32 +01:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets a genre
/// </summary>
/// <param name="name">The name.</param>
2013-07-27 19:18:10 +02:00
/// <param name="userId">The user id.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task{BaseItemDto}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-07-27 19:18:10 +02:00
Task < BaseItemDto > GetGenreAsync ( string name , string userId ) ;
2013-06-03 02:21:35 +02:00
2013-08-03 18:06:45 +02:00
/// <summary>
/// Gets the genres async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
Task < ItemsResult > GetGenresAsync ( ItemsByNameQuery query ) ;
/// <summary>
/// Gets the studios async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
Task < ItemsResult > GetStudiosAsync ( ItemsByNameQuery query ) ;
2013-08-21 22:08:42 +02:00
2013-07-27 20:24:48 +02:00
/// <summary>
/// Gets the music genre async.
/// </summary>
/// <param name="name">The name.</param>
/// <param name="userId">The user id.</param>
/// <returns>Task{BaseItemDto}.</returns>
Task < BaseItemDto > GetMusicGenreAsync ( string name , string userId ) ;
/// <summary>
/// Gets the game genre async.
/// </summary>
/// <param name="name">The name.</param>
/// <param name="userId">The user id.</param>
/// <returns>Task{BaseItemDto}.</returns>
Task < BaseItemDto > GetGameGenreAsync ( string name , string userId ) ;
2013-08-21 22:08:42 +02:00
2013-06-03 02:21:35 +02:00
/// <summary>
2013-07-07 17:55:05 +02:00
/// Restarts the server.
2013-06-03 02:21:35 +02:00
/// </summary>
/// <returns>Task.</returns>
2013-07-07 17:55:05 +02:00
Task RestartServerAsync ( ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets the system status async.
/// </summary>
2014-06-01 21:41:35 +02:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task{SystemInfo}.</returns>
2014-08-07 08:18:48 +02:00
Task < SystemInfo > GetSystemInfoAsync ( CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2013-06-03 02:21:35 +02:00
2014-07-28 00:01:29 +02:00
/// <summary>
/// Gets the public system information asynchronous.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task<PublicSystemInfo>.</returns>
2014-08-07 08:18:48 +02:00
Task < PublicSystemInfo > GetPublicSystemInfoAsync ( CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets a list of plugins installed on the server
/// </summary>
/// <returns>Task{PluginInfo[]}.</returns>
Task < PluginInfo [ ] > GetInstalledPluginsAsync ( ) ;
/// <summary>
/// Gets the current server configuration
/// </summary>
/// <returns>Task{ServerConfiguration}.</returns>
Task < ServerConfiguration > GetServerConfigurationAsync ( ) ;
/// <summary>
/// Gets the scheduled tasks.
/// </summary>
/// <returns>Task{TaskInfo[]}.</returns>
Task < TaskInfo [ ] > GetScheduledTasksAsync ( ) ;
/// <summary>
/// Gets the scheduled task async.
/// </summary>
/// <param name="id">The id.</param>
/// <returns>Task{TaskInfo}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">id</exception>
2014-05-08 22:09:53 +02:00
Task < TaskInfo > GetScheduledTaskAsync ( string id ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets a user by id
/// </summary>
/// <param name="id">The id.</param>
/// <returns>Task{UserDto}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">id</exception>
2013-06-03 02:21:35 +02:00
Task < UserDto > GetUserAsync ( string id ) ;
2015-01-30 06:18:32 +01:00
/// <summary>
/// Gets the offline user asynchronous.
/// </summary>
/// <param name="id">The identifier.</param>
/// <returns>Task<UserDto>.</returns>
Task < UserDto > GetOfflineUserAsync ( string id ) ;
2015-02-07 04:25:23 +01:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets the parental ratings async.
/// </summary>
/// <returns>Task{List{ParentalRating}}.</returns>
Task < List < ParentalRating > > GetParentalRatingsAsync ( ) ;
/// <summary>
/// Gets local trailers for an item
/// </summary>
/// <param name="userId">The user id.</param>
/// <param name="itemId">The item id.</param>
/// <returns>Task{ItemsResult}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">query</exception>
2013-06-03 02:21:35 +02:00
Task < BaseItemDto [ ] > GetLocalTrailersAsync ( string userId , string itemId ) ;
/// <summary>
/// Gets special features for an item
/// </summary>
/// <param name="userId">The user id.</param>
/// <param name="itemId">The item id.</param>
/// <returns>Task{BaseItemDto[]}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-06-03 02:21:35 +02:00
Task < BaseItemDto [ ] > GetSpecialFeaturesAsync ( string userId , string itemId ) ;
/// <summary>
/// Gets the cultures async.
/// </summary>
/// <returns>Task{CultureDto[]}.</returns>
Task < CultureDto [ ] > GetCulturesAsync ( ) ;
/// <summary>
/// Gets the countries async.
/// </summary>
/// <returns>Task{CountryInfo[]}.</returns>
Task < CountryInfo [ ] > GetCountriesAsync ( ) ;
/// <summary>
2013-09-21 21:24:50 +02:00
/// Marks the played async.
2013-06-03 02:21:35 +02:00
/// </summary>
/// <param name="itemId">The item id.</param>
/// <param name="userId">The user id.</param>
2013-09-21 21:24:50 +02:00
/// <param name="datePlayed">The date played.</param>
/// <returns>Task{UserItemDataDto}.</returns>
Task < UserItemDataDto > MarkPlayedAsync ( string itemId , string userId , DateTime ? datePlayed ) ;
2013-06-03 02:21:35 +02:00
2013-09-21 21:24:50 +02:00
/// <summary>
/// Marks the unplayed async.
/// </summary>
/// <param name="itemId">The item id.</param>
/// <param name="userId">The user id.</param>
/// <returns>Task{UserItemDataDto}.</returns>
Task < UserItemDataDto > MarkUnplayedAsync ( string itemId , string userId ) ;
2013-09-21 23:00:04 +02:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Updates the favorite status async.
/// </summary>
/// <param name="itemId">The item id.</param>
/// <param name="userId">The user id.</param>
/// <param name="isFavorite">if set to <c>true</c> [is favorite].</param>
/// <returns>Task.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">itemId</exception>
2013-08-22 23:56:19 +02:00
Task < UserItemDataDto > UpdateFavoriteStatusAsync ( string itemId , string userId , bool isFavorite ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Reports to the server that the user has begun playing an item
/// </summary>
2014-03-22 04:35:03 +01:00
/// <param name="info">The information.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task{UserItemDataDto}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">itemId</exception>
2014-03-22 04:35:03 +01:00
Task ReportPlaybackStartAsync ( PlaybackStartInfo info ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Reports playback progress to the server
/// </summary>
2014-03-22 04:35:03 +01:00
/// <param name="info">The information.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task{UserItemDataDto}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">itemId</exception>
2014-03-22 04:35:03 +01:00
Task ReportPlaybackProgressAsync ( PlaybackProgressInfo info ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Reports to the server that the user has stopped playing an item
/// </summary>
2014-03-22 04:35:03 +01:00
/// <param name="info">The information.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task{UserItemDataDto}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">itemId</exception>
2014-03-22 04:35:03 +01:00
Task ReportPlaybackStoppedAsync ( PlaybackStopInfo info ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
2014-08-11 00:13:17 +02:00
/// Instructs another client to browse to a library item.
2013-06-03 02:21:35 +02:00
/// </summary>
/// <param name="sessionId">The session id.</param>
/// <param name="itemId">The id of the item to browse to.</param>
/// <param name="itemName">The name of the item to browse to.</param>
/// <param name="itemType">The type of the item to browse to.</param>
/// <returns>Task.</returns>
2014-04-30 17:07:02 +02:00
Task SendBrowseCommandAsync ( string sessionId , string itemId , string itemName , string itemType ) ;
2013-06-03 02:21:35 +02:00
2013-07-09 18:11:16 +02:00
/// <summary>
/// Sends the playstate command async.
/// </summary>
2014-03-13 10:18:32 +01:00
/// <param name="sessionId">The session id.</param>
2013-07-09 18:11:16 +02:00
/// <param name="request">The request.</param>
/// <returns>Task.</returns>
2013-07-09 18:16:52 +02:00
Task SendPlaystateCommandAsync ( string sessionId , PlaystateRequest request ) ;
2013-07-09 18:11:16 +02:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Sends the play command async.
/// </summary>
/// <param name="sessionId">The session id.</param>
/// <param name="request">The request.</param>
/// <returns>Task.</returns>
2013-09-11 19:54:59 +02:00
/// <exception cref="ArgumentNullException">sessionId
2013-06-03 02:21:35 +02:00
/// or
2013-09-11 19:54:59 +02:00
/// request</exception>
2013-06-03 02:21:35 +02:00
Task SendPlayCommandAsync ( string sessionId , PlayRequest request ) ;
2014-03-28 21:36:29 +01:00
/// <summary>
/// Sends the command asynchronous.
/// </summary>
/// <param name="sessionId">The session identifier.</param>
2013-09-11 19:54:59 +02:00
/// <param name="command">The command.</param>
/// <returns>Task.</returns>
2014-03-31 23:04:22 +02:00
Task SendCommandAsync ( string sessionId , GeneralCommand command ) ;
2013-08-28 06:42:56 +02:00
2014-05-08 22:09:53 +02:00
/// <summary>
/// Sends the string.
/// </summary>
/// <param name="sessionId">The session identifier.</param>
/// <param name="text">The text.</param>
/// <returns>Task.</returns>
Task SendString ( string sessionId , string text ) ;
/// <summary>
/// Sets the volume.
/// </summary>
/// <param name="sessionId">The session identifier.</param>
/// <param name="volume">The volume.</param>
/// <returns>Task.</returns>
Task SetVolume ( string sessionId , int volume ) ;
2014-07-08 03:41:03 +02:00
/// <summary>
/// Stops the transcoding processes.
/// </summary>
/// <param name="deviceId">The device identifier.</param>
2015-03-20 21:06:04 +01:00
/// <param name="streamId">The stream identifier.</param>
2014-07-08 03:41:03 +02:00
/// <returns>Task.</returns>
2015-03-20 21:06:04 +01:00
Task StopTranscodingProcesses ( string deviceId , string streamId ) ;
2014-07-08 03:41:03 +02:00
2014-05-08 22:09:53 +02:00
/// <summary>
/// Sets the index of the audio stream.
/// </summary>
/// <param name="sessionId">The session identifier.</param>
2014-05-09 03:49:12 +02:00
/// <param name="index">The index.</param>
2014-05-08 22:09:53 +02:00
/// <returns>Task.</returns>
2014-05-09 03:49:12 +02:00
Task SetAudioStreamIndex ( string sessionId , int index ) ;
2014-05-08 22:09:53 +02:00
/// <summary>
/// Sets the index of the subtitle stream.
/// </summary>
/// <param name="sessionId">The session identifier.</param>
2014-05-09 03:49:12 +02:00
/// <param name="index">The index.</param>
2014-05-08 22:09:53 +02:00
/// <returns>Task.</returns>
2014-05-09 03:49:12 +02:00
Task SetSubtitleStreamIndex ( string sessionId , int? index ) ;
2014-07-28 00:01:29 +02:00
2013-08-28 06:42:56 +02:00
/// <summary>
/// Instructs the client to display a message to the user
/// </summary>
2013-09-11 19:54:59 +02:00
/// <param name="sessionId">The session id.</param>
/// <param name="command">The command.</param>
/// <returns>Task.</returns>
2013-08-28 06:42:56 +02:00
Task SendMessageCommandAsync ( string sessionId , MessageCommand command ) ;
2013-09-11 19:54:59 +02:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Clears a user's rating for an item
/// </summary>
/// <param name="itemId">The item id.</param>
/// <param name="userId">The user id.</param>
/// <returns>Task{UserItemDataDto}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">itemId</exception>
2013-08-22 23:56:19 +02:00
Task < UserItemDataDto > ClearUserItemRatingAsync ( string itemId , string userId ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Updates a user's rating for an item, based on likes or dislikes
/// </summary>
/// <param name="itemId">The item id.</param>
/// <param name="userId">The user id.</param>
/// <param name="likes">if set to <c>true</c> [likes].</param>
/// <returns>Task.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">itemId</exception>
2013-08-22 23:56:19 +02:00
Task < UserItemDataDto > UpdateUserItemRatingAsync ( string itemId , string userId , bool likes ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Authenticates a user and returns the result
/// </summary>
2013-07-27 17:40:53 +02:00
/// <param name="username">The username.</param>
2014-10-15 02:05:09 +02:00
/// <param name="password">The password.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">userId</exception>
2015-02-07 04:25:23 +01:00
Task < AuthenticationResult > AuthenticateUserAsync ( string username ,
2014-10-27 04:06:01 +01:00
string password ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Updates the server configuration async.
/// </summary>
/// <param name="configuration">The configuration.</param>
/// <returns>Task.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">configuration</exception>
2013-06-03 02:21:35 +02:00
Task UpdateServerConfigurationAsync ( ServerConfiguration configuration ) ;
/// <summary>
/// Updates the scheduled task triggers.
/// </summary>
/// <param name="id">The id.</param>
/// <param name="triggers">The triggers.</param>
/// <returns>Task{RequestResult}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">id</exception>
2014-05-08 22:09:53 +02:00
Task UpdateScheduledTaskTriggersAsync ( string id , TaskTriggerInfo [ ] triggers ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets the display preferences.
/// </summary>
/// <param name="id">The id.</param>
2013-07-27 03:15:55 +02:00
/// <param name="userId">The user id.</param>
/// <param name="client">The client.</param>
2013-09-11 19:54:59 +02:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task{BaseItemDto}.</returns>
2014-08-07 08:18:48 +02:00
Task < DisplayPreferences > GetDisplayPreferencesAsync ( string id , string userId , string client , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Updates display preferences for a user
/// </summary>
/// <param name="displayPreferences">The display preferences.</param>
2013-09-11 19:54:59 +02:00
/// <param name="userId">The user id.</param>
/// <param name="client">The client.</param>
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task{DisplayPreferences}.</returns>
/// <exception cref="System.ArgumentNullException">userId</exception>
2014-08-07 08:18:48 +02:00
Task UpdateDisplayPreferencesAsync ( DisplayPreferences displayPreferences , string userId , string client , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Posts a set of data to a url, and deserializes the return stream into T
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="url">The URL.</param>
/// <param name="args">The args.</param>
2014-01-07 21:12:39 +01:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task{``0}.</returns>
2014-08-07 08:18:48 +02:00
Task < T > PostAsync < T > ( string url , Dictionary < string , string > args , CancellationToken cancellationToken = default ( CancellationToken ) )
2013-06-03 02:21:35 +02:00
where T : class ;
/// <summary>
/// This is a helper around getting a stream from the server that contains serialized data
/// </summary>
/// <param name="url">The URL.</param>
/// <returns>Task{Stream}.</returns>
Task < Stream > GetSerializedStreamAsync ( string url ) ;
/// <summary>
/// Gets the json serializer.
/// </summary>
/// <value>The json serializer.</value>
IJsonSerializer JsonSerializer { get ; set ; }
/// <summary>
2014-07-28 00:01:29 +02:00
/// Gets or sets the server address
2013-06-03 02:21:35 +02:00
/// </summary>
2014-07-28 00:01:29 +02:00
/// <value>The server address.</value>
string ServerAddress { get ; }
2013-10-09 03:54:56 +02:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets or sets the type of the client.
/// </summary>
/// <value>The type of the client.</value>
string ClientName { get ; set ; }
2014-10-11 22:38:13 +02:00
/// <summary>
/// Gets the device.
/// </summary>
/// <value>The device.</value>
IDevice Device { get ; }
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets or sets the name of the device.
/// </summary>
/// <value>The name of the device.</value>
2014-10-11 22:38:13 +02:00
string DeviceName { get ; }
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets or sets the device id.
/// </summary>
/// <value>The device id.</value>
2014-10-11 22:38:13 +02:00
string DeviceId { get ; }
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets or sets the current user id.
/// </summary>
/// <value>The current user id.</value>
2014-07-28 00:01:29 +02:00
string CurrentUserId { get ; }
/// <summary>
/// Gets the access token.
/// </summary>
/// <value>The access token.</value>
string AccessToken { get ; }
/// <summary>
/// Sets the authentication information.
/// </summary>
/// <param name="accessToken">The access token.</param>
/// <param name="userId">The user identifier.</param>
void SetAuthenticationInfo ( string accessToken , string userId ) ;
2015-02-07 04:25:23 +01:00
2014-07-28 00:01:29 +02:00
/// <summary>
/// Sets the authentication information.
/// </summary>
/// <param name="accessToken">The access token.</param>
void SetAuthenticationInfo ( string accessToken ) ;
/// <summary>
/// Clears the authentication information.
/// </summary>
void ClearAuthenticationInfo ( ) ;
2013-06-03 02:21:35 +02:00
2014-10-07 05:03:38 +02:00
/// <summary>
/// Changes the server location.
/// </summary>
/// <param name="address">The address.</param>
/// <param name="keepExistingAuth">if set to <c>true</c> [keep existing authentication].</param>
void ChangeServerLocation ( string address , bool keepExistingAuth = false ) ;
2015-02-05 04:01:37 +01:00
/// <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>
2015-02-05 22:14:08 +01:00
Task StopReceivingSyncJobUpdates ( ) ;
2015-02-05 04:01:37 +01:00
2015-02-04 21:16:23 +01:00
/// <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>
2015-02-05 22:14:08 +01:00
Task StopReceivingSyncJobsUpdates ( ) ;
2015-02-07 04:25:23 +01:00
2014-10-07 05:03:38 +02:00
/// <summary>
/// Starts the receiving session updates.
/// </summary>
/// <param name="intervalMs">The interval ms.</param>
/// <returns>Task.</returns>
Task StartReceivingSessionUpdates ( int intervalMs ) ;
/// <summary>
/// Stops the receiving session updates.
/// </summary>
/// <returns>Task.</returns>
Task StopReceivingSessionUpdates ( ) ;
2015-02-07 04:25:23 +01:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets the image URL.
/// </summary>
/// <param name="item">The item.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">item</exception>
2013-06-03 02:21:35 +02:00
string GetImageUrl ( BaseItemDto item , ImageOptions options ) ;
2014-01-15 06:38:08 +01:00
/// <summary>
/// Gets the image URL.
/// </summary>
/// <param name="item">The item.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
string GetImageUrl ( ChannelInfoDto item , ImageOptions options ) ;
2014-04-13 19:27:13 +02:00
/// <summary>
/// Gets the subtitle URL.
/// </summary>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2014-05-07 04:28:19 +02:00
string GetSubtitleUrl ( SubtitleDownloadOptions options ) ;
2014-07-28 00:01:29 +02:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets an image url that can be used to download an image from the api
/// </summary>
/// <param name="itemId">The Id of the item</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">itemId</exception>
2013-06-03 02:21:35 +02:00
string GetImageUrl ( string itemId , ImageOptions options ) ;
/// <summary>
/// Gets the user image URL.
/// </summary>
/// <param name="user">The user.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">user</exception>
2013-06-03 02:21:35 +02:00
string GetUserImageUrl ( UserDto user , ImageOptions options ) ;
/// <summary>
/// Gets an image url that can be used to download an image from the api
/// </summary>
/// <param name="userId">The Id of the user</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-06-03 02:21:35 +02:00
string GetUserImageUrl ( string userId , ImageOptions options ) ;
/// <summary>
/// Gets the person image URL.
/// </summary>
/// <param name="item">The item.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">item</exception>
2013-06-03 02:21:35 +02:00
string GetPersonImageUrl ( BaseItemPerson item , ImageOptions options ) ;
/// <summary>
/// Gets an image url that can be used to download an image from the api
/// </summary>
/// <param name="name">The name.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">name</exception>
2013-06-03 02:21:35 +02:00
string GetGenreImageUrl ( string name , ImageOptions options ) ;
/// <summary>
2013-07-29 22:44:49 +02:00
/// Gets the music genre image URL.
2013-06-03 02:21:35 +02:00
/// </summary>
2013-07-29 22:44:49 +02:00
/// <param name="name">The name.</param>
2013-06-03 02:21:35 +02:00
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-07-29 22:44:49 +02:00
string GetMusicGenreImageUrl ( string name , ImageOptions options ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
2013-07-29 22:44:49 +02:00
/// Gets the game genre image URL.
2013-06-03 02:21:35 +02:00
/// </summary>
/// <param name="name">The name.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-07-29 22:44:49 +02:00
string GetGameGenreImageUrl ( string name , ImageOptions options ) ;
2013-08-21 22:08:42 +02:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// This is a helper to get a list of backdrop url's from a given ApiBaseItemWrapper. If the actual item does not have any backdrops it will return backdrops from the first parent that does.
/// </summary>
/// <param name="item">A given item.</param>
/// <param name="options">The options.</param>
/// <returns>System.String[][].</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">item</exception>
2013-06-03 02:21:35 +02:00
string [ ] GetBackdropImageUrls ( BaseItemDto item , ImageOptions options ) ;
/// <summary>
/// This is a helper to get the logo image url from a given ApiBaseItemWrapper. If the actual item does not have a logo, it will return the logo from the first parent that does, or null.
/// </summary>
/// <param name="item">A given item.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">item</exception>
2013-06-03 02:21:35 +02:00
string GetLogoImageUrl ( BaseItemDto item , ImageOptions options ) ;
2013-07-08 21:31:45 +02:00
/// <summary>
/// Gets the art image URL.
/// </summary>
/// <param name="item">The item.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
string GetArtImageUrl ( BaseItemDto item , ImageOptions options ) ;
2013-07-21 16:20:57 +02:00
2013-10-24 19:49:24 +02:00
/// <summary>
/// Gets the thumb image URL.
/// </summary>
/// <param name="item">The item.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
string GetThumbImageUrl ( BaseItemDto item , ImageOptions options ) ;
2014-03-13 10:18:32 +01:00
2014-01-15 06:38:08 +01:00
/// <summary>
/// Gets the live tv information asynchronous.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{LiveTvInfo}.</returns>
2014-08-07 08:18:48 +02:00
Task < LiveTvInfo > GetLiveTvInfoAsync ( CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-01-15 06:38:08 +01:00
/// <summary>
/// Gets the live tv channels asynchronous.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{LiveTvInfo}.</returns>
2014-08-07 08:18:48 +02:00
Task < QueryResult < ChannelInfoDto > > GetLiveTvChannelsAsync ( LiveTvChannelQuery query , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-01-15 06:38:08 +01:00
2014-01-16 18:23:30 +01:00
/// <summary>
/// Gets the live tv channel asynchronous.
/// </summary>
/// <param name="id">The identifier.</param>
/// <param name="userId">The user identifier.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{ChannelInfoDto}.</returns>
2014-08-07 08:18:48 +02:00
Task < ChannelInfoDto > GetLiveTvChannelAsync ( string id , string userId , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-03-13 10:18:32 +01:00
2014-01-15 06:38:08 +01:00
/// <summary>
/// Gets the live tv recordings asynchronous.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{QueryResult{RecordingInfoDto}}.</returns>
2015-05-31 20:22:51 +02:00
Task < QueryResult < BaseItemDto > > GetLiveTvRecordingsAsync ( RecordingQuery query , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-01-15 06:38:08 +01:00
2014-01-16 18:23:30 +01:00
/// <summary>
/// Gets the live tv recording asynchronous.
/// </summary>
/// <param name="id">The identifier.</param>
/// <param name="userId">The user identifier.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{RecordingInfoDto}.</returns>
2015-05-31 20:22:51 +02:00
Task < BaseItemDto > GetLiveTvRecordingAsync ( string id , string userId , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-03-13 10:18:32 +01:00
2014-01-15 06:38:08 +01:00
/// <summary>
/// Gets the live tv recording groups asynchronous.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{QueryResult{RecordingGroupDto}}.</returns>
2015-05-31 20:22:51 +02:00
Task < QueryResult < BaseItemDto > > GetLiveTvRecordingGroupsAsync ( RecordingGroupQuery query , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-01-16 18:23:30 +01:00
/// <summary>
/// Gets the live tv recording group asynchronous.
/// </summary>
/// <param name="id">The identifier.</param>
/// <param name="userId">The user identifier.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{RecordingGroupDto}.</returns>
2015-05-31 20:22:51 +02:00
Task < BaseItemDto > GetLiveTvRecordingGroupAsync ( string id , string userId , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-03-13 10:18:32 +01:00
2014-01-16 18:23:30 +01:00
/// <summary>
/// Gets the live tv timers asynchronous.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{QueryResult{TimerInfoDto}}.</returns>
2014-08-07 08:18:48 +02:00
Task < QueryResult < TimerInfoDto > > GetLiveTvTimersAsync ( TimerQuery query , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-01-16 18:23:30 +01:00
2014-01-17 19:23:00 +01:00
/// <summary>
/// Gets the live tv programs asynchronous.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{QueryResult{ProgramInfoDto}}.</returns>
2015-05-31 21:12:58 +02:00
Task < QueryResult < BaseItemDto > > GetLiveTvProgramsAsync ( ProgramQuery query , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-01-17 21:51:29 +01:00
2014-03-08 19:17:05 +01:00
/// <summary>
/// Gets the live tv program asynchronous.
/// </summary>
/// <param name="id">The identifier.</param>
/// <param name="userId">The user identifier.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{ProgramInfoDto}.</returns>
2015-05-31 21:12:58 +02:00
Task < BaseItemDto > GetLiveTvProgramAsync ( string id , string userId , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-03-08 19:17:05 +01:00
2014-01-17 21:51:29 +01:00
/// <summary>
/// Gets the recommended live tv programs asynchronous.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{QueryResult{ProgramInfoDto}}.</returns>
2015-05-31 21:12:58 +02:00
Task < QueryResult < BaseItemDto > > GetRecommendedLiveTvProgramsAsync ( RecommendedProgramQuery query , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-03-08 19:17:05 +01:00
/// <summary>
/// Creates the live tv timer asynchronous.
/// </summary>
/// <param name="timer">The timer.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
2014-08-07 08:18:48 +02:00
Task CreateLiveTvTimerAsync ( BaseTimerInfoDto timer , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-03-08 19:17:05 +01:00
/// <summary>
/// Updates the live tv timer asynchronous.
/// </summary>
/// <param name="timer">The timer.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
2014-08-07 08:18:48 +02:00
Task UpdateLiveTvTimerAsync ( TimerInfoDto timer , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-03-08 19:17:05 +01:00
/// <summary>
/// Creates the live tv series timer asynchronous.
/// </summary>
/// <param name="timer">The timer.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
2014-08-07 08:18:48 +02:00
Task CreateLiveTvSeriesTimerAsync ( SeriesTimerInfoDto timer , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-03-08 19:17:05 +01:00
/// <summary>
/// Updates the live tv series timer asynchronous.
/// </summary>
/// <param name="timer">The timer.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
2014-08-07 08:18:48 +02:00
Task UpdateLiveTvSeriesTimerAsync ( SeriesTimerInfoDto timer , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-03-13 10:18:32 +01:00
2014-01-16 18:23:30 +01:00
/// <summary>
/// Gets the live tv timer asynchronous.
/// </summary>
/// <param name="id">The identifier.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{TimerInfoDto}.</returns>
2014-08-07 08:18:48 +02:00
Task < TimerInfoDto > GetLiveTvTimerAsync ( string id , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-03-13 10:18:32 +01:00
2014-01-16 18:23:30 +01:00
/// <summary>
/// Gets the live tv series timers asynchronous.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{QueryResult{SeriesTimerInfoDto}}.</returns>
2014-08-07 08:18:48 +02:00
Task < QueryResult < SeriesTimerInfoDto > > GetLiveTvSeriesTimersAsync ( SeriesTimerQuery query , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-01-16 18:23:30 +01:00
/// <summary>
/// Gets the live tv series timer asynchronous.
/// </summary>
/// <param name="id">The identifier.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{SeriesTimerInfoDto}.</returns>
2014-08-07 08:18:48 +02:00
Task < SeriesTimerInfoDto > GetLiveTvSeriesTimerAsync ( string id , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-01-16 18:23:30 +01:00
/// <summary>
/// Cancels the live tv timer asynchronous.
/// </summary>
/// <param name="id">The identifier.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
2014-08-07 08:18:48 +02:00
Task CancelLiveTvTimerAsync ( string id , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-01-16 18:23:30 +01:00
/// <summary>
/// Cancels the live tv series timer asynchronous.
/// </summary>
/// <param name="id">The identifier.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
2014-08-07 08:18:48 +02:00
Task CancelLiveTvSeriesTimerAsync ( string id , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-03-13 10:18:32 +01:00
2014-03-08 19:17:05 +01:00
/// <summary>
/// Gets the default timer information.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{SeriesTimerInfoDto}.</returns>
2014-08-07 08:18:48 +02:00
Task < SeriesTimerInfoDto > GetDefaultLiveTvTimerInfo ( CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-03-08 19:17:05 +01:00
/// <summary>
/// Gets the live tv guide information.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{GuideInfo}.</returns>
2014-08-07 08:18:48 +02:00
Task < GuideInfo > GetLiveTvGuideInfo ( CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-03-13 10:18:32 +01:00
2014-03-08 19:17:05 +01:00
/// <summary>
/// Gets the default timer information.
/// </summary>
/// <param name="programId">The program identifier.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{SeriesTimerInfoDto}.</returns>
2014-08-07 08:18:48 +02:00
Task < SeriesTimerInfoDto > GetDefaultLiveTvTimerInfo ( string programId , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-05-31 17:13:07 +02:00
/// <summary>
/// Gets the channel features.
/// </summary>
/// <param name="channelId">The channel identifier.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{ChannelFeatures}.</returns>
2014-08-07 08:18:48 +02:00
Task < ChannelFeatures > GetChannelFeatures ( string channelId , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-05-31 17:13:07 +02:00
/// <summary>
/// Gets the channel items.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{QueryResult{BaseItemDto}}.</returns>
2014-08-07 08:18:48 +02:00
Task < QueryResult < BaseItemDto > > GetChannelItems ( ChannelItemQuery query , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-05-31 17:13:07 +02:00
/// <summary>
/// Gets the channels.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{QueryResult{BaseItemDto}}.</returns>
2014-08-07 08:18:48 +02:00
Task < QueryResult < BaseItemDto > > GetChannels ( ChannelQuery query , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-07-08 03:41:03 +02:00
/// <summary>
/// Gets the latest channel items.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{QueryResult{BaseItemDto}}.</returns>
2014-08-07 08:18:48 +02:00
Task < QueryResult < BaseItemDto > > GetLatestChannelItems ( AllChannelMediaQuery query , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-08-21 17:55:35 +02:00
/// <summary>
/// Creates the playlist.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Task<PlaylistCreationResult>.</returns>
Task < PlaylistCreationResult > CreatePlaylist ( PlaylistCreationRequest request ) ;
/// <summary>
/// Adds to playlist.
/// </summary>
/// <param name="playlistId">The playlist identifier.</param>
/// <param name="itemIds">The item ids.</param>
2014-08-22 04:24:38 +02:00
/// <param name="userId">The user identifier.</param>
2014-08-21 17:55:35 +02:00
/// <returns>Task.</returns>
2014-08-22 04:24:38 +02:00
Task AddToPlaylist ( string playlistId , IEnumerable < string > itemIds , string userId ) ;
2014-08-21 17:55:35 +02:00
/// <summary>
/// Removes from playlist.
/// </summary>
/// <param name="playlistId">The playlist identifier.</param>
/// <param name="entryIds">The entry ids.</param>
/// <returns>Task.</returns>
Task RemoveFromPlaylist ( string playlistId , IEnumerable < string > entryIds ) ;
/// <summary>
/// Gets the playlist items.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task<QueryResult<BaseItemDto>>.</returns>
Task < QueryResult < BaseItemDto > > GetPlaylistItems ( PlaylistItemQuery query ) ;
2014-09-06 06:21:23 +02:00
2014-10-03 05:48:59 +02:00
/// <summary>
/// Sends the context message asynchronous.
/// </summary>
/// <param name="itemType">Type of the item.</param>
/// <param name="itemId">The item identifier.</param>
/// <param name="itemName">Name of the item.</param>
/// <param name="context">The context.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
Task SendContextMessageAsync ( string itemType , string itemId , string itemName , string context ,
2015-03-14 17:50:11 +01:00
CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-10-11 22:38:13 +02:00
/// <summary>
/// Gets the content upload history.
/// </summary>
/// <param name="deviceId">The device identifier.</param>
/// <returns>Task<ContentUploadHistory>.</returns>
Task < ContentUploadHistory > GetContentUploadHistory ( string deviceId ) ;
/// <summary>
/// Uploads the file.
/// </summary>
/// <param name="stream">The stream.</param>
/// <param name="file">The file.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
2015-02-07 04:25:23 +01:00
Task UploadFile ( Stream stream ,
2014-10-11 22:38:13 +02:00
LocalFileInfo file ,
2015-03-14 17:50:11 +01:00
CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-10-11 22:38:13 +02:00
/// <summary>
/// Gets the devices options options.
/// </summary>
/// <returns>Task<DevicesOptions>.</returns>
Task < DevicesOptions > GetDevicesOptions ( ) ;
2014-10-13 22:14:53 +02:00
2014-12-11 07:20:28 +01:00
/// <summary>
/// Updates the item.
/// </summary>
/// <param name="item">The item.</param>
/// <returns>Task.</returns>
Task UpdateItem ( BaseItemDto item ) ;
/// <summary>
2014-12-15 06:16:23 +01:00
/// Creates the synchronize job.
2014-12-11 07:20:28 +01:00
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Task<SyncJob>.</returns>
2014-12-15 06:16:23 +01:00
Task < SyncJob > CreateSyncJob ( SyncJobRequest request ) ;
2014-12-11 07:20:28 +01:00
2015-02-08 00:15:51 +01:00
/// <summary>
/// Updates the synchronize job.
/// </summary>
/// <param name="job">The job.</param>
/// <returns>Task.</returns>
Task UpdateSyncJob ( SyncJob job ) ;
2015-04-04 03:24:49 +02:00
2014-12-17 06:30:31 +01:00
/// <summary>
/// Gets the synchronize jobs.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task<QueryResult<SyncJob>>.</returns>
Task < QueryResult < SyncJob > > GetSyncJobs ( SyncJobQuery query ) ;
/// <summary>
/// Gets the synchronize job items.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task<QueryResult<SyncJobItem>>.</returns>
Task < QueryResult < SyncJobItem > > GetSyncJobItems ( SyncJobItemQuery query ) ;
/// <summary>
/// Reports the synchronize job item transferred.
/// </summary>
/// <param name="id">The identifier.</param>
/// <returns>Task.</returns>
Task ReportSyncJobItemTransferred ( string id ) ;
/// <summary>
/// Gets the synchronize job item file.
/// </summary>
/// <param name="id">The identifier.</param>
2014-12-17 06:52:34 +01:00
/// <param name="cancellationToken">The cancellation token.</param>
2014-12-17 06:30:31 +01:00
/// <returns>Task<Stream>.</returns>
2015-03-14 17:50:11 +01:00
Task < Stream > GetSyncJobItemFile ( string id , CancellationToken cancellationToken = default ( CancellationToken ) ) ;
2014-12-17 06:30:31 +01:00
2015-01-17 05:29:53 +01:00
/// <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 ) ;
2015-02-07 04:25:23 +01:00
2014-10-13 22:14:53 +02:00
/// <summary>
/// Opens the web socket.
/// </summary>
/// <param name="webSocketFactory">The web socket factory.</param>
/// <param name="keepAliveTimerMs">The keep alive timer ms.</param>
void OpenWebSocket ( Func < IClientWebSocket > webSocketFactory , int keepAliveTimerMs = 60000 ) ;
2014-12-26 18:45:06 +01:00
/// <summary>
/// Reports the offline actions.
/// </summary>
/// <param name="actions">The actions.</param>
/// <returns>Task.</returns>
Task ReportOfflineActions ( List < UserAction > actions ) ;
/// <summary>
/// Gets the ready synchronize items.
/// </summary>
/// <param name="targetId">The target identifier.</param>
/// <returns>List<SyncedItem>.</returns>
Task < List < SyncedItem > > GetReadySyncItems ( string targetId ) ;
2014-12-29 06:56:55 +01:00
/// <summary>
/// Synchronizes the data.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Task<SyncDataResponse>.</returns>
Task < SyncDataResponse > SyncData ( SyncDataRequest request ) ;
2015-01-13 06:40:27 +01:00
/// <summary>
/// Gets the synchronize job item file URL.
/// </summary>
/// <param name="id">The identifier.</param>
/// <returns>System.String.</returns>
string GetSyncJobItemFileUrl ( string id ) ;
2015-01-21 05:56:00 +01:00
/// <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>
2015-02-08 00:15:51 +01:00
/// Cancels the synchronize job.
/// </summary>
/// <param name="id">The identifier.</param>
/// <returns>Task.</returns>
Task CancelSyncJob ( string id ) ;
/// <summary>
2015-01-21 05:56:00 +01:00
/// 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 ) ;
2015-02-07 04:25:23 +01:00
/// <summary>
/// Gets the synchronize options.
/// </summary>
2015-03-08 05:44:31 +01:00
/// <param name="jobInfo">The job information.</param>
2015-02-07 04:25:23 +01:00
/// <returns>Task<SyncOptions>.</returns>
2015-03-08 05:44:31 +01:00
Task < SyncDialogOptions > GetSyncOptions ( SyncJobRequest jobInfo ) ;
2015-03-11 02:43:07 +01:00
/// <summary>
2015-03-18 22:09:48 +01:00
/// Gets the synchronize options.
/// </summary>
/// <param name="jobInfo">The job information.</param>
/// <returns>Task<SyncDialogOptions>.</returns>
Task < SyncDialogOptions > GetSyncOptions ( SyncJob jobInfo ) ;
/// <summary>
2015-03-11 02:43:07 +01:00
/// Gets the movie recommendations.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task<List<RecommendationDto>>.</returns>
Task < List < RecommendationDto > > GetMovieRecommendations ( MovieRecommendationQuery query ) ;
2015-03-29 20:16:40 +02:00
/// <summary>
/// Opens the live stream.
/// </summary>
/// <param name="request">The request.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task<LiveStreamResponse>.</returns>
Task < LiveStreamResponse > OpenLiveStream ( LiveStreamRequest request , CancellationToken cancellationToken ) ;
2015-04-04 03:24:49 +02:00
/// <summary>
/// Cancels the synchronize library items.
/// </summary>
/// <param name="targetId">The target identifier.</param>
/// <param name="itemIds">The item ids.</param>
/// <returns>Task.</returns>
Task CancelSyncLibraryItems ( string targetId , IEnumerable < string > itemIds ) ;
2015-04-30 17:06:37 +02:00
/// <summary>
/// Gets the supported bitrate.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task<System.Int32>.</returns>
Task < int > GetSupportedBitrate ( CancellationToken cancellationToken ) ;
2013-06-03 02:21:35 +02:00
}
}