diff options
Diffstat (limited to 'MediaBrowser.Model/ApiClient/IApiClient.cs')
| -rw-r--r-- | MediaBrowser.Model/ApiClient/IApiClient.cs | 614 |
1 files changed, 614 insertions, 0 deletions
diff --git a/MediaBrowser.Model/ApiClient/IApiClient.cs b/MediaBrowser.Model/ApiClient/IApiClient.cs new file mode 100644 index 000000000..c7d584f81 --- /dev/null +++ b/MediaBrowser.Model/ApiClient/IApiClient.cs @@ -0,0 +1,614 @@ +using MediaBrowser.Model.Configuration; +using MediaBrowser.Model.Dto; +using MediaBrowser.Model.Entities; +using MediaBrowser.Model.Globalization; +using MediaBrowser.Model.Plugins; +using MediaBrowser.Model.Querying; +using MediaBrowser.Model.Serialization; +using MediaBrowser.Model.Session; +using MediaBrowser.Model.System; +using MediaBrowser.Model.Tasks; +using MediaBrowser.Model.Weather; +using System; +using System.Collections.Generic; +using System.IO; +using System.Threading.Tasks; + +namespace MediaBrowser.ApiInteraction +{ + public interface IApiClient : IDisposable + { + /// <summary> + /// Gets an image stream based on a url + /// </summary> + /// <param name="url">The URL.</param> + /// <returns>Task{Stream}.</returns> + /// <exception cref="System.ArgumentNullException">url</exception> + Task<Stream> GetImageStreamAsync(string url); + + /// <summary> + /// Gets a BaseItem + /// </summary> + /// <param name="id">The id.</param> + /// <param name="userId">The user id.</param> + /// <returns>Task{BaseItemDto}.</returns> + /// <exception cref="System.ArgumentNullException">id</exception> + 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> + /// <exception cref="System.ArgumentNullException">id</exception> + Task<string[]> GetIntrosAsync(string itemId, string userId); + + /// <summary> + /// Gets a BaseItem + /// </summary> + /// <param name="userId">The user id.</param> + /// <returns>Task{BaseItemDto}.</returns> + /// <exception cref="System.ArgumentNullException">userId</exception> + Task<BaseItemDto> GetRootFolderAsync(string userId); + + /// <summary> + /// Gets all Users + /// </summary> + /// <returns>Task{UserDto[]}.</returns> + Task<UserDto[]> GetAllUsersAsync(); + + /// <summary> + /// Gets active client sessions. + /// </summary> + /// <returns>Task{SessionInfoDto[]}.</returns> + Task<SessionInfoDto[]> GetClientSessionsAsync(); + + /// <summary> + /// Queries for items + /// </summary> + /// <param name="query">The query.</param> + /// <returns>Task{ItemsResult}.</returns> + /// <exception cref="System.ArgumentNullException">query</exception> + Task<ItemsResult> GetItemsAsync(ItemQuery query); + + /// <summary> + /// Gets the people async. + /// </summary> + /// <param name="query">The query.</param> + /// <returns>Task{ItemsResult}.</returns> + /// <exception cref="System.ArgumentNullException">userId</exception> + Task<ItemsResult> GetPeopleAsync(PersonsQuery query); + + /// <summary> + /// Gets the artists. + /// </summary> + /// <param name="query">The query.</param> + /// <returns>Task{ItemsResult}.</returns> + /// <exception cref="System.ArgumentNullException">userId</exception> + Task<ItemsResult> GetArtistsAsync(ArtistsQuery query); + + /// <summary> + /// Gets a studio + /// </summary> + /// <param name="name">The name.</param> + /// <returns>Task{BaseItemDto}.</returns> + /// <exception cref="System.ArgumentNullException">userId</exception> + Task<BaseItemDto> GetStudioAsync(string name); + + /// <summary> + /// Gets a genre + /// </summary> + /// <param name="name">The name.</param> + /// <returns>Task{BaseItemDto}.</returns> + /// <exception cref="System.ArgumentNullException">userId</exception> + Task<BaseItemDto> GetGenreAsync(string name); + + /// <summary> + /// Gets the artist async. + /// </summary> + /// <param name="name">The name.</param> + /// <returns>Task{BaseItemDto}.</returns> + /// <exception cref="System.ArgumentNullException">name</exception> + Task<BaseItemDto> GetArtistAsync(string name); + + /// <summary> + /// Restarts the kernel or the entire server if necessary + /// If the server application is restarting this request will fail to return, even if + /// the operation is successful. + /// </summary> + /// <returns>Task.</returns> + Task PerformPendingRestartAsync(); + + /// <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> + /// <returns>Task{BaseItemDto}.</returns> + /// <exception cref="System.ArgumentNullException">userId</exception> + Task<BaseItemDto> GetPersonAsync(string name); + + /// <summary> + /// Gets a year + /// </summary> + /// <param name="year">The year.</param> + /// <returns>Task{BaseItemDto}.</returns> + /// <exception cref="System.ArgumentNullException">userId</exception> + Task<BaseItemDto> GetYearAsync(int year); + + /// <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="System.ArgumentNullException">id</exception> + Task<TaskInfo> GetScheduledTaskAsync(Guid id); + + /// <summary> + /// Gets a user by id + /// </summary> + /// <param name="id">The id.</param> + /// <returns>Task{UserDto}.</returns> + /// <exception cref="System.ArgumentNullException">id</exception> + Task<UserDto> GetUserAsync(string id); + + /// <summary> + /// Gets the parental ratings async. + /// </summary> + /// <returns>Task{List{ParentalRating}}.</returns> + Task<List<ParentalRating>> GetParentalRatingsAsync(); + + /// <summary> + /// Gets weather information for the default location as set in configuration + /// </summary> + /// <returns>Task{WeatherInfo}.</returns> + Task<WeatherInfo> GetWeatherInfoAsync(); + + /// <summary> + /// Gets weather information for a specific location + /// Location can be a US zipcode, or "city,state", "city,state,country", "city,country" + /// It can also be an ip address, or "latitude,longitude" + /// </summary> + /// <param name="location">The location.</param> + /// <returns>Task{WeatherInfo}.</returns> + /// <exception cref="System.ArgumentNullException">location</exception> + Task<WeatherInfo> GetWeatherInfoAsync(string location); + + /// <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="System.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="System.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 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> + /// <exception cref="System.ArgumentNullException">itemId</exception> + Task UpdatePlayedStatusAsync(string itemId, string userId, bool wasPlayed); + + /// <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="System.ArgumentNullException">itemId</exception> + Task UpdateFavoriteStatusAsync(string itemId, string userId, bool isFavorite); + + /// <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> + /// <exception cref="System.ArgumentNullException">itemId</exception> + 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> + /// <exception cref="System.ArgumentNullException">itemId</exception> + 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> + /// <exception cref="System.ArgumentNullException">itemId</exception> + 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); + + /// <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="System.ArgumentNullException"> + /// sessionId + /// or + /// request + /// </exception> + Task SendPlayCommandAsync(string sessionId, PlayRequest request); + + /// <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="System.ArgumentNullException">itemId</exception> + Task 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="System.ArgumentNullException">itemId</exception> + Task UpdateUserItemRatingAsync(string itemId, string userId, bool likes); + + /// <summary> + /// Authenticates a user and returns the result + /// </summary> + /// <param name="userId">The user id.</param> + /// <param name="sha1Hash">The sha1 hash.</param> + /// <returns>Task.</returns> + /// <exception cref="System.ArgumentNullException">userId</exception> + Task AuthenticateUserAsync(string userId, byte[] sha1Hash); + + /// <summary> + /// Updates the server configuration async. + /// </summary> + /// <param name="configuration">The configuration.</param> + /// <returns>Task.</returns> + /// <exception cref="System.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="System.ArgumentNullException">id</exception> + Task UpdateScheduledTaskTriggersAsync(Guid id, TaskTriggerInfo[] triggers); + + /// <summary> + /// Gets the display preferences. + /// </summary> + /// <param name="id">The id.</param> + /// <returns>Task{BaseItemDto}.</returns> + Task<DisplayPreferences> GetDisplayPreferencesAsync(string id); + + /// <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> + Task UpdateDisplayPreferencesAsync(DisplayPreferences displayPreferences); + + /// <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> + /// <exception cref="System.ArgumentNullException">item</exception> + 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> + /// <exception cref="System.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="System.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="System.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="System.ArgumentNullException">item</exception> + string GetPersonImageUrl(BaseItemPerson item, 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="System.ArgumentNullException">item</exception> + string GetPersonImageUrl(BaseItemDto 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> + /// <exception cref="System.ArgumentNullException">name</exception> + 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> + /// <exception cref="System.ArgumentNullException">item</exception> + 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 the genre image URL. + /// </summary> + /// <param name="item">The item.</param> + /// <param name="options">The options.</param> + /// <returns>System.String.</returns> + /// <exception cref="System.ArgumentNullException">item</exception> + string GetGenreImageUrl(BaseItemDto 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="System.ArgumentNullException">name</exception> + string GetGenreImageUrl(string name, ImageOptions options); + + /// <summary> + /// Gets the studio image URL. + /// </summary> + /// <param name="item">The item.</param> + /// <param name="options">The options.</param> + /// <returns>System.String.</returns> + /// <exception cref="System.ArgumentNullException">item</exception> + string GetStudioImageUrl(BaseItemDto 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="System.ArgumentNullException">name</exception> + string GetStudioImageUrl(string name, ImageOptions options); + + /// <summary> + /// Gets the artist image URL. + /// </summary> + /// <param name="item">The item.</param> + /// <param name="options">The options.</param> + /// <returns>System.String.</returns> + /// <exception cref="System.ArgumentNullException">item + /// or + /// options</exception> + string GetArtistImageUrl(BaseItemDto item, ImageOptions options); + + /// <summary> + /// Gets the artist image URL. + /// </summary> + /// <param name="name">The name.</param> + /// <param name="options">The options.</param> + /// <returns>System.String.</returns> + /// <exception cref="System.ArgumentNullException">name</exception> + 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> + /// <exception cref="System.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="System.ArgumentNullException">item</exception> + string GetLogoImageUrl(BaseItemDto item, ImageOptions options); + + /// <summary> + /// Gets the url needed to stream an audio file + /// </summary> + /// <param name="options">The options.</param> + /// <returns>System.String.</returns> + /// <exception cref="System.ArgumentNullException">options</exception> + 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> + /// <exception cref="System.ArgumentNullException">options</exception> + 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> + /// <exception cref="System.ArgumentNullException">options</exception> + 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> + /// <exception cref="System.ArgumentNullException">options</exception> + string GetHlsVideoStreamUrl(VideoStreamOptions options); + } +}
\ No newline at end of file |