jellyfin/MediaBrowser.Model/ApiClient/IApiClient.cs

1478 lines
63 KiB
C#
Raw Normal View History

2014-05-31 15:13:07 +00:00
using MediaBrowser.Model.Channels;
using MediaBrowser.Model.Configuration;
2014-10-11 20:38:13 +00:00
using MediaBrowser.Model.Devices;
2013-06-03 00:21:35 +00:00
using MediaBrowser.Model.Dto;
using MediaBrowser.Model.Entities;
2014-10-04 03:18:57 +00:00
using MediaBrowser.Model.Events;
2013-06-03 00:21:35 +00:00
using MediaBrowser.Model.Globalization;
2014-01-15 05:38:08 +00:00
using MediaBrowser.Model.LiveTv;
2014-11-19 02:45:12 +00:00
using MediaBrowser.Model.MediaInfo;
2014-12-26 17:45:06 +00:00
using MediaBrowser.Model.Net;
2013-07-07 04:48:26 +00:00
using MediaBrowser.Model.Notifications;
2014-08-21 15:55:35 +00:00
using MediaBrowser.Model.Playlists;
2013-06-03 00:21:35 +00:00
using MediaBrowser.Model.Plugins;
using MediaBrowser.Model.Querying;
2013-08-07 19:15:55 +00:00
using MediaBrowser.Model.Search;
2013-06-03 00:21:35 +00:00
using MediaBrowser.Model.Serialization;
using MediaBrowser.Model.Session;
2014-12-11 06:20:28 +00:00
using MediaBrowser.Model.Sync;
2013-06-03 00:21:35 +00:00
using MediaBrowser.Model.System;
using MediaBrowser.Model.Tasks;
2013-07-27 15:48:35 +00:00
using MediaBrowser.Model.Users;
2013-06-03 00:21:35 +00:00
using System;
using System.Collections.Generic;
using System.IO;
using System.Threading;
2013-06-03 00:21:35 +00:00
using System.Threading.Tasks;
2013-06-03 00:27:31 +00:00
namespace MediaBrowser.Model.ApiClient
2013-06-03 00:21:35 +00:00
{
2013-09-11 17:54:59 +00:00
/// <summary>
/// Interface IApiClient
/// </summary>
2014-10-03 03:48:59 +00:00
public interface IApiClient : IServerEvents, IDisposable
2013-06-03 00:21:35 +00:00
{
2013-07-09 02:38:18 +00:00
/// <summary>
2014-10-04 03:18:57 +00:00
/// Occurs when [remote logged out].
2013-07-09 02:38:18 +00:00
/// </summary>
2014-10-28 23:17:55 +00:00
event EventHandler<GenericEventArgs<RemoteLogoutReason>> RemoteLoggedOut;
2013-07-09 02:38:18 +00:00
2014-10-04 03:18:57 +00:00
/// <summary>
/// Occurs when [authenticated].
/// </summary>
event EventHandler<GenericEventArgs<AuthenticationResult>> Authenticated;
2013-09-21 21:00:04 +00:00
/// <summary>
/// Gets the API URL.
/// </summary>
/// <param name="handler">The handler.</param>
/// <returns>System.String.</returns>
2013-09-11 17:54:59 +00:00
string GetApiUrl(string handler);
2013-09-21 21:00:04 +00:00
/// <summary>
/// Gets the game system summaries async.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{List{GameSystemSummary}}.</returns>
Task<List<GameSystemSummary>> GetGameSystemSummariesAsync(CancellationToken cancellationToken = default(CancellationToken));
2013-09-21 21:00:04 +00:00
2013-09-11 17:54:59 +00: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>
Task<T> GetAsync<T>(string url, CancellationToken cancellationToken = default(CancellationToken))
2013-09-11 17:54:59 +00:00
where T : class;
2014-01-05 06:25:46 +00:00
/// <summary>
/// Reports the capabilities.
/// </summary>
/// <param name="capabilities">The capabilities.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
Task ReportCapabilities(ClientCapabilities capabilities, CancellationToken cancellationToken = default(CancellationToken));
2014-01-05 06:25:46 +00:00
2014-07-13 04:55:56 +00:00
/// <summary>
/// Logouts this instance.
/// </summary>
/// <returns>Task.</returns>
Task Logout();
2013-10-06 03:03:08 +00: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>
Task<List<ItemIndex>> GetGamePlayerIndex(string userId, CancellationToken cancellationToken = default(CancellationToken));
2013-10-06 03:03:08 +00: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>
Task<List<ItemIndex>> GetYearIndex(string userId, string[] includeItemTypes, CancellationToken cancellationToken = default(CancellationToken));
2013-10-09 01:54:56 +00:00
2013-07-21 14:20:57 +00:00
/// <summary>
/// Gets the critic reviews.
/// </summary>
/// <param name="itemId">The item id.</param>
2013-09-11 17:54:59 +00:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-07-21 14:20:57 +00:00
/// <param name="startIndex">The start index.</param>
/// <param name="limit">The limit.</param>
/// <returns>Task{ItemReviewsResult}.</returns>
Task<QueryResult<ItemReview>> GetCriticReviews(string itemId, CancellationToken cancellationToken = default(CancellationToken), int? startIndex = null, int? limit = null);
2013-07-21 14:20:57 +00:00
2013-07-10 20:06:11 +00: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 17:54:59 +00:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-07-10 20:06:11 +00:00
/// <returns>Task{ThemeMediaResult}.</returns>
Task<ThemeMediaResult> GetThemeSongsAsync(string userId, string itemId, bool inheritFromParents, CancellationToken cancellationToken = default(CancellationToken));
2013-07-10 20:06:11 +00:00
2013-08-07 19:15:55 +00:00
/// <summary>
/// Gets the search hints async.
/// </summary>
2014-01-07 20:12:39 +00:00
/// <param name="query">The query.</param>
2013-08-07 19:15:55 +00:00
/// <returns>Task{SearchHintResult}.</returns>
2014-01-07 20:12:39 +00:00
Task<SearchHintResult> GetSearchHintsAsync(SearchQuery query);
2013-08-07 19:15:55 +00:00
2014-11-11 03:41:55 +00: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&lt;QueryFilters&gt;.</returns>
Task<QueryFilters> GetFilters(string userId, string parentId, string[] mediaTypes, string[] itemTypes);
2013-07-10 20:06:11 +00: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 17:54:59 +00:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-07-10 20:06:11 +00:00
/// <returns>Task{ThemeMediaResult}.</returns>
Task<ThemeMediaResult> GetThemeVideosAsync(string userId, string itemId, bool inheritFromParents, CancellationToken cancellationToken = default(CancellationToken));
2013-07-10 20:06:11 +00: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 17:54:59 +00:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-07-10 20:06:11 +00:00
/// <returns>Task{AllThemeMediaResult}.</returns>
Task<AllThemeMediaResult> GetAllThemeMediaAsync(string userId, string itemId, bool inheritFromParents, CancellationToken cancellationToken = default(CancellationToken));
2013-07-21 14:20:57 +00:00
2013-07-07 04:48:26 +00: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 20:09:53 +00:00
Task MarkNotificationsRead(string userId, IEnumerable<string> notificationIdList, bool isRead);
2013-07-07 04:48:26 +00: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 04:54:16 +00:00
/// Gets the notifications async.
2013-07-07 04:48:26 +00:00
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{NotificationResult}.</returns>
2013-07-07 04:54:16 +00:00
Task<NotificationResult> GetNotificationsAsync(NotificationQuery query);
2013-07-07 04:48:26 +00:00
2013-06-03 00:21:35 +00:00
/// <summary>
/// Gets an image stream based on a url
/// </summary>
/// <param name="url">The URL.</param>
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-03 00:21:35 +00:00
/// <returns>Task{Stream}.</returns>
2013-06-03 00:27:31 +00:00
/// <exception cref="ArgumentNullException">url</exception>
Task<Stream> GetImageStreamAsync(string url, CancellationToken cancellationToken = default(CancellationToken));
2013-06-03 00:21:35 +00:00
2014-12-26 17:45:06 +00:00
/// <summary>
/// Gets the stream.
/// </summary>
/// <param name="url">The URL.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task&lt;Stream&gt;.</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&lt;HttpResponse&gt;.</returns>
Task<HttpResponse> GetResponse(string url, CancellationToken cancellationToken = default(CancellationToken));
2014-12-19 04:20:07 +00: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 00:21:35 +00: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 00:27:31 +00:00
/// <exception cref="ArgumentNullException">id</exception>
2013-06-03 00:21:35 +00:00
Task<BaseItemDto> GetItemAsync(string id, string userId);
2014-08-14 13:24:30 +00:00
/// <summary>
/// Gets the latest items.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task&lt;QueryResult&lt;BaseItemDto&gt;&gt;.</returns>
2014-08-28 01:36:59 +00:00
Task<BaseItemDto[]> GetLatestItems(LatestItemsQuery query);
2014-08-14 13:24:30 +00:00
2013-06-03 00:21:35 +00:00
/// <summary>
/// Gets the intros async.
/// </summary>
/// <param name="itemId">The item id.</param>
/// <param name="userId">The user id.</param>
/// <returns>Task{ItemsResult}.</returns>
Task<ItemsResult> GetIntrosAsync(string itemId, string userId);
2013-06-03 00:21:35 +00:00
/// <summary>
/// Gets a BaseItem
/// </summary>
/// <param name="userId">The user id.</param>
/// <returns>Task{BaseItemDto}.</returns>
2013-06-03 00:27:31 +00:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-06-03 00:21:35 +00:00
Task<BaseItemDto> GetRootFolderAsync(string userId);
2014-05-27 21:17:48 +00:00
/// <summary>
/// Gets the additional parts.
/// </summary>
/// <param name="itemId">The item identifier.</param>
2014-07-01 21:13:32 +00:00
/// <param name="userId">The user identifier.</param>
2014-05-27 21:17:48 +00:00
/// <returns>Task{BaseItemDto[]}.</returns>
2014-06-01 19:41:35 +00:00
Task<ItemsResult> GetAdditionalParts(string itemId, string userId);
2014-07-27 22:01:29 +00:00
2014-11-19 02:45:12 +00:00
/// <summary>
/// Gets the live media information.
/// </summary>
/// <param name="itemId">The item identifier.</param>
2014-11-26 04:12:29 +00:00
/// <param name="userId">The user identifier.</param>
2014-11-19 02:45:12 +00:00
/// <returns>Task&lt;LiveMediaInfoResult&gt;.</returns>
2014-11-26 04:12:29 +00:00
Task<LiveMediaInfoResult> GetLiveMediaInfo(string itemId, string userId);
2014-11-19 02:45:12 +00:00
2013-06-03 00:21:35 +00:00
/// <summary>
2013-06-03 02:17:13 +00:00
/// Gets the users async.
2013-06-03 00:21:35 +00:00
/// </summary>
2013-09-11 17:54:59 +00:00
/// <param name="query">The query.</param>
2013-06-03 00:21:35 +00:00
/// <returns>Task{UserDto[]}.</returns>
2013-07-09 18:37:41 +00:00
Task<UserDto[]> GetUsersAsync(UserQuery query);
2013-06-03 00:21:35 +00:00
/// <summary>
/// Gets the public users async.
/// </summary>
2013-09-11 17:54:59 +00:00
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{UserDto[]}.</returns>
Task<UserDto[]> GetPublicUsersAsync(CancellationToken cancellationToken = default(CancellationToken));
2013-07-21 14:20:57 +00:00
2013-06-03 00:21:35 +00:00
/// <summary>
/// Gets active client sessions.
/// </summary>
2013-09-21 21:00:04 +00:00
/// <param name="query">The query.</param>
2013-06-03 00:21:35 +00:00
/// <returns>Task{SessionInfoDto[]}.</returns>
Task<SessionInfoDto[]> GetClientSessionsAsync(SessionQuery query);
2013-06-03 00:21:35 +00:00
2014-07-01 21:13:32 +00:00
/// <summary>
/// Gets the client session asynchronous.
/// </summary>
/// <returns>Task{SessionInfoDto}.</returns>
Task<SessionInfoDto> GetCurrentSessionAsync(CancellationToken cancellationToken = default(CancellationToken));
2014-07-27 22:01:29 +00:00
2013-06-22 18:15:31 +00:00
/// <summary>
/// Gets the item counts async.
/// </summary>
2013-10-21 03:01:22 +00:00
/// <param name="query">The query.</param>
2013-06-22 18:15:31 +00:00
/// <returns>Task{ItemCounts}.</returns>
2013-10-21 03:01:22 +00:00
Task<ItemCounts> GetItemCountsAsync(ItemCountsQuery query);
2013-07-07 04:48:26 +00:00
/// <summary>
/// Gets the episodes asynchronous.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{ItemsResult}.</returns>
Task<ItemsResult> GetEpisodesAsync(EpisodeQuery query, CancellationToken cancellationToken = default(CancellationToken));
2013-11-28 18:27:29 +00:00
/// <summary>
/// Gets the seasons asynchronous.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
2013-11-28 18:27:29 +00:00
/// <returns>Task{ItemsResult}.</returns>
Task<ItemsResult> GetSeasonsAsync(SeasonQuery query, CancellationToken cancellationToken = default(CancellationToken));
2014-03-13 09:18:32 +00:00
2013-06-03 00:21:35 +00:00
/// <summary>
/// Queries for items
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-03 00:21:35 +00:00
/// <returns>Task{ItemsResult}.</returns>
2013-06-03 00:27:31 +00:00
/// <exception cref="ArgumentNullException">query</exception>
Task<ItemsResult> GetItemsAsync(ItemQuery query, CancellationToken cancellationToken = default(CancellationToken));
2013-06-03 00:21:35 +00:00
2014-08-01 02:58:37 +00:00
/// <summary>
/// Gets the user views.
/// </summary>
/// <param name="userId">The user identifier.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task&lt;ItemsResult&gt;.</returns>
Task<ItemsResult> GetUserViews(string userId, CancellationToken cancellationToken = default(CancellationToken));
2014-08-01 02:58:37 +00:00
2013-08-10 01:16:31 +00: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>
Task<ItemsResult> GetInstantMixFromArtistAsync(SimilarItemsByNameQuery query);
/// <summary>
/// Gets the instant mix from music genre async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
Task<ItemsResult> GetInstantMixFromMusicGenreAsync(SimilarItemsByNameQuery query);
2013-06-04 02:02:49 +00:00
/// <summary>
/// Gets the similar movies async.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-04 02:02:49 +00:00
/// <returns>Task{ItemsResult}.</returns>
Task<ItemsResult> GetSimilarMoviesAsync(SimilarItemsQuery query, CancellationToken cancellationToken = default(CancellationToken));
2013-06-04 02:02:49 +00:00
2013-07-12 19:56:40 +00:00
/// <summary>
/// Gets the similar trailers async.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
2013-07-12 19:56:40 +00:00
/// <returns>Task{ItemsResult}.</returns>
Task<ItemsResult> GetSimilarTrailersAsync(SimilarItemsQuery query, CancellationToken cancellationToken = default(CancellationToken));
2013-07-21 14:20:57 +00:00
2013-06-04 02:02:49 +00:00
/// <summary>
/// Gets the similar series async.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-04 02:02:49 +00:00
/// <returns>Task{ItemsResult}.</returns>
Task<ItemsResult> GetSimilarSeriesAsync(SimilarItemsQuery query, CancellationToken cancellationToken = default(CancellationToken));
2013-06-04 02:02:49 +00:00
/// <summary>
/// Gets the similar albums async.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-04 02:02:49 +00:00
/// <returns>Task{ItemsResult}.</returns>
Task<ItemsResult> GetSimilarAlbumsAsync(SimilarItemsQuery query, CancellationToken cancellationToken = default(CancellationToken));
2013-06-04 02:02:49 +00:00
/// <summary>
/// Gets the similar games async.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-04 02:02:49 +00:00
/// <returns>Task{ItemsResult}.</returns>
Task<ItemsResult> GetSimilarGamesAsync(SimilarItemsQuery query, CancellationToken cancellationToken = default(CancellationToken));
2013-07-07 04:48:26 +00:00
2013-06-03 00:21:35 +00:00
/// <summary>
/// Gets the people async.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-03 00:21:35 +00:00
/// <returns>Task{ItemsResult}.</returns>
2013-06-03 00:27:31 +00:00
/// <exception cref="ArgumentNullException">userId</exception>
Task<ItemsResult> GetPeopleAsync(PersonsQuery query, CancellationToken cancellationToken = default(CancellationToken));
2013-06-03 00:21:35 +00:00
/// <summary>
/// Gets the artists.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
2013-06-03 00:27:31 +00:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-06-03 00:21:35 +00:00
Task<ItemsResult> GetArtistsAsync(ArtistsQuery query);
2014-06-23 16:05:19 +00: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-27 22:01:29 +00:00
2013-06-03 00:21:35 +00:00
/// <summary>
/// Gets a studio
/// </summary>
/// <param name="name">The name.</param>
2013-07-27 17:18:10 +00:00
/// <param name="userId">The user id.</param>
2013-06-03 00:21:35 +00:00
/// <returns>Task{BaseItemDto}.</returns>
2013-06-03 00:27:31 +00:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-07-27 17:18:10 +00:00
Task<BaseItemDto> GetStudioAsync(string name, string userId);
2013-06-03 00:21:35 +00:00
2013-06-17 01:48:55 +00:00
/// <summary>
/// Gets the next up async.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-17 01:48:55 +00:00
/// <returns>Task{ItemsResult}.</returns>
Task<ItemsResult> GetNextUpEpisodesAsync(NextUpQuery query, CancellationToken cancellationToken = default(CancellationToken));
2013-07-07 04:48:26 +00:00
2014-03-06 05:23:06 +00:00
/// <summary>
/// Gets the upcoming episodes asynchronous.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
2014-12-03 03:13:03 +00:00
Task<ItemsResult> GetUpcomingEpisodesAsync(UpcomingEpisodesQuery query);
2014-03-13 09:18:32 +00:00
2013-06-03 00:21:35 +00:00
/// <summary>
/// Gets a genre
/// </summary>
/// <param name="name">The name.</param>
2013-07-27 17:18:10 +00:00
/// <param name="userId">The user id.</param>
2013-06-03 00:21:35 +00:00
/// <returns>Task{BaseItemDto}.</returns>
2013-06-03 00:27:31 +00:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-07-27 17:18:10 +00:00
Task<BaseItemDto> GetGenreAsync(string name, string userId);
2013-06-03 00:21:35 +00:00
2013-08-03 16:06:45 +00: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 music genres async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
Task<ItemsResult> GetMusicGenresAsync(ItemsByNameQuery query);
/// <summary>
/// Gets the game genres async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
Task<ItemsResult> GetGameGenresAsync(ItemsByNameQuery query);
/// <summary>
/// Gets the studios async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
Task<ItemsResult> GetStudiosAsync(ItemsByNameQuery query);
/// <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-06-03 00:21:35 +00:00
/// <summary>
/// Gets the artist async.
/// </summary>
/// <param name="name">The name.</param>
2013-07-27 17:18:10 +00:00
/// <param name="userId">The user id.</param>
2013-06-03 00:21:35 +00:00
/// <returns>Task{BaseItemDto}.</returns>
2013-06-03 00:27:31 +00:00
/// <exception cref="ArgumentNullException">name</exception>
2013-07-27 17:18:10 +00:00
Task<BaseItemDto> GetArtistAsync(string name, string userId);
2013-06-03 00:21:35 +00:00
/// <summary>
2013-07-07 15:55:05 +00:00
/// Restarts the server.
2013-06-03 00:21:35 +00:00
/// </summary>
/// <returns>Task.</returns>
2013-07-07 15:55:05 +00:00
Task RestartServerAsync();
2013-06-03 00:21:35 +00:00
/// <summary>
/// Gets the system status async.
/// </summary>
2014-06-01 19:41:35 +00:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-03 00:21:35 +00:00
/// <returns>Task{SystemInfo}.</returns>
Task<SystemInfo> GetSystemInfoAsync(CancellationToken cancellationToken = default(CancellationToken));
2013-06-03 00:21:35 +00:00
2014-07-27 22:01:29 +00:00
/// <summary>
/// Gets the public system information asynchronous.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task&lt;PublicSystemInfo&gt;.</returns>
Task<PublicSystemInfo> GetPublicSystemInfoAsync(CancellationToken cancellationToken = default(CancellationToken));
2013-06-03 00:21:35 +00: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 00:27:31 +00:00
/// <exception cref="ArgumentNullException">id</exception>
2014-05-08 20:09:53 +00:00
Task<TaskInfo> GetScheduledTaskAsync(string id);
2013-06-03 00:21:35 +00:00
/// <summary>
/// Gets a user by id
/// </summary>
/// <param name="id">The id.</param>
/// <returns>Task{UserDto}.</returns>
2013-06-03 00:27:31 +00:00
/// <exception cref="ArgumentNullException">id</exception>
2013-06-03 00:21:35 +00:00
Task<UserDto> GetUserAsync(string id);
2015-01-30 05:18:32 +00:00
/// <summary>
/// Gets the offline user asynchronous.
/// </summary>
/// <param name="id">The identifier.</param>
/// <returns>Task&lt;UserDto&gt;.</returns>
Task<UserDto> GetOfflineUserAsync(string id);
2013-06-03 00:21:35 +00: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 00:27:31 +00:00
/// <exception cref="ArgumentNullException">query</exception>
2013-06-03 00:21:35 +00: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 00:27:31 +00:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-06-03 00:21:35 +00: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>
/// Marks the played async.
2013-06-03 00:21:35 +00:00
/// </summary>
/// <param name="itemId">The item id.</param>
/// <param name="userId">The user id.</param>
/// <param name="datePlayed">The date played.</param>
/// <returns>Task{UserItemDataDto}.</returns>
Task<UserItemDataDto> MarkPlayedAsync(string itemId, string userId, DateTime? datePlayed);
2013-06-03 00:21:35 +00: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 21:00:04 +00:00
2013-06-03 00:21:35 +00: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 00:27:31 +00:00
/// <exception cref="ArgumentNullException">itemId</exception>
Task<UserItemDataDto> UpdateFavoriteStatusAsync(string itemId, string userId, bool isFavorite);
2013-06-03 00:21:35 +00:00
/// <summary>
/// Reports to the server that the user has begun playing an item
/// </summary>
/// <param name="info">The information.</param>
2013-06-03 00:21:35 +00:00
/// <returns>Task{UserItemDataDto}.</returns>
2013-06-03 00:27:31 +00:00
/// <exception cref="ArgumentNullException">itemId</exception>
Task ReportPlaybackStartAsync(PlaybackStartInfo info);
2013-06-03 00:21:35 +00:00
/// <summary>
/// Reports playback progress to the server
/// </summary>
/// <param name="info">The information.</param>
2013-06-03 00:21:35 +00:00
/// <returns>Task{UserItemDataDto}.</returns>
2013-06-03 00:27:31 +00:00
/// <exception cref="ArgumentNullException">itemId</exception>
Task ReportPlaybackProgressAsync(PlaybackProgressInfo info);
2013-06-03 00:21:35 +00:00
/// <summary>
/// Reports to the server that the user has stopped playing an item
/// </summary>
/// <param name="info">The information.</param>
2013-06-03 00:21:35 +00:00
/// <returns>Task{UserItemDataDto}.</returns>
2013-06-03 00:27:31 +00:00
/// <exception cref="ArgumentNullException">itemId</exception>
Task ReportPlaybackStoppedAsync(PlaybackStopInfo info);
2013-06-03 00:21:35 +00:00
/// <summary>
2014-08-10 22:13:17 +00:00
/// Instructs another client to browse to a library item.
2013-06-03 00:21:35 +00: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 15:07:02 +00:00
Task SendBrowseCommandAsync(string sessionId, string itemId, string itemName, string itemType);
2013-06-03 00:21:35 +00:00
/// <summary>
/// Sends the playstate command async.
/// </summary>
2014-03-13 09:18:32 +00:00
/// <param name="sessionId">The session id.</param>
/// <param name="request">The request.</param>
/// <returns>Task.</returns>
2013-07-09 16:16:52 +00:00
Task SendPlaystateCommandAsync(string sessionId, PlaystateRequest request);
2013-06-03 00:21:35 +00: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 17:54:59 +00:00
/// <exception cref="ArgumentNullException">sessionId
2013-06-03 00:21:35 +00:00
/// or
2013-09-11 17:54:59 +00:00
/// request</exception>
2013-06-03 00:21:35 +00:00
Task SendPlayCommandAsync(string sessionId, PlayRequest request);
2014-03-28 20:36:29 +00:00
/// <summary>
/// Sends the command asynchronous.
/// </summary>
/// <param name="sessionId">The session identifier.</param>
2013-09-11 17:54:59 +00:00
/// <param name="command">The command.</param>
/// <returns>Task.</returns>
2014-03-31 21:04:22 +00:00
Task SendCommandAsync(string sessionId, GeneralCommand command);
2013-08-28 04:42:56 +00:00
2014-05-08 20:09:53 +00: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 01:41:03 +00:00
/// <summary>
/// Stops the transcoding processes.
/// </summary>
/// <param name="deviceId">The device identifier.</param>
/// <returns>Task.</returns>
Task StopTranscodingProcesses(string deviceId);
2014-05-08 20:09:53 +00:00
/// <summary>
/// Sets the index of the audio stream.
/// </summary>
/// <param name="sessionId">The session identifier.</param>
2014-05-09 01:49:12 +00:00
/// <param name="index">The index.</param>
2014-05-08 20:09:53 +00:00
/// <returns>Task.</returns>
2014-05-09 01:49:12 +00:00
Task SetAudioStreamIndex(string sessionId, int index);
2014-05-08 20:09:53 +00:00
/// <summary>
/// Sets the index of the subtitle stream.
/// </summary>
/// <param name="sessionId">The session identifier.</param>
2014-05-09 01:49:12 +00:00
/// <param name="index">The index.</param>
2014-05-08 20:09:53 +00:00
/// <returns>Task.</returns>
2014-05-09 01:49:12 +00:00
Task SetSubtitleStreamIndex(string sessionId, int? index);
2014-07-27 22:01:29 +00:00
2013-08-28 04:42:56 +00:00
/// <summary>
/// Instructs the client to display a message to the user
/// </summary>
2013-09-11 17:54:59 +00:00
/// <param name="sessionId">The session id.</param>
/// <param name="command">The command.</param>
/// <returns>Task.</returns>
2013-08-28 04:42:56 +00:00
Task SendMessageCommandAsync(string sessionId, MessageCommand command);
2013-09-11 17:54:59 +00:00
2013-06-03 00:21:35 +00: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 00:27:31 +00:00
/// <exception cref="ArgumentNullException">itemId</exception>
Task<UserItemDataDto> ClearUserItemRatingAsync(string itemId, string userId);
2013-06-03 00:21:35 +00: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 00:27:31 +00:00
/// <exception cref="ArgumentNullException">itemId</exception>
Task<UserItemDataDto> UpdateUserItemRatingAsync(string itemId, string userId, bool likes);
2013-06-03 00:21:35 +00:00
/// <summary>
/// Authenticates a user and returns the result
/// </summary>
2013-07-27 15:40:53 +00:00
/// <param name="username">The username.</param>
/// <param name="password">The password.</param>
2013-06-03 00:21:35 +00:00
/// <returns>Task.</returns>
2013-06-03 00:27:31 +00:00
/// <exception cref="ArgumentNullException">userId</exception>
2014-10-27 03:06:01 +00:00
Task<AuthenticationResult> AuthenticateUserAsync(string username,
string password);
2013-06-03 00:21:35 +00:00
/// <summary>
/// Updates the server configuration async.
/// </summary>
/// <param name="configuration">The configuration.</param>
/// <returns>Task.</returns>
2013-06-03 00:27:31 +00:00
/// <exception cref="ArgumentNullException">configuration</exception>
2013-06-03 00:21:35 +00: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 00:27:31 +00:00
/// <exception cref="ArgumentNullException">id</exception>
2014-05-08 20:09:53 +00:00
Task UpdateScheduledTaskTriggersAsync(string id, TaskTriggerInfo[] triggers);
2013-06-03 00:21:35 +00:00
/// <summary>
/// Gets the display preferences.
/// </summary>
/// <param name="id">The id.</param>
/// <param name="userId">The user id.</param>
/// <param name="client">The client.</param>
2013-09-11 17:54:59 +00:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-03 00:21:35 +00:00
/// <returns>Task{BaseItemDto}.</returns>
Task<DisplayPreferences> GetDisplayPreferencesAsync(string id, string userId, string client, CancellationToken cancellationToken = default(CancellationToken));
2013-06-03 00:21:35 +00:00
/// <summary>
/// Updates display preferences for a user
/// </summary>
/// <param name="displayPreferences">The display preferences.</param>
2013-09-11 17:54:59 +00:00
/// <param name="userId">The user id.</param>
/// <param name="client">The client.</param>
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-03 00:21:35 +00:00
/// <returns>Task{DisplayPreferences}.</returns>
/// <exception cref="System.ArgumentNullException">userId</exception>
Task UpdateDisplayPreferencesAsync(DisplayPreferences displayPreferences, string userId, string client, CancellationToken cancellationToken = default(CancellationToken));
2013-06-03 00:21:35 +00: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 20:12:39 +00:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-03 00:21:35 +00:00
/// <returns>Task{``0}.</returns>
Task<T> PostAsync<T>(string url, Dictionary<string, string> args, CancellationToken cancellationToken = default(CancellationToken))
2013-06-03 00:21:35 +00: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-27 22:01:29 +00:00
/// Gets or sets the server address
2013-06-03 00:21:35 +00:00
/// </summary>
2014-07-27 22:01:29 +00:00
/// <value>The server address.</value>
string ServerAddress { get; }
2013-10-09 01:54:56 +00:00
2013-06-03 00:21:35 +00: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 20:38:13 +00:00
/// <summary>
/// Gets the device.
/// </summary>
/// <value>The device.</value>
IDevice Device { get; }
2013-06-03 00:21:35 +00:00
/// <summary>
/// Gets or sets the name of the device.
/// </summary>
/// <value>The name of the device.</value>
2014-10-11 20:38:13 +00:00
string DeviceName { get; }
2013-06-03 00:21:35 +00:00
/// <summary>
/// Gets or sets the device id.
/// </summary>
/// <value>The device id.</value>
2014-10-11 20:38:13 +00:00
string DeviceId { get; }
2013-06-03 00:21:35 +00:00
/// <summary>
/// Gets or sets the current user id.
/// </summary>
/// <value>The current user id.</value>
2014-07-27 22:01:29 +00: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);
/// <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 00:21:35 +00:00
2014-10-07 03:03:38 +00: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);
/// <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();
2013-06-03 00:21:35 +00: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 00:27:31 +00:00
/// <exception cref="ArgumentNullException">item</exception>
2013-06-03 00:21:35 +00:00
string GetImageUrl(BaseItemDto item, ImageOptions options);
2014-01-15 05:38:08 +00: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);
/// <summary>
/// Gets the image URL.
/// </summary>
/// <param name="item">The item.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
string GetImageUrl(RecordingInfoDto item, ImageOptions options);
2014-01-17 18:23:00 +00: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(ProgramInfoDto item, ImageOptions options);
2014-03-13 09:18:32 +00:00
2014-04-13 17:27:13 +00:00
/// <summary>
/// Gets the subtitle URL.
/// </summary>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2014-05-07 02:28:19 +00:00
string GetSubtitleUrl(SubtitleDownloadOptions options);
2014-07-27 22:01:29 +00:00
2013-06-03 00:21:35 +00: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 00:27:31 +00:00
/// <exception cref="ArgumentNullException">itemId</exception>
2013-06-03 00:21:35 +00: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 00:27:31 +00:00
/// <exception cref="ArgumentNullException">user</exception>
2013-06-03 00:21:35 +00: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 00:27:31 +00:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-06-03 00:21:35 +00: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 00:27:31 +00:00
/// <exception cref="ArgumentNullException">item</exception>
2013-06-03 00:21:35 +00: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="year">The year.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
string GetYearImageUrl(int year, 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 00:27:31 +00:00
/// <exception cref="ArgumentNullException">name</exception>
2013-06-03 00:21:35 +00:00
string GetGenreImageUrl(string name, ImageOptions options);
/// <summary>
2013-07-29 20:44:49 +00:00
/// Gets the music genre image URL.
2013-06-03 00:21:35 +00:00
/// </summary>
2013-07-29 20:44:49 +00:00
/// <param name="name">The name.</param>
2013-06-03 00:21:35 +00:00
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-07-29 20:44:49 +00:00
string GetMusicGenreImageUrl(string name, ImageOptions options);
2013-06-03 00:21:35 +00:00
/// <summary>
2013-07-29 20:44:49 +00:00
/// Gets the game genre image URL.
2013-06-03 00:21:35 +00:00
/// </summary>
/// <param name="name">The name.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-07-29 20:44:49 +00:00
string GetGameGenreImageUrl(string name, ImageOptions options);
2013-06-03 00:21:35 +00:00
/// <summary>
2013-07-29 20:44:49 +00:00
/// Gets an image url that can be used to download an image from the api
2013-06-03 00:21:35 +00:00
/// </summary>
2013-07-29 20:44:49 +00:00
/// <param name="name">The name.</param>
2013-06-03 00:21:35 +00:00
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-07-29 20:44:49 +00:00
/// <exception cref="ArgumentNullException">name</exception>
string GetStudioImageUrl(string name, ImageOptions options);
2013-06-03 00:21:35 +00:00
/// <summary>
/// Gets the artist image URL.
/// </summary>
/// <param name="name">The name.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 00:27:31 +00:00
/// <exception cref="ArgumentNullException">name</exception>
2013-06-03 00:21:35 +00:00
string GetArtistImageUrl(string name, ImageOptions options);
/// <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 00:27:31 +00:00
/// <exception cref="ArgumentNullException">item</exception>
2013-06-03 00:21:35 +00: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 00:27:31 +00:00
/// <exception cref="ArgumentNullException">item</exception>
2013-06-03 00:21:35 +00:00
string GetLogoImageUrl(BaseItemDto item, ImageOptions options);
2013-07-08 19:31:45 +00: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 14:20:57 +00:00
2013-10-24 17:49:24 +00: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 09:18:32 +00:00
2014-01-15 05:38:08 +00:00
/// <summary>
/// Gets the live tv information asynchronous.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{LiveTvInfo}.</returns>
Task<LiveTvInfo> GetLiveTvInfoAsync(CancellationToken cancellationToken = default(CancellationToken));
2014-01-15 05:38:08 +00: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>
Task<QueryResult<ChannelInfoDto>> GetLiveTvChannelsAsync(LiveTvChannelQuery query, CancellationToken cancellationToken = default(CancellationToken));
2014-01-15 05:38:08 +00:00
2014-01-16 17:23:30 +00: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>
Task<ChannelInfoDto> GetLiveTvChannelAsync(string id, string userId, CancellationToken cancellationToken = default(CancellationToken));
2014-03-13 09:18:32 +00:00
2014-01-15 05:38:08 +00: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>
Task<QueryResult<RecordingInfoDto>> GetLiveTvRecordingsAsync(RecordingQuery query, CancellationToken cancellationToken = default(CancellationToken));
2014-01-15 05:38:08 +00:00
2014-01-16 17:23:30 +00: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>
Task<RecordingInfoDto> GetLiveTvRecordingAsync(string id, string userId, CancellationToken cancellationToken = default(CancellationToken));
2014-03-13 09:18:32 +00:00
2014-01-15 05:38:08 +00: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>
Task<QueryResult<RecordingGroupDto>> GetLiveTvRecordingGroupsAsync(RecordingGroupQuery query, CancellationToken cancellationToken = default(CancellationToken));
2014-01-16 17:23:30 +00: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>
Task<RecordingGroupDto> GetLiveTvRecordingGroupAsync(string id, string userId, CancellationToken cancellationToken = default(CancellationToken));
2014-03-13 09:18:32 +00:00
2014-01-16 17:23:30 +00: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>
Task<QueryResult<TimerInfoDto>> GetLiveTvTimersAsync(TimerQuery query, CancellationToken cancellationToken = default(CancellationToken));
2014-01-16 17:23:30 +00:00
2014-01-17 18:23:00 +00: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>
Task<QueryResult<ProgramInfoDto>> GetLiveTvProgramsAsync(ProgramQuery query, CancellationToken cancellationToken = default(CancellationToken));
2014-01-17 20:51:29 +00:00
2014-03-08 18:17:05 +00: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>
Task<ProgramInfoDto> GetLiveTvProgramAsync(string id, string userId, CancellationToken cancellationToken = default(CancellationToken));
2014-03-08 18:17:05 +00:00
2014-01-17 20:51:29 +00: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>
Task<QueryResult<ProgramInfoDto>> GetRecommendedLiveTvProgramsAsync(RecommendedProgramQuery query, CancellationToken cancellationToken = default(CancellationToken));
2014-03-08 18:17:05 +00: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>
Task CreateLiveTvTimerAsync(BaseTimerInfoDto timer, CancellationToken cancellationToken = default(CancellationToken));
2014-03-08 18:17:05 +00: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>
Task UpdateLiveTvTimerAsync(TimerInfoDto timer, CancellationToken cancellationToken = default(CancellationToken));
2014-03-08 18:17:05 +00: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>
Task CreateLiveTvSeriesTimerAsync(SeriesTimerInfoDto timer, CancellationToken cancellationToken = default(CancellationToken));
2014-03-08 18:17:05 +00: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>
Task UpdateLiveTvSeriesTimerAsync(SeriesTimerInfoDto timer, CancellationToken cancellationToken = default(CancellationToken));
2014-03-13 09:18:32 +00:00
2014-01-16 17:23:30 +00: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>
Task<TimerInfoDto> GetLiveTvTimerAsync(string id, CancellationToken cancellationToken = default(CancellationToken));
2014-03-13 09:18:32 +00:00
2014-01-16 17:23:30 +00: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>
Task<QueryResult<SeriesTimerInfoDto>> GetLiveTvSeriesTimersAsync(SeriesTimerQuery query, CancellationToken cancellationToken = default(CancellationToken));
2014-01-16 17:23:30 +00: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>
Task<SeriesTimerInfoDto> GetLiveTvSeriesTimerAsync(string id, CancellationToken cancellationToken = default(CancellationToken));
2014-01-16 17:23:30 +00: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>
Task CancelLiveTvTimerAsync(string id, CancellationToken cancellationToken = default(CancellationToken));
2014-01-16 17:23:30 +00: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>
Task CancelLiveTvSeriesTimerAsync(string id, CancellationToken cancellationToken = default(CancellationToken));
2014-03-13 09:18:32 +00:00
2014-01-16 17:23:30 +00:00
/// <summary>
/// Deletes the live tv recording asynchronous.
/// </summary>
/// <param name="id">The identifier.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
Task DeleteLiveTvRecordingAsync(string id, CancellationToken cancellationToken = default(CancellationToken));
2014-03-08 18:17:05 +00:00
/// <summary>
/// Gets the default timer information.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{SeriesTimerInfoDto}.</returns>
Task<SeriesTimerInfoDto> GetDefaultLiveTvTimerInfo(CancellationToken cancellationToken = default(CancellationToken));
2014-03-08 18:17:05 +00:00
/// <summary>
/// Gets the live tv guide information.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{GuideInfo}.</returns>
Task<GuideInfo> GetLiveTvGuideInfo(CancellationToken cancellationToken = default(CancellationToken));
2014-03-13 09:18:32 +00:00
2014-03-08 18:17:05 +00: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>
Task<SeriesTimerInfoDto> GetDefaultLiveTvTimerInfo(string programId, CancellationToken cancellationToken = default(CancellationToken));
2014-05-31 15:13:07 +00: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>
Task<ChannelFeatures> GetChannelFeatures(string channelId, CancellationToken cancellationToken = default(CancellationToken));
2014-05-31 15:13:07 +00: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>
Task<QueryResult<BaseItemDto>> GetChannelItems(ChannelItemQuery query, CancellationToken cancellationToken = default(CancellationToken));
2014-05-31 15:13:07 +00:00
/// <summary>
/// Gets the channels.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task{QueryResult{BaseItemDto}}.</returns>
Task<QueryResult<BaseItemDto>> GetChannels(ChannelQuery query, CancellationToken cancellationToken = default(CancellationToken));
2014-07-08 01:41:03 +00: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>
Task<QueryResult<BaseItemDto>> GetLatestChannelItems(AllChannelMediaQuery query, CancellationToken cancellationToken = default(CancellationToken));
2014-08-21 15:55:35 +00:00
/// <summary>
/// Creates the playlist.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Task&lt;PlaylistCreationResult&gt;.</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 02:24:38 +00:00
/// <param name="userId">The user identifier.</param>
2014-08-21 15:55:35 +00:00
/// <returns>Task.</returns>
2014-08-22 02:24:38 +00:00
Task AddToPlaylist(string playlistId, IEnumerable<string> itemIds, string userId);
2014-08-21 15:55:35 +00: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&lt;QueryResult&lt;BaseItemDto&gt;&gt;.</returns>
Task<QueryResult<BaseItemDto>> GetPlaylistItems(PlaylistItemQuery query);
2014-10-03 03:48:59 +00: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,
CancellationToken cancellationToken);
2014-10-11 20:38:13 +00:00
/// <summary>
/// Gets the content upload history.
/// </summary>
/// <param name="deviceId">The device identifier.</param>
/// <returns>Task&lt;ContentUploadHistory&gt;.</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>
Task UploadFile(Stream stream,
LocalFileInfo file,
CancellationToken cancellationToken);
/// <summary>
/// Gets the devices options options.
/// </summary>
/// <returns>Task&lt;DevicesOptions&gt;.</returns>
Task<DevicesOptions> GetDevicesOptions();
2014-10-13 20:14:53 +00:00
2014-12-11 06:20:28 +00:00
/// <summary>
/// Updates the item.
/// </summary>
/// <param name="item">The item.</param>
/// <returns>Task.</returns>
Task UpdateItem(BaseItemDto item);
/// <summary>
2014-12-15 05:16:23 +00:00
/// Creates the synchronize job.
2014-12-11 06:20:28 +00:00
/// </summary>
/// <param name="request">The request.</param>
/// <returns>Task&lt;SyncJob&gt;.</returns>
2014-12-15 05:16:23 +00:00
Task<SyncJob> CreateSyncJob(SyncJobRequest request);
2014-12-11 06:20:28 +00:00
2014-12-17 05:30:31 +00:00
/// <summary>
/// Gets the synchronize jobs.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task&lt;QueryResult&lt;SyncJob&gt;&gt;.</returns>
Task<QueryResult<SyncJob>> GetSyncJobs(SyncJobQuery query);
/// <summary>
/// Gets the synchronize job items.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task&lt;QueryResult&lt;SyncJobItem&gt;&gt;.</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 05:52:34 +00:00
/// <param name="cancellationToken">The cancellation token.</param>
2014-12-17 05:30:31 +00:00
/// <returns>Task&lt;Stream&gt;.</returns>
2014-12-17 05:52:34 +00:00
Task<Stream> GetSyncJobItemFile(string id, CancellationToken cancellationToken);
2014-12-17 05:30:31 +00:00
2015-01-17 04:29:53 +00: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&lt;Stream&gt;.</returns>
Task<Stream> GetSyncJobItemAdditionalFile(string id, string name, CancellationToken cancellationToken);
2014-10-13 20:14:53 +00: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 17:45:06 +00: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&lt;SyncedItem&gt;.</returns>
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-13 05:40:27 +00: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 04:56:00 +00: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>
/// 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);
2013-06-03 00:21:35 +00:00
}
}