diff options
| author | ConfusedPolarBear <33811686+ConfusedPolarBear@users.noreply.github.com> | 2020-06-18 01:58:58 -0500 |
|---|---|---|
| committer | ConfusedPolarBear <33811686+ConfusedPolarBear@users.noreply.github.com> | 2020-06-19 23:33:07 -0500 |
| commit | 329980c727cf03587ff5f4011a3af3ef2fa5e4f1 (patch) | |
| tree | 29a153e450bdff7670d110422e42802c340c643b /MediaBrowser.Controller/QuickConnect/IQuickConnect.cs | |
| parent | 4be476ec5312387f87134915d0fd132b2ad5fa3f (diff) | |
API cleanup
Diffstat (limited to 'MediaBrowser.Controller/QuickConnect/IQuickConnect.cs')
| -rw-r--r-- | MediaBrowser.Controller/QuickConnect/IQuickConnect.cs | 23 |
1 files changed, 8 insertions, 15 deletions
diff --git a/MediaBrowser.Controller/QuickConnect/IQuickConnect.cs b/MediaBrowser.Controller/QuickConnect/IQuickConnect.cs index d31d0e509..10ec9e6cb 100644 --- a/MediaBrowser.Controller/QuickConnect/IQuickConnect.cs +++ b/MediaBrowser.Controller/QuickConnect/IQuickConnect.cs @@ -38,8 +38,7 @@ namespace MediaBrowser.Controller.QuickConnect /// <summary> /// Temporarily activates quick connect for a short amount of time. /// </summary> - /// <returns>A quick connect result object indicating success.</returns> - QuickConnectResult Activate(); + void Activate(); /// <summary> /// Changes the status of quick connect. @@ -62,26 +61,20 @@ namespace MediaBrowser.Controller.QuickConnect QuickConnectResult CheckRequestStatus(string secret); /// <summary> - /// Returns all current quick connect requests as DTOs. Does not include sensitive information. - /// </summary> - /// <returns>List of all quick connect results.</returns> - List<QuickConnectResultDto> GetCurrentRequests(); - - /// <summary> - /// Returns all current quick connect requests (including sensitive information). - /// </summary> - /// <returns>List of all quick connect results.</returns> - List<QuickConnectResult> GetCurrentRequestsInternal(); - - /// <summary> /// Authorizes a quick connect request to connect as the calling user. /// </summary> /// <param name="request">HTTP request object.</param> - /// <param name="lookup">Identifying code for the request..</param> + /// <param name="code">Identifying code for the request.</param> /// <returns>A boolean indicating if the authorization completed successfully.</returns> bool AuthorizeRequest(IRequest request, string code); /// <summary> + /// Expire quick connect requests that are over the time limit. If <paramref name="expireAll"/> is true, all requests are unconditionally expired. + /// </summary> + /// <param name="expireAll">If true, all requests will be expired.</param> + public void ExpireRequests(bool expireAll = false); + + /// <summary> /// Deletes all quick connect access tokens for the provided user. /// </summary> /// <param name="user">Guid of the user to delete tokens for.</param> |