easemob-websdk 4.6.0 → 4.7.0-beta

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changes to easemob chat
 
+# 4.7.0 (April 26, 2024)
+
+- `recallMessage` methods add custom field  `ext` params.
+- Adds `getJoinedChatRooms` method to get the current user has joined chat room list.
+- Adds `logger.setConsoleLogVisibility` method to sets whether to output logs to the console.
+- Fix `allowGroupAck` status error
 
 # 4.6.0 (April 2, 2024)
 

package/Easemob-chat.d.ts

@@ -259,6 +259,13 @@ export declare namespace EasemobChat {
 	}
 	type GetChatRoomsResult = ChatRoomBaseInfo[];
 
+	type JoinedChatRoomInfo = Pick<
+		GetChatRoomDetailsResult,
+		'id' | 'name' | 'owner' | 'created' | 'description' | 'maxusers'
+	>;
+
+	type JoinedChatRoomsResult = JoinedChatRoomInfo[];
+
 	type BaseMembers = { member: string } | { owner: string };
 
 	interface GetChatRoomDetailsResult {
@@ -1530,11 +1537,11 @@ export declare namespace EasemobChat {
 		open(parameters: {
 			/** The User ID. */
 			user: string;
-			/** The password. It is recommended to use `accessToken` params. */
+			/** @deprecated The password. It is recommended to use `accessToken` params.*/
 			pwd?: string;
 			/** Token required to connect to the message service. */
 			accessToken?: string;
-			/** @deprecated Use 'accessToken' instead. */
+			/** @deprecated It is recommended to use `accessToken` params. */
 			agoraToken?: string;
 			success?: (res: any) => void;
 			error?: (res: any) => void;
@@ -2712,7 +2719,7 @@ export declare namespace EasemobChat {
 		 * Lists all the groups a user has joined.
 		 *
 		 * @note
-		 * If either `needAffiliations` or `needAffiliations` is set `true`, when you get data with pagination, the current page number (pageNum) starts from 0 and you can get a maximum of 20 groups (pageSize) on each page and
+		 * If either `needAffiliations` or `needRole` is set `true`, when you get data with pagination, the current page number (pageNum) starts from 0 and you can get a maximum of 20 groups (pageSize) on each page and
 		 * the function return type is `Promise<AsyncResult<GroupTypes.GroupInfo[]>`
 		 *
 		 * If neither of the parameters is set, when you get data with pagination, the current page number (pageNum) starts from 1 and you can get a maximum of 500 groups (pageSize) on each page and and
@@ -2731,13 +2738,13 @@ export declare namespace EasemobChat {
 			this: Connection,
 			params: {
 				/**
-				 * If either `needAffiliations` or `needAffiliations` is set, when you get data with pagination, the current page number (pageNum) starts from 0.
+				 * If either `needAffiliations` or `needRole` is set, when you get data with pagination, the current page number (pageNum) starts from 0.
 				 *
 				 * If neither of the parameters is set, when you get data with pagination, the current page number (pageNum) starts from 1.
 				 * */
 				pageNum: number;
 				/**
-				 * If either `needAffiliations` or `needAffiliations` is set, when you get data with pagination, you can get a maximum of 20 groups (pageSize) on each page.
+				 * If either `needAffiliations` or `needRole` is set, when you get data with pagination, you can get a maximum of 20 groups (pageSize) on each page.
 				 *
 				 * If neither of the parameters is set, when you get data with pagination, you can get a maximum of 500 groups (pageSize) on each page.
 				 * */
@@ -4478,6 +4485,8 @@ export declare namespace EasemobChat {
 				chatType?: 'singleChat' | 'groupChat' | 'chatRoom';
 				/** Whether the message is in the thread. */
 				isChatThread?: boolean;
+				/** Custom extension fields. */
+				ext?: string;
 				success?: (res: number) => void;
 				fail?: (error: ErrorEvent) => void;
 			}
@@ -5519,6 +5528,24 @@ export declare namespace EasemobChat {
 				isForced?: boolean;
 			}
 		): Promise<void>;
+
+		/**
+		 *
+		 * Gets the list of chat rooms that a user has joined.
+		 *
+		 * ```typescript
+		 * connection.getJoinedChatRooms({pageNum: 1, pageSize: 20})
+		 * ```
+		 */
+		getJoinedChatRooms(
+			this: Connection,
+			params: {
+				/** The page number, starting from 1. */
+				pageNum: number;
+				/** The number of chat rooms to get per page. The value cannot exceed 500. */
+				pageSize: number;
+			}
+		): Promise<AsyncResult<JoinedChatRoomsResult>>;
 	}
 
 	// ----- for EventHandler ------
@@ -6031,6 +6058,8 @@ export declare namespace EasemobChat {
 			/** The log content. */
 			logs: any[];
 		}): void;
+		/** Sets whether to output logs to the console. */
+		setConsoleLogVisibility(visible: boolean): void;
 	}
 
 	// --- for Message ---
@@ -7482,6 +7511,8 @@ export declare namespace EasemobChat {
 		mid: string;
 		/** Message online state type. */
 		onlineState?: ONLINESTATETYPE;
+		/** Custom extension fields. */
+		ext: string;
 	}
 
 	interface ContactMsgBody {