Add optional hide history & message parameters to IStreamChannel.AddMembersAsync (#127)

Author: sierpinskid

Assets/Plugins/StreamChat/Core/InternalDTO/Requests/UpdateChannelRequestInternalDTO.cs

@@ -32,7 +32,7 @@ internal partial class UpdateChannelRequestInternalDTO
         /// List of user IDs to make channel moderators
         /// </summary>
         [Newtonsoft.Json.JsonProperty("add_moderators", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
-        public System.Collections.Generic.List<string> AddModerators { get; set; } = new System.Collections.Generic.List<string>();
+        public System.Collections.Generic.List<string> AddModerators { get; set; }
 
         /// <summary>
         /// List of channel member role assignments. If any specified user is not part of the channel, the request will fail
@@ -53,7 +53,7 @@ internal partial class UpdateChannelRequestInternalDTO
         /// List of user IDs to take away moderators status from
         /// </summary>
         [Newtonsoft.Json.JsonProperty("demote_moderators", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
-        public System.Collections.Generic.List<string> DemoteModerators { get; set; } = new System.Collections.Generic.List<string>();
+        public System.Collections.Generic.List<string> DemoteModerators { get; set; }
 
         /// <summary>
         /// Set to `true` to hide channel's history when adding new members
@@ -83,7 +83,7 @@ internal partial class UpdateChannelRequestInternalDTO
         /// List of user IDs to remove from the channel
         /// </summary>
         [Newtonsoft.Json.JsonProperty("remove_members", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
-        public System.Collections.Generic.List<string> RemoveMembers { get; set; } = new System.Collections.Generic.List<string>();
+        public System.Collections.Generic.List<string> RemoveMembers { get; set; }
 
         /// <summary>
         /// When `message` is set disables all push notifications for it

Assets/Plugins/StreamChat/Core/Requests/StreamMessageRequest.cs

@@ -0,0 +1,96 @@
+using System;
+using System.Collections.Generic;
+using StreamChat.Core.Helpers;
+using StreamChat.Core.InternalDTO.Requests;
+using StreamChat.Core.LowLevelClient;
+using StreamChat.Core.State;
+using StreamChat.Core.StatefulModels;
+
+namespace StreamChat.Core.Requests
+{
+    public class StreamMessageRequest : ISavableTo<MessageRequestInternalDTO>
+    {
+        /// <summary>
+        /// Array of message attachments
+        /// </summary>
+        public List<StreamAttachmentRequest> Attachments { get; set; }
+
+        /// <summary>
+        /// Message ID is unique string identifier of the message
+        /// </summary>
+        public string Id { get; set; }
+
+        /// <summary>
+        /// List of mentioned users
+        /// </summary>
+        public List<IStreamUser> MentionedUsers { get; set; }
+
+        /// <summary>
+        /// ID of parent message (thread)
+        /// </summary>
+        public string ParentId { get; set; }
+
+        /// <summary>
+        /// Date when pinned message expires
+        /// </summary>
+        public DateTimeOffset? PinExpires { get; set; }
+
+        /// <summary>
+        /// Whether message is pinned or not
+        /// </summary>
+        public bool? Pinned { get; set; }
+
+        /// <summary>
+        /// Date when message got pinned
+        /// </summary>
+        public DateTimeOffset? PinnedAt { get; set; }
+
+        /// <summary>
+        /// Contains user who pinned the message
+        /// </summary>
+        public IStreamUser PinnedBy { get; set; }
+
+        public IStreamMessage QuotedMessage { get; set; }
+
+        /// <summary>
+        /// Whether thread reply should be shown in the channel as well
+        /// </summary>
+        public bool? ShowInChannel { get; set; }
+
+        /// <summary>
+        /// Whether message is silent or not
+        /// </summary>
+        public bool? Silent { get; set; }
+
+        /// <summary>
+        /// Text of the message. Should be empty if `mml` is provided
+        /// </summary>
+        public string Text { get; set; }
+
+        /// <summary>
+        /// Add or update custom data associated with this message. This will be accessible through <see cref="IStreamMessage.CustomData"/>
+        /// </summary>
+        public StreamCustomDataRequest CustomData { get; set; }
+
+        MessageRequestInternalDTO ISavableTo<MessageRequestInternalDTO>.SaveToDto()
+            => new MessageRequestInternalDTO
+            {
+                Attachments
+                    = Attachments?.TrySaveToDtoCollection<StreamAttachmentRequest, AttachmentRequestInternalDTO>(),
+                // Cid = Cid, Purposely ignored because it has no effect and endpoint already contains channel type&id
+                //Html = Html, Marked in DTO as server-side only
+                Id = Id,
+                MentionedUsers = MentionedUsers?.ToUserIdsListOrNull(),
+                ParentId = ParentId,
+                PinExpires = PinExpires,
+                Pinned = Pinned,
+                PinnedAt = PinnedAt,
+                PinnedBy = PinnedBy?.Id,
+                QuotedMessageId = QuotedMessage?.Id,
+                ShowInChannel = ShowInChannel,
+                Silent = Silent,
+                Text = Text,
+                AdditionalProperties = CustomData?.ToDictionary()
+            };
+    }
+}

Assets/Plugins/StreamChat/Core/Requests/StreamMessageRequest.cs.meta

@@ -58,7 +58,7 @@ public interface IStreamChannel : IStreamStatefulModel
         /// Event fired when a <see cref="IStreamChannelMember"/> was updated
         /// </summary>
         event StreamChannelMemberChangeHandler MemberUpdated;
-        
+
         /// <summary>
         /// Event fired when a <see cref="IStreamChannelMember"/> was added, updated, or removed.
         /// </summary>
@@ -335,11 +335,14 @@ Task UpdatePartialAsync(IDictionary<string, object> setFields = null,
         /// Query channel members based on provided criteria. Results will not be
         /// </summary>
         /// <returns></returns>
-        Task<IEnumerable<IStreamChannelMember>> QueryMembersAsync(IDictionary<string, object> filters = null, int limit = 30, int offset = 0);
-        
-        [Obsolete("This method was renamed to QueryMembersAsync. Please use the QueryMembersAsync. The QueryMembers will be removed in a future release.")]
-        Task<IEnumerable<IStreamChannelMember>> QueryMembers(IDictionary<string, object> filters = null, int limit = 30, int offset = 0);
-    
+        Task<IEnumerable<IStreamChannelMember>> QueryMembersAsync(IDictionary<string, object> filters = null,
+            int limit = 30, int offset = 0);
+
+        [Obsolete(
+            "This method was renamed to QueryMembersAsync. Please use the QueryMembersAsync. The QueryMembers will be removed in a future release.")]
+        Task<IEnumerable<IStreamChannelMember>> QueryMembers(IDictionary<string, object> filters = null, int limit = 30,
+            int offset = 0);
+
         void QueryWatchers(); //StreamTodo: IMPLEMENT
 
         /// <summary>
@@ -416,25 +419,33 @@ Task ShadowBanMemberAsync(IStreamChannelMember member, string reason = "",
         /// </summary>
         /// <param name="clearHistory">Whether to clear message history of the channel or not</param>
         /// <remarks>https://getstream.io/chat/docs/unity/muting_channels/?language=unity</remarks>
-        Task HideAsync(bool? clearHistory = false);
+        Task HideAsync(bool? clearHistory = default);
 
         /// <summary>
         /// Add users as members to this channel
         /// </summary>
         /// <param name="users">Users to become members of this channel</param>
-        Task AddMembersAsync(IEnumerable<IStreamUser> users);
+        /// <param name="hideHistory"></param>
+        /// <param name="optionalMessage"></param>
+        Task AddMembersAsync(IEnumerable<IStreamUser> users, bool? hideHistory = default,
+            StreamMessageRequest optionalMessage = default);
+
+        /// <inheritdoc cref="AddMembersAsync(System.Collections.Generic.IEnumerable{string},System.Nullable{bool},StreamChat.Core.Requests.StreamMessageRequest)"/>
+        Task AddMembersAsync(bool? hideHistory = default, StreamMessageRequest optionalMessage = default,
+            params IStreamUser[] users);
 
-        /// <inheritdoc cref="AddMembersAsync(IEnumerable{StreamChat.Core.StatefulModels.IStreamUser})}"/>
-        Task AddMembersAsync(params IStreamUser[] users);
-        
         /// <summary>
         /// Add users as members to this channel
         /// </summary>
         /// <param name="userIds">User IDs to become members of this channel</param>
-        Task AddMembersAsync(IEnumerable<string> userIds);
-        
-        /// <inheritdoc cref="AddMembersAsync(IEnumerable{System.String})}"/>
-        Task AddMembersAsync(params string[] users);
+        /// <param name="hideHistory">Hide history for the new members</param>
+        /// <param name="optionalMessage"></param>
+        Task AddMembersAsync(IEnumerable<string> userIds, bool? hideHistory = default,
+            StreamMessageRequest optionalMessage = default);
+
+        /// <inheritdoc cref="AddMembersAsync(System.Collections.Generic.IEnumerable{string},System.Nullable{bool},StreamChat.Core.Requests.StreamMessageRequest)"/>
+        Task AddMembersAsync(bool? hideHistory = default, StreamMessageRequest optionalMessage = default,
+            params string[] users);
 
         /// <summary>
         /// Remove members from this channel
@@ -444,7 +455,7 @@ Task ShadowBanMemberAsync(IStreamChannelMember member, string reason = "",
 
         /// <inheritdoc cref="RemoveMembersAsync(IEnumerable{StreamChat.Core.StatefulModels.IStreamChannelMember})}"/>
         Task RemoveMembersAsync(params IStreamChannelMember[] members);
-        
+
         /// <summary>
         /// Remove members from this channel
         /// </summary>
@@ -453,7 +464,7 @@ Task ShadowBanMemberAsync(IStreamChannelMember member, string reason = "",
 
         /// <inheritdoc cref="RemoveMembersAsync(IEnumerable{StreamChat.Core.StatefulModels.IStreamUser})}"/>
         Task RemoveMembersAsync(params IStreamUser[] members);
-        
+
         /// <summary>
         /// Remove members from this channel
         /// </summary>
@@ -514,13 +525,13 @@ Task TruncateAsync(DateTimeOffset? truncatedAt = default, string systemMessage =
         /// Stop being a member (<see cref="IStreamChannelMember"/>) of this channel. Only possible if local user has the `Leave Own Channel` permission
         /// </summary>
         Task LeaveAsMemberChannelAsync();
-        
+
         /// <summary>
         /// Invite new members to this channel.
         /// </summary>
         /// <remarks>https://getstream.io/chat/docs/unity/channel_invites/?language=unity/</remarks>
         Task InviteMembersAsync(IEnumerable<string> userIds);
-        
+
         /// <summary>
         /// Invite new members to this channel.
         /// </summary>
@@ -532,7 +543,7 @@ Task TruncateAsync(DateTimeOffset? truncatedAt = default, string systemMessage =
         /// </summary>
         /// <remarks>https://getstream.io/chat/docs/unity/channel_invites/?language=unity/</remarks>
         Task InviteMembersAsync(IEnumerable<IStreamUser> users);
-        
+
         /// <summary>
         /// Invite new members to this channel.
         /// </summary>

Assets/Plugins/StreamChat/Core/StatefulModels/IStreamChannel.cs

@@ -379,21 +379,25 @@ public Task ShowAsync()
             => LowLevelClient.InternalChannelApi.ShowChannelAsync(Type, Id, new ShowChannelRequestInternalDTO());
 
         //StreamTodo: write test
-        public Task HideAsync(bool? clearHistory = false)
+        public Task HideAsync(bool? clearHistory = default)
             => LowLevelClient.InternalChannelApi.HideChannelAsync(Type, Id, new HideChannelRequestInternalDTO
             {
                 ClearHistory = clearHistory
             });
 
-        public Task AddMembersAsync(IEnumerable<IStreamUser> users)
+        public Task AddMembersAsync(IEnumerable<IStreamUser> users, bool? hideHistory = default,
+            StreamMessageRequest optionalMessage = default)
         {
             StreamAsserts.AssertNotNull(users, nameof(users));
-            return AddMembersAsync(users.Select(u => u.Id));
+            return AddMembersAsync(users.Select(u => u.Id), hideHistory, optionalMessage);
         }
 
-        public Task AddMembersAsync(params IStreamUser[] users) => AddMembersAsync(users as IEnumerable<IStreamUser>);
+        public Task AddMembersAsync(bool? hideHistory = default, StreamMessageRequest optionalMessage = default,
+            params IStreamUser[] users)
+            => AddMembersAsync(users, hideHistory, optionalMessage);
 
-        public async Task AddMembersAsync(IEnumerable<string> userIds)
+        public async Task AddMembersAsync(IEnumerable<string> userIds, bool? hideHistory = default,
+            StreamMessageRequest optionalMessage = default)
         {
             StreamAsserts.AssertNotNull(userIds, nameof(userIds));
 
@@ -409,12 +413,16 @@ public async Task AddMembersAsync(IEnumerable<string> userIds)
             var response = await LowLevelClient.InternalChannelApi.UpdateChannelAsync(Type, Id,
                 new UpdateChannelRequestInternalDTO
                 {
-                    AddMembers = membersRequest
+                    AddMembers = membersRequest,
+                    HideHistory = hideHistory,
+                    Message = optionalMessage?.TrySaveToDto(),
                 });
             Cache.TryCreateOrUpdate(response);
         }
 
-        public Task AddMembersAsync(params string[] users) => AddMembersAsync(users as IEnumerable<string>);
+        public Task AddMembersAsync(bool? hideHistory = default, StreamMessageRequest optionalMessage = default,
+            params string[] users)
+            => AddMembersAsync(users, hideHistory, optionalMessage);
 
         public Task RemoveMembersAsync(IEnumerable<IStreamChannelMember> members)
         {
@@ -448,7 +456,7 @@ public async Task RemoveMembersAsync(IEnumerable<string> userIds)
 
         public Task RemoveMembersAsync(params string[] userIds) => RemoveMembersAsync(userIds as IEnumerable<string>);
 
-        public Task JoinAsMemberAsync() => AddMembersAsync(Client.LocalUserData.User);
+        public Task JoinAsMemberAsync() => AddMembersAsync(hideHistory: default, optionalMessage: default, Client.LocalUserData.User);
 
         public Task LeaveAsMemberChannelAsync() => RemoveMembersAsync(Client.LocalUserData.User);
 
@@ -467,7 +475,7 @@ public async Task InviteMembersAsync(IEnumerable<string> userIds)
 
             var updateRequest = GetUpdateRequestWithCurrentData();
             updateRequest.Invites = invites;
-            
+
             var response = await LowLevelClient.InternalChannelApi.UpdateChannelAsync(Type, Id, updateRequest);
 
             Cache.TryCreateOrUpdate(response.Channel);
@@ -484,14 +492,15 @@ public Task InviteMembersAsync(IEnumerable<IStreamUser> users)
             StreamAsserts.AssertNotNull(users, nameof(users));
             return InviteMembersAsync(users.Select(_ => _.Id));
         }
-        
-        public Task InviteMembersAsync(params IStreamUser[] users) => InviteMembersAsync(users as IEnumerable<IStreamUser>);
+
+        public Task InviteMembersAsync(params IStreamUser[] users)
+            => InviteMembersAsync(users as IEnumerable<IStreamUser>);
 
         public async Task AcceptInviteAsync()
         {
             var updateRequest = GetUpdateRequestWithCurrentData();
             updateRequest.AcceptInvite = true;
-            
+
             var response = await LowLevelClient.InternalChannelApi.UpdateChannelAsync(Type, Id, updateRequest);
 
             Cache.TryCreateOrUpdate(response.Channel);
@@ -505,7 +514,7 @@ public async Task RejectInviteAsync()
         {
             var updateRequest = GetUpdateRequestWithCurrentData();
             updateRequest.RejectInvite = true;
-            
+
             var response = await LowLevelClient.InternalChannelApi.UpdateChannelAsync(Type, Id, updateRequest);
 
             Cache.TryCreateOrUpdate(response.Channel);
@@ -1003,18 +1012,20 @@ private void SortMessagesByCreatedAt()
         {
             _messages.Sort((msg1, msg2) => msg1.CreatedAt.CompareTo(msg2.CreatedAt));
         }
-        
-        private UpdateChannelRequestInternalDTO GetUpdateRequestWithCurrentData() => new UpdateChannelRequestInternalDTO
-        {
-            Data = new ChannelRequestInternalDTO
+
+        private UpdateChannelRequestInternalDTO GetUpdateRequestWithCurrentData()
+            => new UpdateChannelRequestInternalDTO
             {
-                AutoTranslationEnabled = AutoTranslationEnabled,
-                AutoTranslationLanguage = AutoTranslationLanguage,
-                Disabled = Disabled,
-                Frozen = Frozen,
+                Data = new ChannelRequestInternalDTO
+                {
+                    AutoTranslationEnabled = AutoTranslationEnabled,
+                    AutoTranslationLanguage = AutoTranslationLanguage,
+                    Disabled = Disabled,
+                    Frozen = Frozen,
+                    AdditionalProperties = GetInternalAdditionalPropertiesDictionary(),
+                    Name = Name
+                },
                 AdditionalProperties = GetInternalAdditionalPropertiesDictionary(),
-                Name = Name
-            },
-        };
+            };
     }
 }