2013-06-03 02:21:35 +02:00
using MediaBrowser.Model.Configuration ;
using MediaBrowser.Model.Dto ;
using MediaBrowser.Model.Entities ;
using MediaBrowser.Model.Globalization ;
2013-07-07 06:48:26 +02:00
using MediaBrowser.Model.Notifications ;
2013-06-03 02:21:35 +02:00
using MediaBrowser.Model.Plugins ;
using MediaBrowser.Model.Querying ;
2013-08-07 21:15:55 +02:00
using MediaBrowser.Model.Search ;
2013-06-03 02:21:35 +02:00
using MediaBrowser.Model.Serialization ;
using MediaBrowser.Model.Session ;
using MediaBrowser.Model.System ;
using MediaBrowser.Model.Tasks ;
2013-07-27 17:48:35 +02:00
using MediaBrowser.Model.Users ;
2013-06-03 02:21:35 +02:00
using System ;
using System.Collections.Generic ;
using System.IO ;
2013-08-12 21:13:36 +02:00
using System.Threading ;
2013-06-03 02:21:35 +02:00
using System.Threading.Tasks ;
2013-06-03 02:27:31 +02:00
namespace MediaBrowser.Model.ApiClient
2013-06-03 02:21:35 +02:00
{
public interface IApiClient : IDisposable
{
2013-07-09 04:38:18 +02:00
/// <summary>
/// Occurs when [HTTP response received].
/// </summary>
event EventHandler < HttpResponseEventArgs > HttpResponseReceived ;
2013-07-21 16:20:57 +02:00
/// <summary>
/// Gets the critic reviews.
/// </summary>
/// <param name="itemId">The item id.</param>
/// <param name="startIndex">The start index.</param>
/// <param name="limit">The limit.</param>
/// <returns>Task{ItemReviewsResult}.</returns>
2013-08-21 22:08:42 +02:00
Task < ItemReviewsResult > GetCriticReviews ( string itemId , CancellationToken cancellationToken , int? startIndex = null , int? limit = null ) ;
2013-07-21 16:20:57 +02:00
2013-07-10 22:06:11 +02:00
/// <summary>
/// Gets the theme songs async.
/// </summary>
/// <param name="userId">The user id.</param>
/// <param name="itemId">The item id.</param>
/// <param name="inheritFromParents">if set to <c>true</c> [inherit from parents].</param>
/// <returns>Task{ThemeMediaResult}.</returns>
2013-08-22 00:12:42 +02:00
Task < ThemeMediaResult > GetThemeSongsAsync ( string userId , string itemId , bool inheritFromParents , CancellationToken cancellationToken ) ;
2013-07-10 22:06:11 +02:00
2013-08-07 21:15:55 +02:00
/// <summary>
/// Gets the search hints async.
/// </summary>
/// <param name="userId">The user id.</param>
/// <param name="searchTerm">The search term.</param>
/// <param name="startIndex">The start index.</param>
/// <param name="limit">The limit.</param>
/// <returns>Task{SearchHintResult}.</returns>
Task < SearchHintResult > GetSearchHintsAsync ( string userId , string searchTerm , int? startIndex = null ,
int? limit = null ) ;
2013-07-10 22:06:11 +02:00
/// <summary>
/// Gets the theme videos async.
/// </summary>
/// <param name="userId">The user id.</param>
/// <param name="itemId">The item id.</param>
/// <param name="inheritFromParents">if set to <c>true</c> [inherit from parents].</param>
/// <returns>Task{ThemeMediaResult}.</returns>
2013-08-22 00:12:42 +02:00
Task < ThemeMediaResult > GetThemeVideosAsync ( string userId , string itemId , bool inheritFromParents , CancellationToken cancellationToken ) ;
2013-07-10 22:06:11 +02:00
/// <summary>
/// Gets all theme media async.
/// </summary>
/// <param name="userId">The user id.</param>
/// <param name="itemId">The item id.</param>
/// <param name="inheritFromParents">if set to <c>true</c> [inherit from parents].</param>
/// <returns>Task{AllThemeMediaResult}.</returns>
2013-08-22 00:12:42 +02:00
Task < AllThemeMediaResult > GetAllThemeMediaAsync ( string userId , string itemId , bool inheritFromParents , CancellationToken cancellationToken ) ;
2013-07-21 16:20:57 +02:00
2013-07-07 06:48:26 +02:00
/// <summary>
/// Marks the notifications read.
/// </summary>
/// <param name="userId">The user id.</param>
/// <param name="notificationIdList">The notification id list.</param>
/// <param name="isRead">if set to <c>true</c> [is read].</param>
/// <returns>Task.</returns>
Task MarkNotificationsRead ( string userId , IEnumerable < Guid > notificationIdList , bool isRead ) ;
/// <summary>
/// Updates the notification.
/// </summary>
/// <param name="notification">The notification.</param>
/// <returns>Task.</returns>
Task UpdateNotification ( Notification notification ) ;
/// <summary>
/// Adds the notification.
/// </summary>
/// <param name="notification">The notification.</param>
/// <returns>Task{Notification}.</returns>
Task < Notification > AddNotification ( Notification notification ) ;
/// <summary>
/// Gets the notifications summary.
/// </summary>
/// <param name="userId">The user id.</param>
/// <returns>Task{NotificationsSummary}.</returns>
Task < NotificationsSummary > GetNotificationsSummary ( string userId ) ;
/// <summary>
2013-07-07 06:54:16 +02:00
/// Gets the notifications async.
2013-07-07 06:48:26 +02:00
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{NotificationResult}.</returns>
2013-07-07 06:54:16 +02:00
Task < NotificationResult > GetNotificationsAsync ( NotificationQuery query ) ;
2013-07-07 06:48:26 +02:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets an image stream based on a url
/// </summary>
/// <param name="url">The URL.</param>
2013-08-12 21:13:36 +02:00
/// <param name="cancellationToken">The cancellation token.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task{Stream}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">url</exception>
2013-08-12 21:13:36 +02:00
Task < Stream > GetImageStreamAsync ( string url , CancellationToken cancellationToken ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets a BaseItem
/// </summary>
/// <param name="id">The id.</param>
/// <param name="userId">The user id.</param>
/// <returns>Task{BaseItemDto}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">id</exception>
2013-06-03 02:21:35 +02:00
Task < BaseItemDto > GetItemAsync ( string id , string userId ) ;
/// <summary>
/// Gets the intros async.
/// </summary>
/// <param name="itemId">The item id.</param>
/// <param name="userId">The user id.</param>
/// <returns>Task{System.String[]}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">id</exception>
2013-06-03 02:21:35 +02:00
Task < string [ ] > GetIntrosAsync ( string itemId , string userId ) ;
/// <summary>
/// Gets a BaseItem
/// </summary>
/// <param name="userId">The user id.</param>
/// <returns>Task{BaseItemDto}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-06-03 02:21:35 +02:00
Task < BaseItemDto > GetRootFolderAsync ( string userId ) ;
/// <summary>
2013-06-03 04:17:13 +02:00
/// Gets the users async.
2013-06-03 02:21:35 +02:00
/// </summary>
/// <returns>Task{UserDto[]}.</returns>
2013-07-09 20:37:41 +02:00
Task < UserDto [ ] > GetUsersAsync ( UserQuery query ) ;
2013-06-03 02:21:35 +02:00
2013-07-09 18:11:16 +02:00
/// <summary>
/// Gets the public users async.
/// </summary>
/// <returns>Task{UserDto[]}.</returns>
2013-08-21 22:08:42 +02:00
Task < UserDto [ ] > GetPublicUsersAsync ( CancellationToken cancellationToken ) ;
2013-07-21 16:20:57 +02:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets active client sessions.
/// </summary>
/// <returns>Task{SessionInfoDto[]}.</returns>
Task < SessionInfoDto [ ] > GetClientSessionsAsync ( ) ;
2013-06-22 20:15:31 +02:00
/// <summary>
/// Gets the item counts async.
/// </summary>
/// <param name="userId">The user id.</param>
/// <returns>Task{ItemCounts}.</returns>
Task < ItemCounts > GetItemCountsAsync ( string userId ) ;
2013-07-07 06:48:26 +02:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Queries for items
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">query</exception>
2013-06-03 02:21:35 +02:00
Task < ItemsResult > GetItemsAsync ( ItemQuery query ) ;
2013-08-10 03:16:31 +02:00
/// <summary>
/// Gets the instant mix from song async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
Task < ItemsResult > GetInstantMixFromSongAsync ( SimilarItemsQuery query ) ;
/// <summary>
/// Gets the instant mix from album async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
Task < ItemsResult > GetInstantMixFromAlbumAsync ( SimilarItemsQuery query ) ;
/// <summary>
/// Gets the instant mix from artist async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
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-08-21 22:08:42 +02:00
2013-06-04 04:02:49 +02:00
/// <summary>
/// Gets the similar movies async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
Task < ItemsResult > GetSimilarMoviesAsync ( SimilarItemsQuery query ) ;
2013-07-12 21:56:40 +02:00
/// <summary>
/// Gets the similar trailers async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
Task < ItemsResult > GetSimilarTrailersAsync ( SimilarItemsQuery query ) ;
2013-07-21 16:20:57 +02:00
2013-06-04 04:02:49 +02:00
/// <summary>
/// Gets the similar series async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
Task < ItemsResult > GetSimilarSeriesAsync ( SimilarItemsQuery query ) ;
/// <summary>
/// Gets the similar albums async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
Task < ItemsResult > GetSimilarAlbumsAsync ( SimilarItemsQuery query ) ;
/// <summary>
/// Gets the similar games async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
Task < ItemsResult > GetSimilarGamesAsync ( SimilarItemsQuery query ) ;
2013-07-07 06:48:26 +02:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets the people async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-06-03 02:21:35 +02:00
Task < ItemsResult > GetPeopleAsync ( PersonsQuery query ) ;
/// <summary>
/// Gets the artists.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-06-03 02:21:35 +02:00
Task < ItemsResult > GetArtistsAsync ( ArtistsQuery query ) ;
/// <summary>
/// Gets a studio
/// </summary>
/// <param name="name">The name.</param>
2013-07-27 19:18:10 +02:00
/// <param name="userId">The user id.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task{BaseItemDto}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-07-27 19:18:10 +02:00
Task < BaseItemDto > GetStudioAsync ( string name , string userId ) ;
2013-06-03 02:21:35 +02:00
2013-06-17 03:48:55 +02:00
/// <summary>
/// Gets the next up async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
Task < ItemsResult > GetNextUpAsync ( NextUpQuery query ) ;
2013-07-07 06:48:26 +02:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets a genre
/// </summary>
/// <param name="name">The name.</param>
2013-07-27 19:18:10 +02:00
/// <param name="userId">The user id.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task{BaseItemDto}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-07-27 19:18:10 +02:00
Task < BaseItemDto > GetGenreAsync ( string name , string userId ) ;
2013-06-03 02:21:35 +02:00
2013-08-03 18:06:45 +02:00
/// <summary>
/// Gets the genres async.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Task{ItemsResult}.</returns>
Task < ItemsResult > GetGenresAsync ( ItemsByNameQuery query ) ;
/// <summary>
/// Gets the 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 ) ;
2013-08-21 22:08:42 +02:00
2013-07-27 20:24:48 +02:00
/// <summary>
/// Gets the music genre async.
/// </summary>
/// <param name="name">The name.</param>
/// <param name="userId">The user id.</param>
/// <returns>Task{BaseItemDto}.</returns>
Task < BaseItemDto > GetMusicGenreAsync ( string name , string userId ) ;
/// <summary>
/// Gets the game genre async.
/// </summary>
/// <param name="name">The name.</param>
/// <param name="userId">The user id.</param>
/// <returns>Task{BaseItemDto}.</returns>
Task < BaseItemDto > GetGameGenreAsync ( string name , string userId ) ;
2013-08-21 22:08:42 +02:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets the artist async.
/// </summary>
/// <param name="name">The name.</param>
2013-07-27 19:18:10 +02:00
/// <param name="userId">The user id.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task{BaseItemDto}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">name</exception>
2013-07-27 19:18:10 +02:00
Task < BaseItemDto > GetArtistAsync ( string name , string userId ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
2013-07-07 17:55:05 +02:00
/// Restarts the server.
2013-06-03 02:21:35 +02:00
/// </summary>
/// <returns>Task.</returns>
2013-07-07 17:55:05 +02:00
Task RestartServerAsync ( ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets the system status async.
/// </summary>
/// <returns>Task{SystemInfo}.</returns>
Task < SystemInfo > GetSystemInfoAsync ( ) ;
/// <summary>
/// Gets a person
/// </summary>
/// <param name="name">The name.</param>
2013-07-27 19:18:10 +02:00
/// <param name="userId">The user id.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task{BaseItemDto}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-07-27 19:18:10 +02:00
Task < BaseItemDto > GetPersonAsync ( string name , string userId ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets a list of plugins installed on the server
/// </summary>
/// <returns>Task{PluginInfo[]}.</returns>
Task < PluginInfo [ ] > GetInstalledPluginsAsync ( ) ;
/// <summary>
/// Gets the current server configuration
/// </summary>
/// <returns>Task{ServerConfiguration}.</returns>
Task < ServerConfiguration > GetServerConfigurationAsync ( ) ;
/// <summary>
/// Gets the scheduled tasks.
/// </summary>
/// <returns>Task{TaskInfo[]}.</returns>
Task < TaskInfo [ ] > GetScheduledTasksAsync ( ) ;
/// <summary>
/// Gets the scheduled task async.
/// </summary>
/// <param name="id">The id.</param>
/// <returns>Task{TaskInfo}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">id</exception>
2013-06-03 02:21:35 +02:00
Task < TaskInfo > GetScheduledTaskAsync ( Guid id ) ;
/// <summary>
/// Gets a user by id
/// </summary>
/// <param name="id">The id.</param>
/// <returns>Task{UserDto}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">id</exception>
2013-06-03 02:21:35 +02:00
Task < UserDto > GetUserAsync ( string id ) ;
/// <summary>
/// Gets the parental ratings async.
/// </summary>
/// <returns>Task{List{ParentalRating}}.</returns>
Task < List < ParentalRating > > GetParentalRatingsAsync ( ) ;
/// <summary>
/// Gets local trailers for an item
/// </summary>
/// <param name="userId">The user id.</param>
/// <param name="itemId">The item id.</param>
/// <returns>Task{ItemsResult}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">query</exception>
2013-06-03 02:21:35 +02:00
Task < BaseItemDto [ ] > GetLocalTrailersAsync ( string userId , string itemId ) ;
/// <summary>
/// Gets special features for an item
/// </summary>
/// <param name="userId">The user id.</param>
/// <param name="itemId">The item id.</param>
/// <returns>Task{BaseItemDto[]}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-06-03 02:21:35 +02:00
Task < BaseItemDto [ ] > GetSpecialFeaturesAsync ( string userId , string itemId ) ;
/// <summary>
/// Gets the cultures async.
/// </summary>
/// <returns>Task{CultureDto[]}.</returns>
Task < CultureDto [ ] > GetCulturesAsync ( ) ;
/// <summary>
/// Gets the countries async.
/// </summary>
/// <returns>Task{CountryInfo[]}.</returns>
Task < CountryInfo [ ] > GetCountriesAsync ( ) ;
/// <summary>
/// Marks an item as played or unplayed.
/// This should not be used to update playstate following playback.
/// There are separate playstate check-in methods for that. This should be used for a
/// separate option to reset playstate.
/// </summary>
/// <param name="itemId">The item id.</param>
/// <param name="userId">The user id.</param>
/// <param name="wasPlayed">if set to <c>true</c> [was played].</param>
/// <returns>Task.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">itemId</exception>
2013-08-22 23:56:19 +02:00
Task < UserItemDataDto > UpdatePlayedStatusAsync ( string itemId , string userId , bool wasPlayed ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Updates the favorite status async.
/// </summary>
/// <param name="itemId">The item id.</param>
/// <param name="userId">The user id.</param>
/// <param name="isFavorite">if set to <c>true</c> [is favorite].</param>
/// <returns>Task.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">itemId</exception>
2013-08-22 23:56:19 +02:00
Task < UserItemDataDto > UpdateFavoriteStatusAsync ( string itemId , string userId , bool isFavorite ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Reports to the server that the user has begun playing an item
/// </summary>
/// <param name="itemId">The item id.</param>
/// <param name="userId">The user id.</param>
/// <returns>Task{UserItemDataDto}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">itemId</exception>
2013-06-03 02:21:35 +02:00
Task ReportPlaybackStartAsync ( string itemId , string userId ) ;
/// <summary>
/// Reports playback progress to the server
/// </summary>
/// <param name="itemId">The item id.</param>
/// <param name="userId">The user id.</param>
/// <param name="positionTicks">The position ticks.</param>
/// <param name="isPaused">if set to <c>true</c> [is paused].</param>
/// <returns>Task{UserItemDataDto}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">itemId</exception>
2013-06-03 02:21:35 +02:00
Task ReportPlaybackProgressAsync ( string itemId , string userId , long? positionTicks , bool isPaused ) ;
/// <summary>
/// Reports to the server that the user has stopped playing an item
/// </summary>
/// <param name="itemId">The item id.</param>
/// <param name="userId">The user id.</param>
/// <param name="positionTicks">The position ticks.</param>
/// <returns>Task{UserItemDataDto}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">itemId</exception>
2013-06-03 02:21:35 +02:00
Task ReportPlaybackStoppedAsync ( string itemId , string userId , long? positionTicks ) ;
/// <summary>
/// Instructs antoher 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>
/// <param name="context">Optional ui context (movies, music, tv, games, etc). The client is free to ignore this.</param>
/// <returns>Task.</returns>
Task SendBrowseCommandAsync ( string sessionId , string itemId , string itemName , string itemType , string context ) ;
2013-07-09 18:11:16 +02:00
/// <summary>
/// Sends the playstate command async.
/// </summary>
/// <param name="sessionId">The session id.</param>
/// <param name="request">The request.</param>
/// <returns>Task.</returns>
2013-07-09 18:16:52 +02:00
Task SendPlaystateCommandAsync ( string sessionId , PlaystateRequest request ) ;
2013-07-09 18:11:16 +02:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Sends the play command async.
/// </summary>
/// <param name="sessionId">The session id.</param>
/// <param name="request">The request.</param>
/// <returns>Task.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">
2013-06-03 02:21:35 +02:00
/// sessionId
/// or
/// request
/// </exception>
Task SendPlayCommandAsync ( string sessionId , PlayRequest request ) ;
2013-08-28 06:42:56 +02:00
/// <summary>
/// Sends a system command to the client
/// </summary>
/// <param name="sessionId"></param>
/// <param name="command"></param>
/// <returns></returns>
Task SendSystemCommandAsync ( string sessionId , SystemCommand command ) ;
/// <summary>
/// Instructs the client to display a message to the user
/// </summary>
/// <param name="sessionId"></param>
/// <param name="command"></param>
/// <returns></returns>
Task SendMessageCommandAsync ( string sessionId , MessageCommand command ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Clears a user's rating for an item
/// </summary>
/// <param name="itemId">The item id.</param>
/// <param name="userId">The user id.</param>
/// <returns>Task{UserItemDataDto}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">itemId</exception>
2013-08-22 23:56:19 +02:00
Task < UserItemDataDto > ClearUserItemRatingAsync ( string itemId , string userId ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Updates a user's rating for an item, based on likes or dislikes
/// </summary>
/// <param name="itemId">The item id.</param>
/// <param name="userId">The user id.</param>
/// <param name="likes">if set to <c>true</c> [likes].</param>
/// <returns>Task.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">itemId</exception>
2013-08-22 23:56:19 +02:00
Task < UserItemDataDto > UpdateUserItemRatingAsync ( string itemId , string userId , bool likes ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Authenticates a user and returns the result
/// </summary>
2013-07-27 17:40:53 +02:00
/// <param name="username">The username.</param>
2013-06-03 02:21:35 +02:00
/// <param name="sha1Hash">The sha1 hash.</param>
/// <returns>Task.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-07-27 17:48:35 +02:00
Task < AuthenticationResult > AuthenticateUserAsync ( string username , byte [ ] sha1Hash ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Updates the server configuration async.
/// </summary>
/// <param name="configuration">The configuration.</param>
/// <returns>Task.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">configuration</exception>
2013-06-03 02:21:35 +02:00
Task UpdateServerConfigurationAsync ( ServerConfiguration configuration ) ;
/// <summary>
/// Updates the scheduled task triggers.
/// </summary>
/// <param name="id">The id.</param>
/// <param name="triggers">The triggers.</param>
/// <returns>Task{RequestResult}.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">id</exception>
2013-06-03 02:21:35 +02:00
Task UpdateScheduledTaskTriggersAsync ( Guid id , TaskTriggerInfo [ ] triggers ) ;
/// <summary>
/// Gets the display preferences.
/// </summary>
/// <param name="id">The id.</param>
2013-07-27 03:15:55 +02:00
/// <param name="userId">The user id.</param>
/// <param name="client">The client.</param>
2013-06-03 02:21:35 +02:00
/// <returns>Task{BaseItemDto}.</returns>
2013-08-21 22:08:42 +02:00
Task < DisplayPreferences > GetDisplayPreferencesAsync ( string id , string userId , string client , CancellationToken cancellationToken ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Updates display preferences for a user
/// </summary>
/// <param name="id">The id.</param>
/// <param name="displayPreferences">The display preferences.</param>
/// <returns>Task{DisplayPreferences}.</returns>
/// <exception cref="System.ArgumentNullException">userId</exception>
2013-07-27 03:15:55 +02:00
Task UpdateDisplayPreferencesAsync ( DisplayPreferences displayPreferences , string userId , string client ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
/// Posts a set of data to a url, and deserializes the return stream into T
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="url">The URL.</param>
/// <param name="args">The args.</param>
/// <returns>Task{``0}.</returns>
Task < T > PostAsync < T > ( string url , Dictionary < string , string > args )
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 host name (myserver or 192.168.x.x)
/// </summary>
/// <value>The name of the server host.</value>
string ServerHostName { get ; set ; }
/// <summary>
/// Gets or sets the port number used by the API
/// </summary>
/// <value>The server API port.</value>
int ServerApiPort { get ; set ; }
/// <summary>
/// Gets or sets the type of the client.
/// </summary>
/// <value>The type of the client.</value>
string ClientName { get ; set ; }
/// <summary>
/// Gets or sets the name of the device.
/// </summary>
/// <value>The name of the device.</value>
string DeviceName { get ; set ; }
/// <summary>
/// Gets or sets the device id.
/// </summary>
/// <value>The device id.</value>
string DeviceId { get ; set ; }
/// <summary>
/// Gets or sets the current user id.
/// </summary>
/// <value>The current user id.</value>
string CurrentUserId { get ; set ; }
/// <summary>
/// Gets the image URL.
/// </summary>
/// <param name="item">The item.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">item</exception>
2013-06-03 02:21:35 +02:00
string GetImageUrl ( BaseItemDto item , ImageOptions options ) ;
/// <summary>
/// Gets an image url that can be used to download an image from the api
/// </summary>
/// <param name="itemId">The Id of the item</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">itemId</exception>
2013-06-03 02:21:35 +02:00
string GetImageUrl ( string itemId , ImageOptions options ) ;
/// <summary>
/// Gets the user image URL.
/// </summary>
/// <param name="user">The user.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">user</exception>
2013-06-03 02:21:35 +02:00
string GetUserImageUrl ( UserDto user , ImageOptions options ) ;
/// <summary>
/// Gets an image url that can be used to download an image from the api
/// </summary>
/// <param name="userId">The Id of the user</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">userId</exception>
2013-06-03 02:21:35 +02:00
string GetUserImageUrl ( string userId , ImageOptions options ) ;
/// <summary>
/// Gets the person image URL.
/// </summary>
/// <param name="item">The item.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">item</exception>
2013-06-03 02:21:35 +02:00
string GetPersonImageUrl ( BaseItemPerson item , ImageOptions options ) ;
/// <summary>
/// Gets an image url that can be used to download an image from the api
/// </summary>
/// <param name="name">The name of the person</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">name</exception>
2013-06-03 02:21:35 +02:00
string GetPersonImageUrl ( string name , ImageOptions options ) ;
/// <summary>
/// Gets the year image URL.
/// </summary>
/// <param name="item">The item.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">item</exception>
2013-06-03 02:21:35 +02:00
string GetYearImageUrl ( BaseItemDto 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 02:27:31 +02:00
/// <exception cref="ArgumentNullException">name</exception>
2013-06-03 02:21:35 +02:00
string GetGenreImageUrl ( string name , ImageOptions options ) ;
/// <summary>
2013-07-29 22:44:49 +02:00
/// Gets the music genre image URL.
2013-06-03 02:21:35 +02:00
/// </summary>
2013-07-29 22:44:49 +02:00
/// <param name="name">The name.</param>
2013-06-03 02:21:35 +02:00
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-07-29 22:44:49 +02:00
string GetMusicGenreImageUrl ( string name , ImageOptions options ) ;
2013-06-03 02:21:35 +02:00
/// <summary>
2013-07-29 22:44:49 +02:00
/// Gets the game genre image URL.
2013-06-03 02:21:35 +02:00
/// </summary>
/// <param name="name">The name.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-07-29 22:44:49 +02:00
string GetGameGenreImageUrl ( string name , ImageOptions options ) ;
2013-08-21 22:08:42 +02:00
2013-06-03 02:21:35 +02:00
/// <summary>
2013-07-29 22:44:49 +02:00
/// Gets an image url that can be used to download an image from the api
2013-06-03 02:21:35 +02:00
/// </summary>
2013-07-29 22:44:49 +02:00
/// <param name="name">The name.</param>
2013-06-03 02:21:35 +02:00
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-07-29 22:44:49 +02:00
/// <exception cref="ArgumentNullException">name</exception>
string GetStudioImageUrl ( string name , ImageOptions options ) ;
2013-06-03 02:21:35 +02: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 02:27:31 +02:00
/// <exception cref="ArgumentNullException">name</exception>
2013-06-03 02:21:35 +02: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 02:27:31 +02:00
/// <exception cref="ArgumentNullException">item</exception>
2013-06-03 02:21:35 +02:00
string [ ] GetBackdropImageUrls ( BaseItemDto item , ImageOptions options ) ;
/// <summary>
/// This is a helper to get the logo image url from a given ApiBaseItemWrapper. If the actual item does not have a logo, it will return the logo from the first parent that does, or null.
/// </summary>
/// <param name="item">A given item.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">item</exception>
2013-06-03 02:21:35 +02:00
string GetLogoImageUrl ( BaseItemDto item , ImageOptions options ) ;
2013-07-08 21:31:45 +02:00
/// <summary>
/// Gets the art image URL.
/// </summary>
/// <param name="item">The item.</param>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
string GetArtImageUrl ( BaseItemDto item , ImageOptions options ) ;
2013-07-21 16:20:57 +02:00
2013-06-03 02:21:35 +02:00
/// <summary>
/// Gets the url needed to stream an audio file
/// </summary>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">options</exception>
2013-06-03 02:21:35 +02:00
string GetAudioStreamUrl ( StreamOptions options ) ;
/// <summary>
/// Gets the url needed to stream a video file
/// </summary>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">options</exception>
2013-06-03 02:21:35 +02:00
string GetVideoStreamUrl ( VideoStreamOptions options ) ;
/// <summary>
/// Formulates a url for streaming audio using the HLS protocol
/// </summary>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">options</exception>
2013-06-03 02:21:35 +02:00
string GetHlsAudioStreamUrl ( StreamOptions options ) ;
/// <summary>
/// Formulates a url for streaming video using the HLS protocol
/// </summary>
/// <param name="options">The options.</param>
/// <returns>System.String.</returns>
2013-06-03 02:27:31 +02:00
/// <exception cref="ArgumentNullException">options</exception>
2013-06-03 02:21:35 +02:00
string GetHlsVideoStreamUrl ( VideoStreamOptions options ) ;
}
}