easemob-websdk 4.0.6 → 4.0.8

package/CHANGELOG.md

@@ -1,30 +1,37 @@
 # Changes to easemob chat
 
-## ## 4.0.6 (May 21, 2022)
-
-- Add chatThread feature
-- Add the API to the session list to parse the last message
-- Modify the implementation of obtaining roaming messages
-- Add the mark of offline message in the message
-
-## ## 4.0.5 (May 15, 2022)
-
-- Add reporting API for content auditing
-- Add push setting API to support different push configuration
-- Add the data reporting function
-- The API for getting groups that you have joined supports paging
-- When creating a group, the SDK supports setting the number of group members
-- Add thumbnail address parameter to receive picture message
-- Fixed group chat message cache issues
+## 4.0.8 (Jun 17, 2022)
+
+-   'GetGroupInfo' supports bulk query
+-   Add group event:onGroupEvent 
+-   Add chatroom event:onChatroomEvent
+-   Add the limit when sending group messages
+-   Invite to join the group callback returns the group name
+## 4.0.7 (May 25, 2022)
+
+-   Add chatThread feature
+-   Add the API to the session list to parse the last message
+-   Modify the implementation of obtaining roaming messages
+-   Add the mark of offline message in the message
+
+## 4.0.5 (May 15, 2022)
+
+-   Add reporting API for content auditing
+-   Add push setting API to support different push configuration
+-   Add the data reporting function
+-   The API for getting groups that you have joined supports paging
+-   When creating a group, the SDK supports setting the number of group members
+-   Add thumbnail address parameter to receive picture message
+-   Fixed group chat message cache issues
 
 ## 4.0.4 (April 19, 2022)
 
-- Add presence feature
-- Add translation feature
-- Optimizing miniProgram does not require the isHttpDNS parameter
-- Fixed failure to modify desc when creating a group
-- Fixed SSR compatibility
-- Fixed uni_SDK not running in browser
+-   Add presence feature
+-   Add translation feature
+-   Optimizing miniProgram does not require the isHttpDNS parameter
+-   Fixed failure to modify desc when creating a group
+-   Fixed SSR compatibility
+-   Fixed uni_SDK not running in browser
 
 ## 4.0.3 (January 19, 2022)
 

package/Easemob-chat.d.ts

@@ -978,8 +978,8 @@ export declare namespace EasemobChat {
 		lastMessage: LastMessage;
 		/** The number of unread messages. */
 		unread_num: number;
-  }
-  
+	}
+
 	interface GetReactionDetailResult {
 		/** The reaction to be added to the message. The length is limited to 128 characters. */
 		reaction: string;
@@ -1022,34 +1022,31 @@ export declare namespace EasemobChat {
 		REQUEST_TIMEOUT = -1,
 		REQUEST_UNKNOWN = -2,
 		REQUEST_PARAMETER_ERROR = -3,
+		REQUEST_ABORT = -4,
 		WEBIM_CONNCTION_USER_NOT_ASSIGN_ERROR = 0,
 		WEBIM_CONNCTION_OPEN_ERROR = 1,
 		WEBIM_CONNCTION_AUTH_ERROR = 2,
 		WEBIM_CONNCTION_OPEN_USERGRID_ERROR = 3,
-		WEBIM_CONNCTION_ATTACH_ERROR = 4, // unused
-		WEBIM_CONNCTION_ATTACH_USERGRID_ERROR = 5, // unused
-		WEBIM_CONNCTION_REOPEN_ERROR = 6, // unused
-		WEBIM_CONNCTION_SERVER_CLOSE_ERROR = 7, //7 = client-side network offline (netE= RR_INTERNET_DISCONNECTED) unused
-		WEBIM_CONNCTION_SERVER_ERROR = 8, //8 = offline by multi login  unused
+		WEBIM_CONNCTION_ATTACH_ERROR = 4,
+		WEBIM_CONNCTION_ATTACH_USERGRID_ERROR = 5,
+		WEBIM_CONNCTION_REOPEN_ERROR = 6,
+		WEBIM_CONNCTION_SERVER_CLOSE_ERROR = 7,
+		WEBIM_CONNCTION_SERVER_ERROR = 8,
 		WEBIM_CONNCTION_IQ_ERROR = 9,
-		WEBIM_CONNCTION_USER_REMOVED = 207,
-		WEBIM_CONNCTION_USER_LOGIN_ANOTHER_DEVICE = 206,
-		WEBIM_CONNCTION_USER_KICKED_BY_CHANGE_PASSWORD = 216,
-		WEBIM_CONNCTION_USER_KICKED_BY_OTHER_DEVICE = 217,
 		WEBIM_CONNCTION_PING_ERROR = 10,
 		WEBIM_CONNCTION_NOTIFYVERSION_ERROR = 11,
 		WEBIM_CONNCTION_GETROSTER_ERROR = 12,
 		WEBIM_CONNCTION_CROSSDOMAIN_ERROR = 13,
 		WEBIM_CONNCTION_LISTENING_OUTOF_MAXRETRIES = 14,
 		WEBIM_CONNCTION_RECEIVEMSG_CONTENTERROR = 15,
-		WEBIM_CONNCTION_DISCONNECTED = 16, //16 = server-side close the websocket connection
-		WEBIM_CONNCTION_AJAX_ERROR = 17, // ajax error
+		WEBIM_CONNCTION_DISCONNECTED = 16,
+		WEBIM_CONNCTION_AJAX_ERROR = 17,
 		WEBIM_CONNCTION_JOINROOM_ERROR = 18,
 		WEBIM_CONNCTION_GETROOM_ERROR = 19,
-		WEBIM_CONNCTION_GETROOMINFO_ERROR = 20, // unused
-		WEBIM_CONNCTION_GETROOMMEMBER_ERROR = 21, // unused
-		WEBIM_CONNCTION_GETROOMOCCUPANTS_ERROR = 22, // unused
-		WEBIM_CONNCTION_LOAD_CHATROOM_ERROR = 23, // 获取聊天室失败，拉取历史消息失败（后面去掉）
+		WEBIM_CONNCTION_GETROOMINFO_ERROR = 20,
+		WEBIM_CONNCTION_GETROOMMEMBER_ERROR = 21,
+		WEBIM_CONNCTION_GETROOMOCCUPANTS_ERROR = 22,
+		WEBIM_CONNCTION_LOAD_CHATROOM_ERROR = 23,
 		WEBIM_CONNCTION_NOT_SUPPORT_CHATROOM_ERROR = 24,
 		WEBIM_CONNCTION_JOINCHATROOM_ERROR = 25,
 		WEBIM_CONNCTION_QUITCHATROOM_ERROR = 26,
@@ -1057,24 +1054,34 @@ export declare namespace EasemobChat {
 		WEBIM_CONNCTION_TOKEN_NOT_ASSIGN_ERROR = 28,
 		WEBIM_CONNCTION_SESSIONID_NOT_ASSIGN_ERROR = 29,
 		WEBIM_CONNCTION_RID_NOT_ASSIGN_ERROR = 30,
-		WEBIM_CONNCTION_CALLBACK_INNER_ERROR = 31, //31 = 处理下行消息出错 try/catch抛出异常
-		WEBIM_CONNCTION_CLIENT_OFFLINE = 32, //32 = client offline
-		WEBIM_CONNCTION_CLIENT_LOGOUT = 33, //33 = client logout
-		WEBIM_CONNCTION_CLIENT_TOO_MUCH_ERROR = 34, // 34 = Over amount of the tabs a user opened in the same browser
+		WEBIM_CONNCTION_CALLBACK_INNER_ERROR = 31,
+		WEBIM_CONNCTION_CLIENT_OFFLINE = 32,
+		WEBIM_CONNCTION_CLIENT_LOGOUT = 33,
+		WEBIM_CONNCTION_CLIENT_TOO_MUCH_ERROR = 34,
 		WEBIM_CONNECTION_ACCEPT_INVITATION_FROM_GROUP = 35,
 		WEBIM_CONNECTION_DECLINE_INVITATION_FROM_GROUP = 36,
 		WEBIM_CONNECTION_ACCEPT_JOIN_GROUP = 37,
 		WEBIM_CONNECTION_DECLINE_JOIN_GROUP = 38,
 		WEBIM_CONNECTION_CLOSED = 39,
 		WEBIM_CONNECTION_ERROR = 40,
+		MAX_LIMIT = 50,
+		MESSAGE_NOT_FOUND = 51,
+		NO_PERMISSION = 52,
+		OPERATION_UNSUPPORTED = 53,
 		WEBIM_UPLOADFILE_BROWSER_ERROR = 100,
 		WEBIM_UPLOADFILE_ERROR = 101,
 		WEBIM_UPLOADFILE_NO_LOGIN = 102,
 		WEBIM_UPLOADFILE_NO_FILE = 103,
-		WEBIM_DOWNLOADFILE_ERROR = 200, // unused
-		WEBIM_DOWNLOADFILE_NO_LOGIN = 201, // unused
-		WEBIM_DOWNLOADFILE_BROWSER_ERROR = 202, // unused
-		USER_NOT_FOUND = 204, // 用户不存在，如创建群拉人时不存在的用户报次错误
+		WEBIM_DOWNLOADFILE_ERROR = 200,
+		WEBIM_DOWNLOADFILE_NO_LOGIN = 201,
+		WEBIM_DOWNLOADFILE_BROWSER_ERROR = 202,
+		USER_NOT_FOUND = 204,
+		WEBIM_CONNCTION_USER_LOGIN_ANOTHER_DEVICE = 206,
+		WEBIM_CONNCTION_USER_REMOVED = 207,
+		WEBIM_CONNCTION_USER_KICKED_BY_CHANGE_PASSWORD = 216,
+		WEBIM_CONNCTION_USER_KICKED_BY_OTHER_DEVICE = 217,
+		USER_MUTED_BY_ADMIN = 219,
+		USER_NOT_FRIEND = 221,
 		WEBIM_MESSAGE_REC_TEXT = 300,
 		WEBIM_MESSAGE_REC_TEXT_ERROR = 301,
 		WEBIM_MESSAGE_REC_EMOTION = 302,
@@ -1101,23 +1108,34 @@ export declare namespace EasemobChat {
 		STATUS_CLOSED = 405,
 		STATUS_ERROR = 406,
 		SERVER_BUSY = 500,
-		GROUP_NOT_EXIST = 605,
-		GROUP_NOT_JOINED = 602, // 禁言等操作的人员不在群组中
+		MESSAGE_INCLUDE_ILLEGAL_CONTENT = 501,
+		MESSAGE_EXTERNAL_LOGIC_BLOCKED = 502,
+		SERVER_UNKNOWN_ERROR = 503,
 		MESSAGE_RECALL_TIME_LIMIT = 504,
 		SERVICE_NOT_ENABLED = 505,
 		SERVICE_NOT_ALLOW_MESSAGING = 506,
-		SERVICE_NOT_ALLOW_MESSAGING_MUTE = 507, // @since 4.0  被禁言
-		SERVER_UNKNOWN_ERROR = 503, //未知异常
-		MESSAGE_INCLUDE_ILLEGAL_CONTENT = 501, //消息内容包含非法或敏感词
-		MESSAGE_EXTERNAL_LOGIC_BLOCKED = 502, // 消息被拦截
-		PERMISSION_DENIED = 603, //权限问题
-		WEBIM_LOAD_MSG_ERROR = 604, //消息发送失败下行
-		GROUP_ALREADY_JOINED = 601, //|已在该群组中|调用 加入群组的 API 时如果已经在该群组中则提示该错误|
-		// 700 参数校验
+		SERVICE_NOT_ALLOW_MESSAGING_MUTE = 507,
+		MESSAGE_MODERATION_BLOCKED = 508,
+		GROUP_NOT_EXIST = 605,
+		GROUP_NOT_JOINED = 602,
+		GROUP_MEMBERS_FULL = 606,
+		PERMISSION_DENIED = 603,
+		WEBIM_LOAD_MSG_ERROR = 604,
+		GROUP_ALREADY_JOINED = 601,
+		GROUP_MEMBERS_LIMIT = 607,
 		REST_PARAMS_STATUS = 700,
-		CHATROOM_MEMBERS_FULL = 704, // 聊天室人数达到上限
-		CHATROOM_NOT_EXIST = 705, // The chat room does not exist
+		CHATROOM_MEMBERS_FULL = 704,
+		CHATROOM_NOT_EXIST = 705,
 		SDK_RUNTIME_ERROR = 999,
+		PRESENCE_PARAM_EXCEED = 1100,
+		REACTION_ALREADY_ADDED = 1101,
+		REACTION_CREATING = 1102,
+		REACTION_OPERATION_IS_ILLEGAL = 1103,
+		TRANSLATION_NOT_VALID = 1200,
+		TRANSLATION_TEXT_TOO_LONG = 1201,
+		TRANSLATION_FAILED = 1204,
+		THREAD_NOT_EXIST = 1300,
+		THREAD_ALREADY_EXIST = 1301,
 	}
 
 	/**
@@ -2131,7 +2149,7 @@ export declare namespace EasemobChat {
 		getGroupInfo(
 			this: Connection,
 			params: {
-				groupId: string;
+				groupId: string | string[];
 				success?: (res: AsyncResult<GroupDetailInfo[]>) => void;
 				error?: (error: ErrorEvent) => void;
 			}
@@ -3085,7 +3103,11 @@ export declare namespace EasemobChat {
 				success?: (res: AsyncResult<SessionInfo[]>) => void;
 				error?: (error: ErrorEvent) => void;
 			}
-		): Promise<AsyncResult<SessionInfo[]>>;
+		): Promise<
+			AsyncResult<{
+				channel_infos: SessionInfo[];
+			}>
+		>;
 
 		/**
 		 * Gets the conversation list and the latest message under the conversation.
@@ -3145,9 +3167,12 @@ export declare namespace EasemobChat {
 		fetchUserInfoById(
 			this: Connection,
 			userId: UserId | UserId[],
-			properties: ConfigurableKey[] | ConfigurableKey
-		): Promise<AsyncResult<UpdateOwnUserInfoParams>>;
-
+			properties?: ConfigurableKey[] | ConfigurableKey
+		): Promise<
+			AsyncResult<{
+				[key: string]: UpdateOwnUserInfoParams;
+			}>
+		>;
 		/**
 		 * When registering, you can set a nickname, which is used to display when pushing messages. You can call the following API to modify the nickname.
 		 *
@@ -3458,8 +3483,8 @@ export declare namespace EasemobChat {
 		reportMessage(
 			this: Connection,
 			params: {
-				reportType: string; // 举报类型。
-				reportReason: string; // 举报原因。
+				reportType: string;
+				reportReason: string;
 				messageId: string;
 			}
 		): Promise<void>;
@@ -3667,9 +3692,10 @@ export declare namespace EasemobChat {
 			params: {
 				/** The chatThread ID. */
 				chatThreadId: string;
-      }
-     ): Promise<void>;
-    
+			}
+		): Promise<void>;
+
+		/**
 		 * Adds a reaction to the message.
 		 *
 		 * ```typescript
@@ -3698,9 +3724,10 @@ export declare namespace EasemobChat {
 			params: {
 				/** The chatThread ID. */
 				chatThreadId: string;
-      }
+			}
 		): Promise<void>;
-    
+
+		/**
 		 * Removes a reaction from a message.
 		 *
 		 * ```typescript
@@ -3837,7 +3864,8 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<ChatThreadDetail>>;
 
-		 * Gets the reaction list for the message.
+		/**
+		 *  Gets the reaction list for the message.
 		 *
 		 * ```typescript
 		 * connection.getReactionList({chatType: 'chatType', messageId: 'messageId'})
@@ -3909,6 +3937,24 @@ export declare namespace EasemobChat {
 		ts: number;
 	}
 
+	interface EventData {
+		/** The type of operation. */
+		/** 操作类型。 */
+		operation: string;
+		/** The ID of a group or chatroom. */
+		/** 群组或者聊天室 ID。 */
+		id: string;
+		/** Message sender. */
+		/** 消息发送者。 */
+		from: string;
+		/** Message receiver. */
+		/** 消息接收者。 */
+		to: string;
+		/** Additional data for the operation event. */
+		/** 操作事件的其他数据。 */
+		data?: any;
+	}
+
 	type Event =
 		| 'onOpened'
 		| 'onPresence'
@@ -3943,7 +3989,12 @@ export declare namespace EasemobChat {
 		| 'onGroupChange'
 		| 'onChatroomChange'
 		| 'onContactChange'
-		| 'onPresenceStatusChange';
+		| 'onPresenceStatusChange'
+		| 'onReactionChange'
+		| 'onChatThreadChange'
+		| 'onMultiDeviceEvent'
+		| 'onGroupEvent'
+		| 'onChatroomEvent';
 
 	interface EventHandlerType {
 		onOpened?: (msg: any) => void;
@@ -3983,6 +4034,8 @@ export declare namespace EasemobChat {
 		onChatThreadChange?: (msg: ThreadChangeInfo) => void;
 		onMultiDeviceEvent?: (msg: ThreadMultiDeviceInfo) => void;
 		onReactionChange?: (msg: ReactionMessage) => void;
+		onGroupEvent?: (eventData: EventData) => void;
+		onChatroomEvent?: (eventData: EventData) => void;
 	}
 
 	interface HandlerData {