easemob-websdk 4.10.0 → 4.12.0-beta

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Changes to easemob chat
 
+## 4.12.0 (Jan 9, 2025)
+
+### 新增特性
+
+1. `onModifiedMessage` 事件回调中增加 ext 字段。
+2. 加入聊天室 `joinChatRoom` 成功回调新增当前聊天室信息。
+
+### 修复
+
+1. 格式化小程序SDK API 请求失败错误码， 和Web端统一。
+2. 修复uniapp sdk 在4.36版本运行到鸿蒙平台，无限重连的问题。
+3. 修复偶现无法拉取消息的问题。
+
+### 优化
+
+1. 优化重连时间间隔
+2. 小程序SDK支持httpDNS, 默认开启
+
+
+## 4.11.0 (Nov 29, 2024)
+
+### 新增特性
+
+1. 获取历史消息时，消息体内增加 isRead, isDelivery 字段，只支持单聊。
+2. 禁言回调中携带禁言到期的时间戳。
+3. 去掉 sockjs
+4. 群组/聊天室禁言事件增加 userId 字段，表示被禁言的人
+5. uniapp sdk 支持鸿蒙系统
+
+### 修复
+
+1. 修复 pin 消息事件 conversationId 不对
+
 ## 4.10.0 (Oct 10, 2024)
 
 ### 新增特性

package/Easemob-chat.d.ts

@@ -26,19 +26,6 @@ export declare namespace EasemobChat {
 	/** The group ID.  */
 	type GroupId = string;
 
-	interface CommonRequestResult {
-		/** The result of request. */
-		result: boolean;
-		/** Action. */
-		action: string;
-		/** The reason of failure. */
-		reason?: string;
-		/** The user ID. */
-		user: string;
-		/** The group/chat room ID. */
-		id: string;
-	}
-
 	interface Jid {
 		appKey: string;
 		clientResource: string;
@@ -256,9 +243,11 @@ export declare namespace EasemobChat {
 		| GroupMemberAttributesUpdateMultiDeviceInfo
 		| NotificationMultiDeviceInfo;
 
-	interface ConnectionParameters {
-		/** The unique application key registered in console. */
-		appKey: string;
+	type ConnectionParameters = {
+		/** The unique application key registered on the console. */
+		appKey?: string;
+		/** The unique application id registered on the console. */
+		appId?: string;
 		/** Whether to enable the delivery receipt function. - `true`: Enable; - (Default)`false`: Do not enable. */
 		delivery?: boolean;
 		/** Heartbeat interval, in milliseconds. */
@@ -285,7 +274,7 @@ export declare namespace EasemobChat {
 		 * <br> This parameter has an impact on the kicking policy during a multi-device login scenario.
 		 */
 		isFixedDeviceId?: boolean;
-	}
+	};
 
 	interface RegisterUserResult extends AsyncResult {
 		entities: BaseUserInfo[];
@@ -366,6 +355,24 @@ export declare namespace EasemobChat {
 		id: string;
 	}
 
+	interface JoinChatRoomInfo {
+		/** Whether all members are muted. */
+		isAllMembersMuted: boolean;
+		/** Chatroom creation time. */
+		createTimestamp: number;
+		/** Whether the member is on the allowlist. */
+		isInAllowlist: boolean;
+		/** The current number of members in the chat room. */
+		memberCount: number;
+		/** The member mute expiration time. if the member is not muted, the value is -1. */
+		muteExpireTimestamp: number;
+	}
+
+	type JoinChatRoomResult = CommonRequestResult & {
+		/** The information returned after joining a chat room. */
+		info: JoinChatRoomInfo;
+	};
+
 	interface AddUsersToChatRoomResult {
 		/** The newly added members. */
 		newmembers: string[];
@@ -1837,10 +1844,10 @@ export declare namespace EasemobChat {
 				 * -  (Default) `false`: The user joins the chat room, without leaving all other chat rooms.
 				 */
 				leaveOtherRooms?: boolean;
-				success?: (res: AsyncResult<CommonRequestResult>) => void;
+				success?: (res: AsyncResult<JoinChatRoomResult>) => void;
 				error?: (error: ErrorEvent) => void;
 			}
-		): Promise<AsyncResult<CommonRequestResult>>;
+		): Promise<AsyncResult<JoinChatRoomResult>>;
 
 		/**
 		 * @deprecated Use {@link leaveChatRoom} instead.
@@ -5391,6 +5398,20 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<TranslationLanguageType>>;
 
+		/**
+		 * Get all conversations in silent mode.
+		 *
+		 * ```typescript
+		 * connection.getSilentModeRemindTypeConversations({pageSize: 10})
+		 * ```
+		 */
+		getSilentModeRemindTypeConversations(params: {
+			/** 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 data entries per page. The default value is 10. */
+			pageSize: number;
+		}): Promise<AsyncResult<GetSilentModeRemindTypeConversationsResult>>;
+
 		/**
 		 * Adds a reaction to the message.
 		 *
@@ -5688,6 +5709,8 @@ export declare namespace EasemobChat {
 		reason?: string;
 		/** The updated announcement. */
 		announcement?: string;
+		/** Expiration time for user mute. */
+		muteTimestamp?: { [key: string]: number };
 	}
 
 	interface GetChatroomAttributesResult {
@@ -6250,6 +6273,7 @@ export declare namespace EasemobChat {
 		kicked?: string;
 		detail?: GroupModifyInfo;
 		ext?: string;
+		muteTimestamp?: { [key: string]: number };
 	}
 
 	interface ReadMsgSetParameters {
@@ -6521,6 +6545,10 @@ export declare namespace EasemobChat {
 		modifiedInfo?: ModifiedMsgInfo;
 		/** The list of message recipients. */
 		receiverList?: string[];
+		/** Has the message been read (only single chat messages have this field). */
+		isRead?: boolean;
+		/** Has the message been delivered (only single chat messages have this field). */
+		isDelivered?: boolean;
 	}
 
 	interface CreateTextMsgParameters {
@@ -6614,6 +6642,10 @@ export declare namespace EasemobChat {
 		onFileUploadError?: (error: any) => void;
 		/** The callback of file upload completion. */
 		onFileUploadComplete?: (data: { url: string; secret: string }) => void;
+		/** Has the message been read (only single chat messages have this field). */
+		isRead?: boolean;
+		/** Has the message been delivered (only single chat messages have this field). */
+		isDelivered?: boolean;
 	}
 
 	type CombineMsgList = Exclude<
@@ -6734,6 +6766,10 @@ export declare namespace EasemobChat {
 		deliverOnlineOnly?: boolean;
 		/** The list of message recipients. */
 		receiverList?: string[];
+		/** Has the message been read (only single chat messages have this field). */
+		isRead?: boolean;
+		/** Has the message been delivered (only single chat messages have this field). */
+		isDelivered?: boolean;
 	}
 
 	interface CreateCmdMsgParameters {
@@ -6848,6 +6884,10 @@ export declare namespace EasemobChat {
 		receiverList?: string[];
 		/** Message modified info. */
 		modifiedInfo?: ModifiedMsgInfo;
+		/** Has the message been read (only single chat messages have this field). */
+		isRead?: boolean;
+		/** Has the message been delivered (only single chat messages have this field). */
+		isDelivered?: boolean;
 	}
 
 	interface CreateCustomMsgParameters {
@@ -6968,6 +7008,10 @@ export declare namespace EasemobChat {
 		deliverOnlineOnly?: boolean;
 		/** The list of message recipients. */
 		receiverList?: string[];
+		/** Has the message been read (only single chat messages have this field). */
+		isRead?: boolean;
+		/** Has the message been delivered (only single chat messages have this field). */
+		isDelivered?: boolean;
 	}
 
 	interface CreateLocationMsgParameters {
@@ -7112,6 +7156,10 @@ export declare namespace EasemobChat {
 		 *  - (Default) `false`: The message is delivered when the recipient(s) is/are online. If the recipient(s) is/are offline, the message will not be delivered to them until they get online.
 		 */
 		deliverOnlineOnly?: boolean;
+		/** Has the message been read (only single chat messages have this field). */
+		isRead?: boolean;
+		/** Has the message been delivered (only single chat messages have this field). */
+		isDelivered?: boolean;
 	}
 
 	interface CreateFileMsgParameters {
@@ -7258,6 +7306,10 @@ export declare namespace EasemobChat {
 		thumbnailWidth?: number;
 		/** The thumbnail height. */
 		thumbnailHeight?: number;
+		/** Has the message been read (only single chat messages have this field). */
+		isRead?: boolean;
+		/** Has the message been delivered (only single chat messages have this field). */
+		isDelivered?: boolean;
 	}
 
 	interface CreateImgMsgParameters {
@@ -7407,6 +7459,10 @@ export declare namespace EasemobChat {
 		deliverOnlineOnly?: boolean;
 		/** The list of message recipients. */
 		receiverList?: string[];
+		/** Has the message been read (only single chat messages have this field). */
+		isRead?: boolean;
+		/** Has the message been delivered (only single chat messages have this field). */
+		isDelivered?: boolean;
 	}
 
 	interface CreateAudioMsgParameters {
@@ -7556,6 +7612,10 @@ export declare namespace EasemobChat {
 		deliverOnlineOnly?: boolean;
 		/** The list of message recipients. */
 		receiverList?: string[];
+		/** Has the message been read (only single chat messages have this field). */
+		isRead?: boolean;
+		/** Has the message been delivered (only single chat messages have this field). */
+		isDelivered?: boolean;
 	}
 
 	interface CreateVideoMsgParameters {