blob: 341df27280afd4c44a63b31349de7208bd3e56aa (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
using MediaBrowser.Model.Connect;
using MediaBrowser.Model.Dto;
using MediaBrowser.Model.Events;
using System;
using System.Collections.Generic;
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>
/// Occurs when [local user sign in].
/// </summary>
event EventHandler<GenericEventArgs<UserDto>> LocalUserSignIn;
/// <summary>
/// Occurs when [connect user sign in].
/// </summary>
event EventHandler<GenericEventArgs<ConnectUser>> ConnectUserSignIn;
/// <summary>
/// Occurs when [local user sign out].
/// </summary>
event EventHandler<GenericEventArgs<IApiClient>> LocalUserSignOut;
/// <summary>
/// Occurs when [connect user sign out].
/// </summary>
event EventHandler<EventArgs> ConnectUserSignOut;
/// <summary>
/// Occurs when [remote logged out].
/// </summary>
event EventHandler<EventArgs> RemoteLoggedOut;
/// <summary>
/// Gets the connect user.
/// </summary>
/// <value>The connect user.</value>
ConnectUser ConnectUser { get; }
/// <summary>
/// Gets or sets a value indicating whether [save local credentials].
/// </summary>
/// <value><c>true</c> if [save local credentials]; otherwise, <c>false</c>.</value>
bool SaveLocalCredentials { get; set; }
/// <summary>
/// Gets the API client.
/// </summary>
/// <param name="item">The item.</param>
/// <returns>IApiClient.</returns>
IApiClient GetApiClient(IHasServerId item);
/// <summary>
/// Gets the API client.
/// </summary>
/// <param name="serverId">The server identifier.</param>
/// <returns>IApiClient.</returns>
IApiClient GetApiClient(string serverId);
/// <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 API client.
/// </summary>
/// <param name="apiClient">The API client.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task<ConnectionResult>.</returns>
Task<ConnectionResult> Connect(IApiClient apiClient, 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="server">The server.</param>
/// <param name="options">The options.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task<ConnectionResult>.</returns>
Task<ConnectionResult> Connect(ServerInfo server, ConnectionOptions options, 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 Logout();
/// <summary>
/// Logins to connect.
/// </summary>
/// <returns>Task.</returns>
Task LoginToConnect(string username, string password);
/// <summary>
/// Gets the active api client instance
/// </summary>
IApiClient CurrentApiClient { get; }
/// <summary>
/// Creates the pin.
/// </summary>
/// <returns>Task<PinCreationResult>.</returns>
Task<PinCreationResult> CreatePin();
/// <summary>
/// Gets the pin status.
/// </summary>
/// <param name="pin">The pin.</param>
/// <returns>Task<PinStatusResult>.</returns>
Task<PinStatusResult> GetPinStatus(PinCreationResult pin);
/// <summary>
/// Exchanges the pin.
/// </summary>
/// <param name="pin">The pin.</param>
/// <returns>Task.</returns>
Task ExchangePin(PinCreationResult pin);
/// <summary>
/// Gets the available servers.
/// </summary>
/// <param name="cancellationToken">The cancellation token.</param>
Task<List<ServerInfo>> GetAvailableServers(CancellationToken cancellationToken);
/// <summary>
/// Authenticates an offline user with their password
/// </summary>
/// <param name="user">The user.</param>
/// <param name="password">The password.</param>
/// <param name="rememberCredentials">if set to <c>true</c> [remember credentials].</param>
/// <returns>Task.</returns>
Task AuthenticateOffline(UserDto user, string password, bool rememberCredentials);
}
}
|
