|
@@ -1,1427 +0,0 @@
|
|
|
-using MediaBrowser.Model.Channels;
|
|
|
-using MediaBrowser.Model.Configuration;
|
|
|
-using MediaBrowser.Model.Devices;
|
|
|
-using MediaBrowser.Model.Dto;
|
|
|
-using MediaBrowser.Model.Entities;
|
|
|
-using MediaBrowser.Model.Events;
|
|
|
-using MediaBrowser.Model.Globalization;
|
|
|
-using MediaBrowser.Model.LiveTv;
|
|
|
-using MediaBrowser.Model.MediaInfo;
|
|
|
-using MediaBrowser.Model.Net;
|
|
|
-using MediaBrowser.Model.Notifications;
|
|
|
-using MediaBrowser.Model.Playlists;
|
|
|
-using MediaBrowser.Model.Plugins;
|
|
|
-using MediaBrowser.Model.Querying;
|
|
|
-using MediaBrowser.Model.Search;
|
|
|
-using MediaBrowser.Model.Serialization;
|
|
|
-using MediaBrowser.Model.Session;
|
|
|
-using MediaBrowser.Model.Sync;
|
|
|
-using MediaBrowser.Model.System;
|
|
|
-using MediaBrowser.Model.Tasks;
|
|
|
-using MediaBrowser.Model.Users;
|
|
|
-using System;
|
|
|
-using System.Collections.Generic;
|
|
|
-using System.IO;
|
|
|
-using System.Threading;
|
|
|
-using System.Threading.Tasks;
|
|
|
-
|
|
|
-namespace MediaBrowser.Model.ApiClient
|
|
|
-{
|
|
|
- /// <summary>
|
|
|
- /// Interface IApiClient
|
|
|
- /// </summary>
|
|
|
- public interface IApiClient : IServerEvents, IDisposable
|
|
|
- {
|
|
|
- /// <summary>
|
|
|
- /// Occurs when [remote logged out].
|
|
|
- /// </summary>
|
|
|
- event EventHandler<GenericEventArgs<RemoteLogoutReason>> RemoteLoggedOut;
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the API URL.
|
|
|
- /// </summary>
|
|
|
- /// <param name="handler">The handler.</param>
|
|
|
- /// <returns>System.String.</returns>
|
|
|
- string GetApiUrl(string handler);
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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))
|
|
|
- where T : class;
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Logouts this instance.
|
|
|
- /// </summary>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task Logout();
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the critic reviews.
|
|
|
- /// </summary>
|
|
|
- /// <param name="itemId">The item id.</param>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <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);
|
|
|
-
|
|
|
- /// <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>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task{ThemeMediaResult}.</returns>
|
|
|
- Task<ThemeMediaResult> GetThemeSongsAsync(string userId, string itemId, bool inheritFromParents, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the search hints async.
|
|
|
- /// </summary>
|
|
|
- /// <param name="query">The query.</param>
|
|
|
- /// <returns>Task{SearchHintResult}.</returns>
|
|
|
- Task<SearchHintResult> GetSearchHintsAsync(SearchQuery query);
|
|
|
-
|
|
|
- /// <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);
|
|
|
-
|
|
|
- /// <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>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task{ThemeMediaResult}.</returns>
|
|
|
- Task<ThemeMediaResult> GetThemeVideosAsync(string userId, string itemId, bool inheritFromParents, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <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>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task{AllThemeMediaResult}.</returns>
|
|
|
- Task<AllThemeMediaResult> GetAllThemeMediaAsync(string userId, string itemId, bool inheritFromParents, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <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>
|
|
|
- Task MarkNotificationsRead(string userId, IEnumerable<string> notificationIdList, bool isRead);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the notifications summary.
|
|
|
- /// </summary>
|
|
|
- /// <param name="userId">The user id.</param>
|
|
|
- /// <returns>Task{NotificationsSummary}.</returns>
|
|
|
- Task<NotificationsSummary> GetNotificationsSummary(string userId);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the notifications async.
|
|
|
- /// </summary>
|
|
|
- /// <param name="query">The query.</param>
|
|
|
- /// <returns>Task{NotificationResult}.</returns>
|
|
|
- Task<NotificationResult> GetNotificationsAsync(NotificationQuery query);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets an image stream based on a url
|
|
|
- /// </summary>
|
|
|
- /// <param name="url">The URL.</param>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task{Stream}.</returns>
|
|
|
- /// <exception cref="ArgumentNullException">url</exception>
|
|
|
- Task<Stream> GetImageStreamAsync(string url, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets a BaseItem
|
|
|
- /// </summary>
|
|
|
- /// <param name="id">The id.</param>
|
|
|
- /// <param name="userId">The user id.</param>
|
|
|
- /// <returns>Task{BaseItemDto}.</returns>
|
|
|
- /// <exception cref="ArgumentNullException">id</exception>
|
|
|
- Task<BaseItemDto> GetItemAsync(string id, string userId);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the latest items.
|
|
|
- /// </summary>
|
|
|
- /// <param name="query">The query.</param>
|
|
|
- /// <returns>Task<QueryResult<BaseItemDto>>.</returns>
|
|
|
- Task<BaseItemDto[]> GetLatestItems(LatestItemsQuery query);
|
|
|
-
|
|
|
- /// <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);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets a BaseItem
|
|
|
- /// </summary>
|
|
|
- /// <param name="userId">The user id.</param>
|
|
|
- /// <returns>Task{BaseItemDto}.</returns>
|
|
|
- /// <exception cref="ArgumentNullException">userId</exception>
|
|
|
- Task<BaseItemDto> GetRootFolderAsync(string userId);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the additional parts.
|
|
|
- /// </summary>
|
|
|
- /// <param name="itemId">The item identifier.</param>
|
|
|
- /// <param name="userId">The user identifier.</param>
|
|
|
- /// <returns>Task{BaseItemDto[]}.</returns>
|
|
|
- Task<ItemsResult> GetAdditionalParts(string itemId, string userId);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the playback information.
|
|
|
- /// </summary>
|
|
|
- /// <param name="request">The request.</param>
|
|
|
- /// <returns>Task<LiveMediaInfoResult>.</returns>
|
|
|
- Task<PlaybackInfoResponse> GetPlaybackInfo(PlaybackInfoRequest request);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the users async.
|
|
|
- /// </summary>
|
|
|
- /// <param name="query">The query.</param>
|
|
|
- /// <returns>Task{UserDto[]}.</returns>
|
|
|
- Task<UserDto[]> GetUsersAsync(UserQuery query);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the public users async.
|
|
|
- /// </summary>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task{UserDto[]}.</returns>
|
|
|
- Task<UserDto[]> GetPublicUsersAsync(CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets active client sessions.
|
|
|
- /// </summary>
|
|
|
- /// <param name="query">The query.</param>
|
|
|
- /// <returns>Task{SessionInfoDto[]}.</returns>
|
|
|
- Task<SessionInfoDto[]> GetClientSessionsAsync(SessionQuery query);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the client session asynchronous.
|
|
|
- /// </summary>
|
|
|
- /// <returns>Task{SessionInfoDto}.</returns>
|
|
|
- Task<SessionInfoDto> GetCurrentSessionAsync(CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the item counts async.
|
|
|
- /// </summary>
|
|
|
- /// <param name="query">The query.</param>
|
|
|
- /// <returns>Task{ItemCounts}.</returns>
|
|
|
- Task<ItemCounts> GetItemCountsAsync(ItemCountsQuery query);
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the seasons asynchronous.
|
|
|
- /// </summary>
|
|
|
- /// <param name="query">The query.</param>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task{ItemsResult}.</returns>
|
|
|
- Task<ItemsResult> GetSeasonsAsync(SeasonQuery query, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- Task<PluginSecurityInfo> GetRegistrationInfo();
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Queries for items
|
|
|
- /// </summary>
|
|
|
- /// <param name="query">The query.</param>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task{ItemsResult}.</returns>
|
|
|
- /// <exception cref="ArgumentNullException">query</exception>
|
|
|
- Task<ItemsResult> GetItemsAsync(ItemQuery query, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the user views.
|
|
|
- /// </summary>
|
|
|
- /// <param name="userId">The user identifier.</param>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task<ItemsResult>.</returns>
|
|
|
- Task<ItemsResult> GetUserViews(string userId, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the instant mix from item asynchronous.
|
|
|
- /// </summary>
|
|
|
- /// <param name="query">The query.</param>
|
|
|
- /// <returns>Task<ItemsResult>.</returns>
|
|
|
- Task<ItemsResult> GetInstantMixFromItemAsync(SimilarItemsQuery query);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the similar movies async.
|
|
|
- /// </summary>
|
|
|
- /// <param name="query">The query.</param>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task{ItemsResult}.</returns>
|
|
|
- Task<ItemsResult> GetSimilarItemsAsync(SimilarItemsQuery query, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the people async.
|
|
|
- /// </summary>
|
|
|
- /// <param name="query">The query.</param>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task{ItemsResult}.</returns>
|
|
|
- /// <exception cref="ArgumentNullException">userId</exception>
|
|
|
- Task<ItemsResult> GetPeopleAsync(PersonsQuery query, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the artists.
|
|
|
- /// </summary>
|
|
|
- /// <param name="query">The query.</param>
|
|
|
- /// <returns>Task{ItemsResult}.</returns>
|
|
|
- /// <exception cref="ArgumentNullException">userId</exception>
|
|
|
- Task<ItemsResult> GetArtistsAsync(ArtistsQuery query);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the album artists asynchronous.
|
|
|
- /// </summary>
|
|
|
- /// <param name="query">The query.</param>
|
|
|
- /// <returns>Task{ItemsResult}.</returns>
|
|
|
- Task<ItemsResult> GetAlbumArtistsAsync(ArtistsQuery query);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the next up async.
|
|
|
- /// </summary>
|
|
|
- /// <param name="query">The query.</param>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task{ItemsResult}.</returns>
|
|
|
- Task<ItemsResult> GetNextUpEpisodesAsync(NextUpQuery query, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the upcoming episodes asynchronous.
|
|
|
- /// </summary>
|
|
|
- /// <param name="query">The query.</param>
|
|
|
- /// <returns>Task{ItemsResult}.</returns>
|
|
|
- Task<ItemsResult> GetUpcomingEpisodesAsync(UpcomingEpisodesQuery query);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets a genre
|
|
|
- /// </summary>
|
|
|
- /// <param name="name">The name.</param>
|
|
|
- /// <param name="userId">The user id.</param>
|
|
|
- /// <returns>Task{BaseItemDto}.</returns>
|
|
|
- /// <exception cref="ArgumentNullException">userId</exception>
|
|
|
- Task<BaseItemDto> GetGenreAsync(string name, string userId);
|
|
|
-
|
|
|
- /// <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);
|
|
|
-
|
|
|
- /// <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);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Restarts the server.
|
|
|
- /// </summary>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task RestartServerAsync();
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the system status async.
|
|
|
- /// </summary>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task{SystemInfo}.</returns>
|
|
|
- Task<SystemInfo> GetSystemInfoAsync(CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the public system information asynchronous.
|
|
|
- /// </summary>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task<PublicSystemInfo>.</returns>
|
|
|
- Task<PublicSystemInfo> GetPublicSystemInfoAsync(CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <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>
|
|
|
- /// <exception cref="ArgumentNullException">id</exception>
|
|
|
- Task<TaskInfo> GetScheduledTaskAsync(string id);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets a user by id
|
|
|
- /// </summary>
|
|
|
- /// <param name="id">The id.</param>
|
|
|
- /// <returns>Task{UserDto}.</returns>
|
|
|
- /// <exception cref="ArgumentNullException">id</exception>
|
|
|
- Task<UserDto> GetUserAsync(string id);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the offline user asynchronous.
|
|
|
- /// </summary>
|
|
|
- /// <param name="id">The identifier.</param>
|
|
|
- /// <returns>Task<UserDto>.</returns>
|
|
|
- Task<UserDto> GetOfflineUserAsync(string id);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the parental ratings async.
|
|
|
- /// </summary>
|
|
|
- /// <returns>Task{List{ParentalRating}}.</returns>
|
|
|
- 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>
|
|
|
- /// <exception cref="ArgumentNullException">query</exception>
|
|
|
- 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>
|
|
|
- /// <exception cref="ArgumentNullException">userId</exception>
|
|
|
- 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.
|
|
|
- /// </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);
|
|
|
-
|
|
|
- /// <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);
|
|
|
-
|
|
|
- /// <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>
|
|
|
- /// <exception cref="ArgumentNullException">itemId</exception>
|
|
|
- Task<UserItemDataDto> UpdateFavoriteStatusAsync(string itemId, string userId, bool isFavorite);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Reports to the server that the user has begun playing an item
|
|
|
- /// </summary>
|
|
|
- /// <param name="info">The information.</param>
|
|
|
- /// <returns>Task{UserItemDataDto}.</returns>
|
|
|
- /// <exception cref="ArgumentNullException">itemId</exception>
|
|
|
- Task ReportPlaybackStartAsync(PlaybackStartInfo info);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Reports playback progress to the server
|
|
|
- /// </summary>
|
|
|
- /// <param name="info">The information.</param>
|
|
|
- /// <returns>Task{UserItemDataDto}.</returns>
|
|
|
- /// <exception cref="ArgumentNullException">itemId</exception>
|
|
|
- Task ReportPlaybackProgressAsync(PlaybackProgressInfo info);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Reports to the server that the user has stopped playing an item
|
|
|
- /// </summary>
|
|
|
- /// <param name="info">The information.</param>
|
|
|
- /// <returns>Task{UserItemDataDto}.</returns>
|
|
|
- /// <exception cref="ArgumentNullException">itemId</exception>
|
|
|
- Task ReportPlaybackStoppedAsync(PlaybackStopInfo info);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Instructs another client to browse to a library item.
|
|
|
- /// </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>
|
|
|
- Task SendBrowseCommandAsync(string sessionId, string itemId, string itemName, string itemType);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Sends the playstate command async.
|
|
|
- /// </summary>
|
|
|
- /// <param name="sessionId">The session id.</param>
|
|
|
- /// <param name="request">The request.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task SendPlaystateCommandAsync(string sessionId, PlaystateRequest request);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Sends the play command async.
|
|
|
- /// </summary>
|
|
|
- /// <param name="sessionId">The session id.</param>
|
|
|
- /// <param name="request">The request.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- /// <exception cref="ArgumentNullException">sessionId
|
|
|
- /// or
|
|
|
- /// request</exception>
|
|
|
- Task SendPlayCommandAsync(string sessionId, PlayRequest request);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Sends the command asynchronous.
|
|
|
- /// </summary>
|
|
|
- /// <param name="sessionId">The session identifier.</param>
|
|
|
- /// <param name="command">The command.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task SendCommandAsync(string sessionId, GeneralCommand command);
|
|
|
-
|
|
|
- /// <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);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Stops the transcoding processes.
|
|
|
- /// </summary>
|
|
|
- /// <param name="deviceId">The device identifier.</param>
|
|
|
- /// <param name="streamId">The stream identifier.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task StopTranscodingProcesses(string deviceId, string streamId);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Sets the index of the audio stream.
|
|
|
- /// </summary>
|
|
|
- /// <param name="sessionId">The session identifier.</param>
|
|
|
- /// <param name="index">The index.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task SetAudioStreamIndex(string sessionId, int index);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Sets the index of the subtitle stream.
|
|
|
- /// </summary>
|
|
|
- /// <param name="sessionId">The session identifier.</param>
|
|
|
- /// <param name="index">The index.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task SetSubtitleStreamIndex(string sessionId, int? index);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Instructs the client to display a message to the user
|
|
|
- /// </summary>
|
|
|
- /// <param name="sessionId">The session id.</param>
|
|
|
- /// <param name="command">The command.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task SendMessageCommandAsync(string sessionId, MessageCommand command);
|
|
|
-
|
|
|
- /// <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>
|
|
|
- /// <exception cref="ArgumentNullException">itemId</exception>
|
|
|
- Task<UserItemDataDto> ClearUserItemRatingAsync(string itemId, string userId);
|
|
|
-
|
|
|
- /// <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>
|
|
|
- /// <exception cref="ArgumentNullException">itemId</exception>
|
|
|
- Task<UserItemDataDto> UpdateUserItemRatingAsync(string itemId, string userId, bool likes);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Authenticates a user and returns the result
|
|
|
- /// </summary>
|
|
|
- /// <param name="username">The username.</param>
|
|
|
- /// <param name="password">The password.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- /// <exception cref="ArgumentNullException">userId</exception>
|
|
|
- Task<AuthenticationResult> AuthenticateUserAsync(string username,
|
|
|
- string password);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Updates the server configuration async.
|
|
|
- /// </summary>
|
|
|
- /// <param name="configuration">The configuration.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- /// <exception cref="ArgumentNullException">configuration</exception>
|
|
|
- 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>
|
|
|
- /// <exception cref="ArgumentNullException">id</exception>
|
|
|
- Task UpdateScheduledTaskTriggersAsync(string id, TaskTriggerInfo[] triggers);
|
|
|
-
|
|
|
- /// <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>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task{BaseItemDto}.</returns>
|
|
|
- Task<DisplayPreferences> GetDisplayPreferencesAsync(string id, string userId, string client, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Updates display preferences for a user
|
|
|
- /// </summary>
|
|
|
- /// <param name="displayPreferences">The display preferences.</param>
|
|
|
- /// <param name="userId">The user id.</param>
|
|
|
- /// <param name="client">The client.</param>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task{DisplayPreferences}.</returns>
|
|
|
- /// <exception cref="System.ArgumentNullException">userId</exception>
|
|
|
- Task UpdateDisplayPreferencesAsync(DisplayPreferences displayPreferences, string userId, string client, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <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>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task{``0}.</returns>
|
|
|
- Task<T> PostAsync<T>(string url, Dictionary<string, string> args, CancellationToken cancellationToken = default(CancellationToken))
|
|
|
- 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>
|
|
|
- /// Gets or sets the server address
|
|
|
- /// </summary>
|
|
|
- /// <value>The server address.</value>
|
|
|
- string ServerAddress { get; }
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets or sets the type of the client.
|
|
|
- /// </summary>
|
|
|
- /// <value>The type of the client.</value>
|
|
|
- string ClientName { get; set; }
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the device.
|
|
|
- /// </summary>
|
|
|
- /// <value>The device.</value>
|
|
|
- IDevice Device { get; }
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets or sets the name of the device.
|
|
|
- /// </summary>
|
|
|
- /// <value>The name of the device.</value>
|
|
|
- string DeviceName { get; }
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets or sets the device id.
|
|
|
- /// </summary>
|
|
|
- /// <value>The device id.</value>
|
|
|
- string DeviceId { get; }
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets or sets the current user id.
|
|
|
- /// </summary>
|
|
|
- /// <value>The current user id.</value>
|
|
|
- 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();
|
|
|
-
|
|
|
- /// <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 synchronize job updates.
|
|
|
- /// </summary>
|
|
|
- /// <param name="intervalMs">The interval ms.</param>
|
|
|
- /// <param name="jobId">The job identifier.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task StartReceivingSyncJobUpdates(int intervalMs, string jobId);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Stops the receiving synchronize job updates.
|
|
|
- /// </summary>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task StopReceivingSyncJobUpdates();
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Starts the receiving synchronize jobs updates.
|
|
|
- /// </summary>
|
|
|
- /// <param name="intervalMs">The interval ms.</param>
|
|
|
- /// <param name="userId">The user identifier.</param>
|
|
|
- /// <param name="targetId">The target identifier.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task StartReceivingSyncJobsUpdates(int intervalMs, string userId, string targetId);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Stops the receiving synchronize jobs updates.
|
|
|
- /// </summary>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task StopReceivingSyncJobsUpdates();
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Starts the receiving session updates.
|
|
|
- /// </summary>
|
|
|
- /// <param name="intervalMs">The interval ms.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task StartReceivingSessionUpdates(int intervalMs);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Stops the receiving session updates.
|
|
|
- /// </summary>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task StopReceivingSessionUpdates();
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the image URL.
|
|
|
- /// </summary>
|
|
|
- /// <param name="item">The item.</param>
|
|
|
- /// <param name="options">The options.</param>
|
|
|
- /// <returns>System.String.</returns>
|
|
|
- /// <exception cref="ArgumentNullException">item</exception>
|
|
|
- string GetImageUrl(BaseItemDto 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(ChannelInfoDto item, ImageOptions options);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the subtitle URL.
|
|
|
- /// </summary>
|
|
|
- /// <param name="options">The options.</param>
|
|
|
- /// <returns>System.String.</returns>
|
|
|
- string GetSubtitleUrl(SubtitleDownloadOptions options);
|
|
|
-
|
|
|
- /// <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>
|
|
|
- /// <exception cref="ArgumentNullException">itemId</exception>
|
|
|
- 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>
|
|
|
- /// <exception cref="ArgumentNullException">user</exception>
|
|
|
- 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>
|
|
|
- /// <exception cref="ArgumentNullException">userId</exception>
|
|
|
- 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>
|
|
|
- /// <exception cref="ArgumentNullException">item</exception>
|
|
|
- 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>
|
|
|
- /// <exception cref="ArgumentNullException">name</exception>
|
|
|
- string GetGenreImageUrl(string name, ImageOptions options);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the music genre image URL.
|
|
|
- /// </summary>
|
|
|
- /// <param name="name">The name.</param>
|
|
|
- /// <param name="options">The options.</param>
|
|
|
- /// <returns>System.String.</returns>
|
|
|
- string GetMusicGenreImageUrl(string name, ImageOptions options);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the game genre image URL.
|
|
|
- /// </summary>
|
|
|
- /// <param name="name">The name.</param>
|
|
|
- /// <param name="options">The options.</param>
|
|
|
- /// <returns>System.String.</returns>
|
|
|
- string GetGameGenreImageUrl(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>
|
|
|
- /// <exception cref="ArgumentNullException">item</exception>
|
|
|
- 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>
|
|
|
- /// <exception cref="ArgumentNullException">item</exception>
|
|
|
- string GetLogoImageUrl(BaseItemDto item, ImageOptions options);
|
|
|
-
|
|
|
- /// <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);
|
|
|
-
|
|
|
- /// <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);
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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<BaseItemDto>> GetLiveTvRecordingsAsync(RecordingQuery query, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <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<BaseItemDto> GetLiveTvRecordingAsync(string id, string userId, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <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<BaseItemDto>> GetLiveTvRecordingGroupsAsync(RecordingGroupQuery query, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <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<BaseItemDto> GetLiveTvRecordingGroupAsync(string id, string userId, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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<BaseItemDto>> GetLiveTvProgramsAsync(ProgramQuery query, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <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<BaseItemDto> GetLiveTvProgramAsync(string id, string userId, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <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<BaseItemDto>> GetRecommendedLiveTvProgramsAsync(RecommendedProgramQuery query, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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));
|
|
|
-
|
|
|
- /// <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>
|
|
|
- /// <param name="userId">The user identifier.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task AddToPlaylist(string playlistId, IEnumerable<string> itemIds, string userId);
|
|
|
-
|
|
|
- /// <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);
|
|
|
-
|
|
|
- /// <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 = default(CancellationToken));
|
|
|
-
|
|
|
- /// <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>
|
|
|
- Task UploadFile(Stream stream,
|
|
|
- LocalFileInfo file,
|
|
|
- CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the devices options options.
|
|
|
- /// </summary>
|
|
|
- /// <returns>Task<DevicesOptions>.</returns>
|
|
|
- Task<DevicesOptions> GetDevicesOptions();
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Updates the item.
|
|
|
- /// </summary>
|
|
|
- /// <param name="item">The item.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task UpdateItem(BaseItemDto item);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Creates the synchronize job.
|
|
|
- /// </summary>
|
|
|
- /// <param name="request">The request.</param>
|
|
|
- /// <returns>Task<SyncJob>.</returns>
|
|
|
- Task<SyncJob> CreateSyncJob(SyncJobRequest request);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Updates the synchronize job.
|
|
|
- /// </summary>
|
|
|
- /// <param name="job">The job.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task UpdateSyncJob(SyncJob job);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the synchronize jobs.
|
|
|
- /// </summary>
|
|
|
- /// <param name="query">The query.</param>
|
|
|
- /// <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>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task<Stream>.</returns>
|
|
|
- Task<Stream> GetSyncJobItemFile(string id, CancellationToken cancellationToken = default(CancellationToken));
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the synchronize job item additional file.
|
|
|
- /// </summary>
|
|
|
- /// <param name="id">The identifier.</param>
|
|
|
- /// <param name="name">The name.</param>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task<Stream>.</returns>
|
|
|
- Task<Stream> GetSyncJobItemAdditionalFile(string id, string name, CancellationToken cancellationToken);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Opens the web socket.
|
|
|
- /// </summary>
|
|
|
- /// <param name="webSocketFactory">The web socket factory.</param>
|
|
|
- /// <param name="keepAliveTimerMs">The keep alive timer ms.</param>
|
|
|
- void OpenWebSocket(Func<IClientWebSocket> webSocketFactory, int keepAliveTimerMs = 60000);
|
|
|
-
|
|
|
- /// <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);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Synchronizes the data.
|
|
|
- /// </summary>
|
|
|
- /// <param name="request">The request.</param>
|
|
|
- /// <returns>Task<SyncDataResponse>.</returns>
|
|
|
- Task<SyncDataResponse> SyncData(SyncDataRequest request);
|
|
|
- /// <summary>
|
|
|
- /// Gets the synchronize job item file URL.
|
|
|
- /// </summary>
|
|
|
- /// <param name="id">The identifier.</param>
|
|
|
- /// <returns>System.String.</returns>
|
|
|
- string GetSyncJobItemFileUrl(string id);
|
|
|
- /// <summary>
|
|
|
- /// Marks the synchronize job item for removal.
|
|
|
- /// </summary>
|
|
|
- /// <param name="id">The identifier.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task MarkSyncJobItemForRemoval(string id);
|
|
|
- /// <summary>
|
|
|
- /// Unmarks the synchronize job item for removal.
|
|
|
- /// </summary>
|
|
|
- /// <param name="id">The identifier.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task UnmarkSyncJobItemForRemoval(string id);
|
|
|
- /// <summary>
|
|
|
- /// Queues the failed synchronize job item for retry.
|
|
|
- /// </summary>
|
|
|
- /// <param name="id">The identifier.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task QueueFailedSyncJobItemForRetry(string id);
|
|
|
- /// <summary>
|
|
|
- /// Cancels the synchronize job.
|
|
|
- /// </summary>
|
|
|
- /// <param name="id">The identifier.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task CancelSyncJob(string id);
|
|
|
- /// <summary>
|
|
|
- /// Cancels the synchronize job item.
|
|
|
- /// </summary>
|
|
|
- /// <param name="id">The identifier.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task CancelSyncJobItem(string id);
|
|
|
- /// <summary>
|
|
|
- /// Enables the cancelled synchronize job item.
|
|
|
- /// </summary>
|
|
|
- /// <param name="id">The identifier.</param>
|
|
|
- /// <returns>Task.</returns>
|
|
|
- Task EnableCancelledSyncJobItem(string id);
|
|
|
- /// <summary>
|
|
|
- /// Gets the synchronize options.
|
|
|
- /// </summary>
|
|
|
- /// <param name="jobInfo">The job information.</param>
|
|
|
- /// <returns>Task<SyncOptions>.</returns>
|
|
|
- Task<SyncDialogOptions> GetSyncOptions(SyncJobRequest jobInfo);
|
|
|
- /// <summary>
|
|
|
- /// Gets the synchronize options.
|
|
|
- /// </summary>
|
|
|
- /// <param name="jobInfo">The job information.</param>
|
|
|
- /// <returns>Task<SyncDialogOptions>.</returns>
|
|
|
- Task<SyncDialogOptions> GetSyncOptions(SyncJob jobInfo);
|
|
|
- /// <summary>
|
|
|
- /// Gets the movie recommendations.
|
|
|
- /// </summary>
|
|
|
- /// <param name="query">The query.</param>
|
|
|
- /// <returns>Task<List<RecommendationDto>>.</returns>
|
|
|
- Task<List<RecommendationDto>> GetMovieRecommendations(MovieRecommendationQuery query);
|
|
|
- /// <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);
|
|
|
- /// <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);
|
|
|
- /// <summary>
|
|
|
- /// Gets the supported bitrate.
|
|
|
- /// </summary>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>Task<System.Int32>.</returns>
|
|
|
- Task<int> DetectMaxBitrate(CancellationToken cancellationToken);
|
|
|
-
|
|
|
- /// <summary>
|
|
|
- /// Gets the end point information.
|
|
|
- /// </summary>
|
|
|
- /// <param name="cancellationToken">The cancellation token.</param>
|
|
|
- /// <returns>System.Threading.Tasks.Task<MediaBrowser.Model.Net.EndPointInfo>.</returns>
|
|
|
- Task<EndPointInfo> GetEndPointInfo(CancellationToken cancellationToken);
|
|
|
- }
|
|
|
-}
|