Skip to content

Commit 6e6a0f2

Browse files
committed
chore: add code comments
1 parent 05c4cab commit 6e6a0f2

File tree

3 files changed

+30
-8
lines changed

3 files changed

+30
-8
lines changed

src/main/java/io/github/doocs/im/model/request/GetSpecifiedGroupMemberInfoRequest.java

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,34 @@
1616
public class GetSpecifiedGroupMemberInfoRequest extends GenericRequest implements Serializable {
1717
private static final long serialVersionUID = -1588717038990106029L;
1818

19+
/**
20+
* 需要拉取成员信息的群组的 ID
21+
*/
1922
@JsonProperty("GroupId")
2023
private String groupId;
2124

25+
/**
26+
* 需要拉取指定群成员的UserID列表,数量不得超过50。
27+
*/
2228
@JsonProperty("Member_List_Account")
2329
private List<String> memberListAccount;
2430

31+
/**
32+
* 需要获取哪些信息,如果没有该字段则为群成员全部资料,成员信息字段详情请参见 群成员资料。
33+
*/
2534
@JsonProperty("MemberInfoFilter")
2635
private List<String> memberInfoFilter;
2736

37+
/**
38+
* 选填
39+
* 拉取指定身份的群成员资料。如没有填写该字段,默认为所有身份成员资料,成员身份可以为:“Owner”,“Admin”,“Member”。
40+
*/
2841
@JsonProperty("MemberRoleFilter")
2942
private List<String> memberRoleFilter;
3043

44+
/**
45+
* 默认情况是没有的。该字段用来群成员维度的自定义字段过滤器,指定需要获取的群成员维度的自定义字段
46+
*/
3147
@JsonProperty("AppDefinedDataFilter_GroupMember")
3248
private List<String> appDefinedDataFilterGroupMember;
3349

src/main/java/io/github/doocs/im/model/response/GetSpecifiedGroupMemberInfoResult.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,15 @@
1515
public class GetSpecifiedGroupMemberInfoResult extends GenericResult implements Serializable {
1616
private static final long serialVersionUID = -5466167278504273597L;
1717

18+
/**
19+
* 需要拉取成员信息的群组的 ID
20+
*/
1821
@JsonProperty("GroupId")
1922
private String groupId;
2023

24+
/**
25+
* 获取到的群成员列表,其中包含了全部或者指定字段的群成员信息
26+
*/
2127
@JsonProperty("MemberList")
2228
private List<MemberProfile> memberList;
2329

src/test/java/io/github/doocs/im/core/GroupTest.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -92,14 +92,14 @@ void testGetGroupMemberInfo() throws IOException {
9292

9393
@Test
9494
void testGetSpecifiedGroupMemberInfo() throws IOException {
95-
GetSpecifiedGroupMemberInfoRequest request = GetSpecifiedGroupMemberInfoRequest.builder()
96-
.groupId("MyFirstGroup")
97-
.memberInfoFilter(Collections.singletonList("bingo"))
98-
.build();
99-
100-
GetSpecifiedGroupMemberInfoResult result = client.group.getSpecifiedGroupMemberInfo(request);
101-
System.out.println(result);
102-
Assertions.assertEquals(ErrorCode.SUCCESS.getCode(), result.getErrorCode());
95+
GetSpecifiedGroupMemberInfoRequest request = GetSpecifiedGroupMemberInfoRequest.builder()
96+
.groupId("MyFirstGroup")
97+
.memberInfoFilter(Collections.singletonList("bingo"))
98+
.build();
99+
100+
GetSpecifiedGroupMemberInfoResult result = client.group.getSpecifiedGroupMemberInfo(request);
101+
System.out.println(result);
102+
Assertions.assertEquals(ErrorCode.SUCCESS.getCode(), result.getErrorCode());
103103
}
104104

105105
@Test

0 commit comments

Comments
 (0)