mirror of
https://github.com/jellyfin/jellyfin.git
synced 2026-06-12 10:40:24 +01:00
add connection manager interface
This commit is contained in:
62
MediaBrowser.Model/ApiClient/IConnectionManager.cs
Normal file
62
MediaBrowser.Model/ApiClient/IConnectionManager.cs
Normal file
@@ -0,0 +1,62 @@
|
||||
using MediaBrowser.Model.Dto;
|
||||
using MediaBrowser.Model.Events;
|
||||
using System;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
|
||||
namespace MediaBrowser.Model.ApiClient
|
||||
{
|
||||
public interface IConnectionManager
|
||||
{
|
||||
/// <summary>
|
||||
/// Occurs when [connected].
|
||||
/// </summary>
|
||||
event EventHandler<GenericEventArgs<ConnectionResult>> Connected;
|
||||
|
||||
/// <summary>
|
||||
/// Gets the API client.
|
||||
/// </summary>
|
||||
/// <param name="item">The item.</param>
|
||||
/// <returns>MediaBrowser.Model.ApiClient.IApiClient.</returns>
|
||||
IApiClient GetApiClient(BaseItemDto item);
|
||||
|
||||
/// <summary>
|
||||
/// Connects the specified cancellation token.
|
||||
/// </summary>
|
||||
/// <param name="cancellationToken">The cancellation token.</param>
|
||||
/// <returns>Task<ConnectionResult>.</returns>
|
||||
Task<ConnectionResult> Connect(CancellationToken cancellationToken);
|
||||
|
||||
/// <summary>
|
||||
/// Connects the specified server.
|
||||
/// </summary>
|
||||
/// <param name="server">The server.</param>
|
||||
/// <param name="cancellationToken">The cancellation token.</param>
|
||||
/// <returns>Task<ConnectionResult>.</returns>
|
||||
Task<ConnectionResult> Connect(ServerInfo server, CancellationToken cancellationToken);
|
||||
|
||||
/// <summary>
|
||||
/// Connects the specified server.
|
||||
/// </summary>
|
||||
/// <param name="address">The address.</param>
|
||||
/// <param name="cancellationToken">The cancellation token.</param>
|
||||
/// <returns>Task<ConnectionResult>.</returns>
|
||||
Task<ConnectionResult> Connect(string address, CancellationToken cancellationToken);
|
||||
|
||||
/// <summary>
|
||||
/// Logouts this instance.
|
||||
/// </summary>
|
||||
/// <returns>Task<ConnectionResult>.</returns>
|
||||
Task<ConnectionResult> Logout();
|
||||
|
||||
/// <summary>
|
||||
/// Authenticates the specified server.
|
||||
/// </summary>
|
||||
/// <param name="server">The server.</param>
|
||||
/// <param name="username">The username.</param>
|
||||
/// <param name="hash">The hash.</param>
|
||||
/// <param name="rememberLogin">if set to <c>true</c> [remember login].</param>
|
||||
/// <returns>Task.</returns>
|
||||
Task Authenticate(ServerInfo server, string username, byte[] hash, bool rememberLogin);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user