From 9951a5139544d0f13913eda91be29ca2eda3e8e6 Mon Sep 17 00:00:00 2001 From: Rich Lander Date: Mon, 9 Aug 2021 19:47:26 -0700 Subject: [PATCH] Fix warnings in MediaBrowser.Controller/Session --- .../Session/ISessionController.cs | 6 ++++ .../Session/ISessionManager.cs | 32 ++++++++++++++----- 2 files changed, 30 insertions(+), 8 deletions(-) diff --git a/MediaBrowser.Controller/Session/ISessionController.cs b/MediaBrowser.Controller/Session/ISessionController.cs index 6bc39d6f4e..b38ee11462 100644 --- a/MediaBrowser.Controller/Session/ISessionController.cs +++ b/MediaBrowser.Controller/Session/ISessionController.cs @@ -26,6 +26,12 @@ namespace MediaBrowser.Controller.Session /// /// Sends the message. /// + /// The type of data. + /// Name of message type. + /// Message ID. + /// Data to send. + /// CancellationToken for operation. + /// A task. Task SendMessage(SessionMessageType name, Guid messageId, T data, CancellationToken cancellationToken); } } diff --git a/MediaBrowser.Controller/Session/ISessionManager.cs b/MediaBrowser.Controller/Session/ISessionManager.cs index 4c3cf5ffe1..0ff32fb536 100644 --- a/MediaBrowser.Controller/Session/ISessionManager.cs +++ b/MediaBrowser.Controller/Session/ISessionManager.cs @@ -83,6 +83,7 @@ namespace MediaBrowser.Controller.Session /// Name of the device. /// The remote end point. /// The user. + /// Session information. SessionInfo LogSessionActivity(string appName, string appVersion, string deviceId, string deviceName, string remoteEndPoint, Jellyfin.Data.Entities.User user); /// @@ -105,7 +106,7 @@ namespace MediaBrowser.Controller.Session /// /// The info. /// Task. - /// + /// Throws if an argument is null. Task OnPlaybackProgress(PlaybackProgressInfo info); Task OnPlaybackProgress(PlaybackProgressInfo info, bool isAutomated); @@ -115,14 +116,13 @@ namespace MediaBrowser.Controller.Session /// /// The info. /// Task. - /// + /// Throws if an argument is null. Task OnPlaybackStopped(PlaybackStopInfo info); /// /// Reports the session ended. /// /// The session identifier. - /// Task. void ReportSessionEnded(string sessionId); /// @@ -170,6 +170,7 @@ namespace MediaBrowser.Controller.Session /// The session. /// The group update. /// The cancellation token. + /// Type of group. /// Task. Task SendSyncPlayGroupUpdate(SessionInfo session, GroupUpdate command, CancellationToken cancellationToken); @@ -196,8 +197,8 @@ namespace MediaBrowser.Controller.Session /// /// Sends the message to admin sessions. /// - /// - /// The name. + /// Type of data. + /// Message type name. /// The data. /// The cancellation token. /// Task. @@ -206,18 +207,31 @@ namespace MediaBrowser.Controller.Session /// /// Sends the message to user sessions. /// - /// + /// Type of data. + /// Users to send messages to. + /// Message type name. + /// The data. + /// The cancellation token. /// Task. Task SendMessageToUserSessions(List userIds, SessionMessageType name, T data, CancellationToken cancellationToken); + /// + /// Sends the message to user sessions. + /// + /// Type of data. + /// Users to send messages to. + /// Message type name. + /// Data function. + /// The cancellation token. + /// Task. Task SendMessageToUserSessions(List userIds, SessionMessageType name, Func dataFn, CancellationToken cancellationToken); /// /// Sends the message to user device sessions. /// - /// + /// Type of data. /// The device identifier. - /// The name. + /// Message type name. /// The data. /// The cancellation token. /// Task. @@ -353,6 +367,8 @@ namespace MediaBrowser.Controller.Session /// /// Revokes the user tokens. /// + /// User ID. + /// Current access token. void RevokeUserTokens(Guid userId, string currentAccessToken); ///