easemob-websdk 4.14.0 → 4.15.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changes to easemob chat
 
+## 4.15.0 (May 20, 2025)
+
+### 新增特性
+
+1. 获取群成员
+
+自 WEB SDK 4.15.0 开始，增加`getGroupMembers`方法，用来获取群成员， 同时返回成员角色， 原`listGroupMembers`方法废弃。
+
+2. 获取聊天室成员
+
+自 WEB SDK 4.15.0 开始，增加`getChatRoomMembers`方法，用来获取聊天室成员， 同时返回成员角色， 原`listChatRoomMembers`方法废弃。
+
+3. 当群组发生以下操作时，SDK 改为仅回调单条事件，事件中包含所有加入/退出的成员：
+
+-   创建群组时拉多人入群
+-   批量成员加入或退出群组
+-   因解散群组导致用户退出
+    调整前：SDK 会为每个加入/退出的成员单独回调一条事件。
+
+自 WEB SDK 4.15.0 开始，群组事件增加 `membersPresence`, `membersAbsence` 事件，表示多人加入群组、退出群组。
+
+4. 修改 token 将要过期事件 `onTokenWillExpire` 的触发时机，SDK 会在 Token 有效期达到 80% 时（之前版本为 50% ）回调即将过期通知。
+
 ## 4.14.0 (Apr 18, 2025)
 
 ### 新增特性

package/Easemob-chat.d.ts

@@ -742,6 +742,13 @@ export declare namespace EasemobChat {
 
 	type GetGroupMembersAttributesResult = Record<UserId, MemberAttributes>;
 
+	type GroupMemberRole = 'owner' | 'admin' | 'member';
+	interface FetchedGroupMember {
+		role: GroupMemberRole;
+		userId: UserId;
+		joinedTime: number;
+	}
+
 	interface GroupModifyInfo {
 		/** The name of a group.  */
 		name?: string;
@@ -1926,6 +1933,8 @@ export declare namespace EasemobChat {
 		/**
 		 * Lists all chat room members with pagination.
 		 *
+		 * @deprecated Use {@link getChatRoomMembers} instead.
+		 *
 		 * ```typescript
 		 * connection.listChatRoomMembers({pageNum: 1, pageSize: 20, chatRoomId: 'chatRoomId'})
 		 * ```
@@ -1944,6 +1953,30 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<{ member: string }[]>>;
 
+		/**
+		 * Gets the list chat room members with pagination.
+		 *
+		 * ```typescript
+		 * connection.getChatRoomMembers({cursor: '', limit: 50, chatRoomId: 'chatRoomId'})
+		 * ```
+		 */
+		getChatRoomMembers(
+			this: Connection,
+			params: {
+				/** The chat room ID. */
+				chatRoomId: string;
+				/** The cursor that specifies where to start to get data. If there will be data on the next page, this method will return the value of this field to indicate the position to start to get data of the next page. If it is null, the data of the first page will be fetched. */
+				cursor?: string;
+				/** The number of members retrieved per page.  The value range is [1,50], with 50 as the default.*/
+				limit?: number;
+			}
+		): Promise<
+			AsyncResult<{
+				cursor: string | undefined;
+				members: FetchedGroupMember[];
+			}>
+		>;
+
 		/**
 		 * Gets all admins of the chat room.
 		 *
@@ -3007,6 +3040,7 @@ export declare namespace EasemobChat {
 
 		/**
 		 * Lists all members of the group with pagination.
+		 * @deprecated use {@link getGroupMembers} instead.
 		 *
 		 * ```typescript
 		 * connection.listGroupMembers({pageNum: 1, pageSize: 20, groupId: 'groupId'})
@@ -3026,6 +3060,30 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<GroupMember[]>>;
 
+		/**
+		 * Gets the list group members with pagination.
+		 *
+		 * ```typescript
+		 * connection.getGroupMembers({cursor: '', limit: 50, groupId: 'groupId'})
+		 * ```
+		 */
+		getGroupMembers(
+			this: Connection,
+			params: {
+				/** The group ID. */
+				groupId: string;
+				/** The cursor that specifies where to start to get data. If there will be data on the next page, this method will return the value of this field to indicate the position to start to get data of the next page. If it is null, the data of the first page will be fetched. */
+				cursor?: string;
+				/** The number of members retrieved per page.  The value range is [1,50], with 50 as the default.*/
+				limit?: number;
+			}
+		): Promise<
+			AsyncResult<{
+				cursor: string | undefined;
+				members: FetchedGroupMember[];
+			}>
+		>;
+
 		/**
 		 * Gets all admins in the group.
 		 * ```typescript
@@ -5767,7 +5825,7 @@ export declare namespace EasemobChat {
 		/** The ID of a group or chatroom. */
 		id: string;
 		/** Message sender. */
-		from: string;
+		from?: string;
 		/** The modified group info. */
 		detail?: GroupModifyInfo;
 		/** The name of a group or chatroom.  */
@@ -5786,6 +5844,8 @@ export declare namespace EasemobChat {
 		announcement?: string;
 		/** Expiration time for user mute. */
 		muteTimestamp?: { [key: string]: number };
+		/** User IDs of group members. */
+		members?: Array<string>;
 	}
 
 	interface GetChatroomAttributesResult {
@@ -5862,8 +5922,10 @@ export declare namespace EasemobChat {
 		 * removeMember:  Occurs when you are removed from a group or added to block list. Only the removed person receives this event.<br/>
 		 * unblockMember: Occurs when being removed from the block list. Only the removed person receives this event.<br/>
 		 * updateInfo: Occurs when modifying group. <br/>
-		 * memberPresence: Occurs when someone joined the group. <br/>
-		 * memberAbsence: Occurs when someone leaved the group. <br/>
+		 * memberPresence: Occurs when a user joined the group. <br/>
+		 * membersPresence: Occurs when more than one user joined the group. <br/>
+		 * memberAbsence: Occurs when a user leaved the group.<br/>
+		 * membersAbsence: Occurs when more than one user leaved the group. <br/>
 		 * directJoined: Occurs when you are directly pulled into the group and no consent is required. <br/>
 		 * changeOwner: Occurs when transferring group. Only new and old group owners can receive this event. <br/>
 		 * setAdmin: Occurs when being set as administrator. Only the person who is set to administrator can receive this event.<br/>
@@ -5893,7 +5955,9 @@ export declare namespace EasemobChat {
 			| 'unblockMember'
 			| 'updateInfo'
 			| 'memberPresence'
+			| 'membersPresence'
 			| 'memberAbsence'
+			| 'membersAbsence'
 			| 'directJoined'
 			| 'changeOwner'
 			| 'setAdmin'
@@ -5934,7 +5998,7 @@ export declare namespace EasemobChat {
 		 * unblockMember: Occurs when being removed from the block list. Only the removed person receives this event.<br/>
 		 * updateInfo: Occurs when modifying chat room. <br/>
 		 * memberPresence: Occurs when someone joined the chat room. <br/>
-		 * memberAbsence: Occurs when someone leaved the chat room. <br/>
+		 * memberAbsence: Occurs when someone leaved the chat room.  <br/>
 		 * setAdmin: Occurs when being set as administrator. Only the person who is set to administrator can receive this event.<br/>
 		 * removeAdmin: Occurs when you are removed as an administrator. Only the removed person can receive this event.  <br/>
 		 * muteMember: Occurs when you are muted. Only the person who is muted can receive this event. <br/>
@@ -6063,7 +6127,7 @@ export declare namespace EasemobChat {
 		onContactDeleted?: (msg: ContactMsgBody) => void;
 		/** The callback to added a contact. */
 		onContactAdded?: (msg: ContactMsgBody) => void;
-		/** The callback whose token is about to expire. */
+		/** Occurs when the token is about to expire. This event is triggered from when 20% of the validity period is left.*/
 		onTokenWillExpire?: () => void;
 		/** The callback whose token has expired. */
 		onTokenExpired?: () => void;
@@ -6291,7 +6355,8 @@ export declare namespace EasemobChat {
 		| 'img'
 		| 'audio'
 		| 'file'
-		| 'video';
+		| 'video'
+		| 'combine';
 
 	type ChatType = 'singleChat' | 'groupChat' | 'chatRoom';
 	interface FileObj {