Skip to content

Commit 98a1b86

Browse files
totalimmersionclaude
totalimmersion
and
claude
authored
[CHA-1704] Add Future Channel Bans support (#193)
* feat: [CHA-1699] add Future Channel Bans support - Add BanFromFutureChannels property to BanRequest - Add removeFutureChannelsBan parameter to UnbanAsync - Add FutureChannelBan class - Add QueryFutureChannelBansRequest and QueryFutureChannelBansResponse - Add QueryFutureChannelBansAsync method to IUserClient and UserClient * feat: add TargetUserId to QueryFutureChannelBansRequest Add target_user_id parameter to allow filtering future channel bans by target user, especially for client-side requests. Co-Authored-By: Claude Opus 4.5 <[email protected]> * test: add QueryFutureChannelBans test with TargetUserId filter Test the new TargetUserId parameter for filtering future channel bans. Co-Authored-By: Claude Opus 4.5 <[email protected]> * fix: add channel cid to FCB test and fix style warnings The TestQueryFutureChannelBansWithTargetUserIdAsync test was failing because ban_from_future_channels requires a channel_cid to be set. Fixed by creating a channel and passing its Type and Id in the BanRequest. Also fixed: - SA1137 indentation warning in MessageClientTests.cs - SA1413 trailing comma warnings in UserClientTests.cs Co-Authored-By: Claude Opus 4.5 <[email protected]> * fix: add Target alias for FutureChannelBan.User deserialization The API may return the banned user as 'target' instead of 'user'. Adding a Target property with JsonProperty attribute allows the SDK to deserialize from both field names. The User property now returns Target as a fallback if user is not set. Also added explicit JsonProperty attributes to ensure proper deserialization regardless of naming strategy. Co-Authored-By: Claude Opus 4.5 <[email protected]> * fix: add TargetId and CreatedById fields to FutureChannelBan The API may return target_id and created_by_id instead of/in addition to full user objects. Updated the model to capture these fields and updated the test to fall back to TargetId if User is not populated. Co-Authored-By: Claude Opus 4.5 <[email protected]> * test: simplify FCB test to not depend on User population The API does not appear to populate the User object in the QueryFutureChannelBans response. Simplified the test to verify: - Bans are created and queryable - Reason field is correctly populated - TargetUserId filter works correctly The User/TargetId assertions have been removed until the API behavior is clarified. Co-Authored-By: Claude Opus 4.5 <[email protected]> --------- Co-authored-by: Claude Opus 4.5 <[email protected]>
1 parent b6fe937 commit 98a1b86

File tree

5 files changed

+184
-14
lines changed

5 files changed

+184
-14
lines changed

‎src/Clients/IUserClient.cs‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ public interface IUserClient
201201
/// To ban a user, use <see cref="BanAsync"/> method.
202202
/// </summary>
203203
/// <remarks>https://getstream.io/chat/docs/dotnet-csharp/moderation/?language=csharp#ban</remarks>
204-
Task<ApiResponse> UnbanAsync(BanRequest banRequest);
204+
Task<ApiResponse> UnbanAsync(BanRequest banRequest, bool removeFutureChannelsBan = false);
205205

206206
/// <summary>
207207
/// <para>Queries banned users.</para>
@@ -214,6 +214,13 @@ public interface IUserClient
214214
/// <remarks>https://getstream.io/chat/docs/dotnet-csharp/moderation/?language=csharp#query-banned-users</remarks>
215215
Task<QueryBannedUsersResponse> QueryBannedUsersAsync(QueryBannedUsersRequest request);
216216

217+
/// <summary>
218+
/// <para>Queries future channel bans.</para>
219+
/// Future channel bans are automatically applied when a user creates a new channel
220+
/// or adds a member to an existing channel.
221+
/// </summary>
222+
Task<QueryFutureChannelBansResponse> QueryFutureChannelBansAsync(QueryFutureChannelBansRequest request);
223+
217224
/// <summary>
218225
/// <para>Mutes a user.</para>
219226
/// Any user is allowed to mute another user. Mutes are stored at user level and returned with the

‎src/Clients/UserClient.cs‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -130,22 +130,36 @@ public async Task<ApiResponse> BanAsync(BanRequest banRequest)
130130
HttpStatusCode.Created,
131131
banRequest);
132132

133-
public async Task<ApiResponse> UnbanAsync(BanRequest banRequest)
134-
=> await ExecuteRequestAsync<ApiResponse>("moderation/ban",
133+
public async Task<ApiResponse> UnbanAsync(BanRequest banRequest, bool removeFutureChannelsBan = false)
134+
{
135+
var queryParams = new List<KeyValuePair<string, string>>
136+
{
137+
new KeyValuePair<string, string>("target_user_id", banRequest.TargetUserId),
138+
new KeyValuePair<string, string>("type", banRequest.Type),
139+
new KeyValuePair<string, string>("id", banRequest.Id),
140+
};
141+
if (removeFutureChannelsBan)
142+
{
143+
queryParams.Add(new KeyValuePair<string, string>("remove_future_channels_ban", "true"));
144+
}
145+
return await ExecuteRequestAsync<ApiResponse>("moderation/ban",
135146
HttpMethod.DELETE,
136147
HttpStatusCode.OK,
137-
queryParams: new List<KeyValuePair<string, string>>
138-
{
139-
new KeyValuePair<string, string>("target_user_id", banRequest.TargetUserId),
140-
new KeyValuePair<string, string>("type", banRequest.Type),
141-
new KeyValuePair<string, string>("id", banRequest.Id),
142-
});
148+
queryParams: queryParams);
149+
}
150+
143151
public async Task<QueryBannedUsersResponse> QueryBannedUsersAsync(QueryBannedUsersRequest request)
144152
=> await ExecuteRequestAsync<QueryBannedUsersResponse>("query_banned_users",
145153
HttpMethod.GET,
146154
HttpStatusCode.OK,
147155
queryParams: request.ToQueryParameters());
148156

157+
public async Task<QueryFutureChannelBansResponse> QueryFutureChannelBansAsync(QueryFutureChannelBansRequest request)
158+
=> await ExecuteRequestAsync<QueryFutureChannelBansResponse>("query_future_channel_bans",
159+
HttpMethod.GET,
160+
HttpStatusCode.OK,
161+
queryParams: request.ToQueryParameters());
162+
149163
public async Task<MuteResponse> MuteAsync(string targetId, string id)
150164
=> await ExecuteRequestAsync<MuteResponse>("moderation/mute",
151165
HttpMethod.POST,

‎src/Models/Moderation.cs‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ public class BanRequest
3232

3333
/// <summary>Channel ID to ban user in</summary>
3434
public string Id { get; set; }
35+
36+
/// <summary>When true, the user will be automatically banned from all future channels created by the user who issued the ban</summary>
37+
public bool? BanFromFutureChannels { get; set; }
3538
}
3639

3740
public class ShadowBanRequest : BanRequest
@@ -53,6 +56,69 @@ public class Ban
5356
public User BannedBy { get; set; }
5457
}
5558

59+
public class FutureChannelBan
60+
{
61+
/// <summary>Gets or sets the banned user (checks multiple possible API response fields).</summary>
62+
[Newtonsoft.Json.JsonProperty("user")]
63+
public User User
64+
{
65+
get => _user ?? Target;
66+
set => _user = value;
67+
}
68+
69+
private User _user;
70+
71+
/// <summary>Gets or sets the banned user (target of the ban).</summary>
72+
[Newtonsoft.Json.JsonProperty("target")]
73+
public User Target { get; set; }
74+
75+
/// <summary>Gets or sets the ID of the banned user.</summary>
76+
[Newtonsoft.Json.JsonProperty("target_id")]
77+
public string TargetId { get; set; }
78+
79+
/// <summary>Gets or sets the ID of the user who created the ban.</summary>
80+
[Newtonsoft.Json.JsonProperty("created_by_id")]
81+
public string CreatedById { get; set; }
82+
83+
/// <summary>Gets or sets the user who created the ban.</summary>
84+
[Newtonsoft.Json.JsonProperty("created_by")]
85+
public User CreatedBy { get; set; }
86+
87+
[Newtonsoft.Json.JsonProperty("created_at")]
88+
public DateTimeOffset CreatedAt { get; set; }
89+
90+
[Newtonsoft.Json.JsonProperty("expires")]
91+
public DateTimeOffset? Expires { get; set; }
92+
93+
[Newtonsoft.Json.JsonProperty("reason")]
94+
public string Reason { get; set; }
95+
96+
[Newtonsoft.Json.JsonProperty("shadow")]
97+
public bool Shadow { get; set; }
98+
}
99+
100+
public class QueryFutureChannelBansRequest : IQueryParameterConvertible
101+
{
102+
public string UserId { get; set; }
103+
public string TargetUserId { get; set; }
104+
public bool? ExcludeExpiredBans { get; set; }
105+
public int? Limit { get; set; }
106+
public int? Offset { get; set; }
107+
108+
public List<KeyValuePair<string, string>> ToQueryParameters()
109+
{
110+
return new List<KeyValuePair<string, string>>
111+
{
112+
new KeyValuePair<string, string>("payload", StreamJsonConverter.SerializeObject(this)),
113+
};
114+
}
115+
}
116+
117+
public class QueryFutureChannelBansResponse : ApiResponse
118+
{
119+
public List<FutureChannelBan> Bans { get; set; }
120+
}
121+
56122
public class QueryBannedUsersRequest : IQueryParameterConvertible
57123
{
58124
public Dictionary<string, object> FilterConditions { get; set; }

‎tests/MessageClientTests.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ private async Task EnableUserMessageRemindersAsync()
6565
/// </summary>
6666
private async Task DisableUserMessageRemindersAsync()
6767
{
68-
var request = new PartialUpdateChannelRequest
68+
var request = new PartialUpdateChannelRequest
6969
{
7070
Set = new Dictionary<string, object>
7171
{

‎tests/UserClientTests.cs‎

Lines changed: 87 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -559,7 +559,7 @@ public async Task TestMarkDeliveredAsync()
559559
{
560560
ChannelCID = "channel2",
561561
MessageID = "message2",
562-
}
562+
},
563563
},
564564
UserID = _user1.Id,
565565
};
@@ -580,7 +580,7 @@ public async Task TestMarkDelivered_WithUserIdAsync()
580580
{
581581
ChannelCID = "channel1",
582582
MessageID = "message1",
583-
}
583+
},
584584
},
585585
UserID = _user1.Id,
586586
};
@@ -623,13 +623,96 @@ public Task TestMarkDelivered_NoUserOrUserId_ThrowsArgumentExceptionAsync()
623623
{
624624
ChannelCID = "channel1",
625625
MessageID = "message1",
626-
}
627-
}
626+
},
627+
},
628628
};
629629

630630
Func<Task> markDeliveredCall = async () => await _userClient.MarkDeliveredAsync(markDeliveredOptions);
631631

632632
return markDeliveredCall.Should().ThrowAsync<ArgumentException>();
633633
}
634+
635+
[Test]
636+
public async Task TestQueryFutureChannelBansWithTargetUserIdAsync()
637+
{
638+
var creator = await UpsertNewUserAsync();
639+
var target1 = await UpsertNewUserAsync();
640+
var target2 = await UpsertNewUserAsync();
641+
var channel = await CreateChannelAsync(createdByUserId: creator.Id);
642+
643+
try
644+
{
645+
// Ban both targets from future channels created by creator
646+
// Note: ban_from_future_channels requires a channel_cid to be set
647+
await _userClient.BanAsync(new BanRequest
648+
{
649+
TargetUserId = target1.Id,
650+
UserId = creator.Id,
651+
Type = channel.Type,
652+
Id = channel.Id,
653+
BanFromFutureChannels = true,
654+
Reason = "test ban 1",
655+
});
656+
657+
await _userClient.BanAsync(new BanRequest
658+
{
659+
TargetUserId = target2.Id,
660+
UserId = creator.Id,
661+
Type = channel.Type,
662+
Id = channel.Id,
663+
BanFromFutureChannels = true,
664+
Reason = "test ban 2",
665+
});
666+
667+
// Query all future channel bans by creator
668+
var resp = await _userClient.QueryFutureChannelBansAsync(new QueryFutureChannelBansRequest
669+
{
670+
UserId = creator.Id,
671+
});
672+
673+
// Should have at least the 2 bans we just created
674+
resp.Bans.Should().HaveCountGreaterOrEqualTo(2);
675+
676+
// Verify we can find our bans by checking the reasons we set
677+
var reasons = resp.Bans.Select(b => b.Reason).ToList();
678+
reasons.Should().Contain("test ban 1");
679+
reasons.Should().Contain("test ban 2");
680+
681+
// Query with TargetUserId filter - should only return the specific target
682+
resp = await _userClient.QueryFutureChannelBansAsync(new QueryFutureChannelBansRequest
683+
{
684+
UserId = creator.Id,
685+
TargetUserId = target1.Id,
686+
});
687+
688+
resp.Bans.Should().HaveCount(1);
689+
resp.Bans[0].Reason.Should().Be("test ban 1");
690+
691+
// Query for the other target
692+
resp = await _userClient.QueryFutureChannelBansAsync(new QueryFutureChannelBansRequest
693+
{
694+
UserId = creator.Id,
695+
TargetUserId = target2.Id,
696+
});
697+
698+
resp.Bans.Should().HaveCount(1);
699+
resp.Bans[0].Reason.Should().Be("test ban 2");
700+
}
701+
finally
702+
{
703+
// Cleanup - unban both users
704+
await _userClient.UnbanAsync(new BanRequest
705+
{
706+
TargetUserId = target1.Id,
707+
UserId = creator.Id,
708+
});
709+
await _userClient.UnbanAsync(new BanRequest
710+
{
711+
TargetUserId = target2.Id,
712+
UserId = creator.Id,
713+
});
714+
await TryDeleteUsersAsync(creator.Id, target1.Id, target2.Id);
715+
}
716+
}
634717
}
635718
}

0 commit comments

Comments
 (0)