From f343ba611139c98a0424f95c8a07dd0ee4d03b7d Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Sat, 12 Nov 2022 23:35:21 +0900
Subject: [PATCH] Add xmldoc for chat ack request

---
 osu.Game/Online/API/Requests/ChatAckRequest.cs | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/osu.Game/Online/API/Requests/ChatAckRequest.cs b/osu.Game/Online/API/Requests/ChatAckRequest.cs
index 01b0c142dc..306b5acc1d 100644
--- a/osu.Game/Online/API/Requests/ChatAckRequest.cs
+++ b/osu.Game/Online/API/Requests/ChatAckRequest.cs
@@ -7,6 +7,17 @@ using osu.Game.Online.API.Requests.Responses;
 
 namespace osu.Game.Online.API.Requests
 {
+    /// <summary>
+    /// A request which should be sent occasionally while interested in chat and online state.
+    ///
+    /// This will:
+    ///  - Mark the user as "online" (for 10 minutes since the last invocation).
+    ///  - Return any silences since the last invocation (if either <see cref="SinceMessageId"/> or <see cref="SinceSilenceId"/> is not null).
+    ///
+    /// For silence handling, a <see cref="SinceMessageId"/> should be provided as soon as a message is received by the client.
+    /// From that point forward, <see cref="SinceSilenceId"/> should be preferred after the first <see cref="ChatSilence"/>
+    /// arrives in a response from the ack request. Specifying both parameters will prioritise the latter.
+    /// </summary>
     public class ChatAckRequest : APIRequest<ChatAckResponse>
     {
         public long? SinceMessageId;