easemob-websdk 4.1.7 → 4.2.0

package/CHANGELOG.md

@@ -1,33 +1,43 @@
 # Changes to easemob chat
 
+# 4.2.0 (Jul 27, 2023)
+
+-   Adds editing message after sent function
+-   Adds message merging and forwarding function
+-   Fix sending unnecessary delivery messages
+
 # 4.1.7 (Jun 8, 2023)
+
 -   Adds the `pinConversation` method to pin or unpin a conversation.
 -   Adds the `getServerPinnedConversations` method to gets the list of pinned conversations from the server with pagination.
--   Adds the `getServerConversations` method to get the sorted list of conversations from the server with pagination. 
+-   Adds the `getServerConversations` method to get the sorted list of conversations from the server with pagination.
 -   Adds the feature of sending targeted messages in a group or chat room conversation by adding the `receiverList` parameter to the `create` method.
 -   Adds the `isLast` parameter to the `getHistoryMessages` method to indicate whether the returned data is that of the last page.
 -   Adds the `thumbnailWidth` and `thumbnailHeight` parameters to the `create` method to allow you to set the width and height of the thumbnail when sending an image.
--   Adds the following errors to error codes 2 (WEBIM_CONNCTION_AUTH_ERROR) and 50 (MAX_LIMIT) and  to explain the reasons for SDK login failures on the console:
-    - Error code 50: The number of daily active users (DAU) has exceeded the upper limit; the number of online users has exceeds the upper limit; the number of monthly active users (MAU) has exceeded the upper limit.
-    - Error code 2: The token is invalid.
--  Adds success and failure callbacks (Promise) for the execution of the following methods:
-    - addContact: Adds a contact.
-    - deleteContact: Deletes a contact.
-    - acceptContactInvite: Accepts a friend request.
-    - declineContactInvite: Rejects a friend request. 
-    - addUsersToBlocklist: Adds a friend to the block list.
-    - removeUserFromBlocklist: Removes a friend from the block list.
+-   Adds the following errors to error codes 2 (WEBIM_CONNCTION_AUTH_ERROR) and 50 (MAX_LIMIT) and to explain the reasons for SDK login failures on the console:
+    -   Error code 50: The number of daily active users (DAU) has exceeded the upper limit; the number of online users has exceeds the upper limit; the number of monthly active users (MAU) has exceeded the upper limit.
+    -   Error code 2: The token is invalid.
+-   Adds success and failure callbacks (Promise) for the execution of the following methods:
+    -   addContact: Adds a contact.
+    -   deleteContact: Deletes a contact.
+    -   acceptContactInvite: Accepts a friend request.
+    -   declineContactInvite: Rejects a friend request.
+    -   addUsersToBlocklist: Adds a friend to the block list.
+    -   removeUserFromBlocklist: Removes a friend from the block list.
+
 ## 4.1.5 (April 13, 2023)
 
-- Adds four parameters, `from`, `msgTypes`, `startTime`, and `endTime` in `searchOptions` in the ` getHistoryMessages` method to allow you to retrieve historical messages from the server by message sender, message type, or period.
+-   Adds four parameters, `from`, `msgTypes`, `startTime`, and `endTime` in `searchOptions` in the ` getHistoryMessages` method to allow you to retrieve historical messages from the server by message sender, message type, or period.
 
 Adds The error code 511, MESSAGE_SIZE_LIMIT, to notify you when the size of the message body exceeds the upper limit.
+
 ## 4.1.4 (Mar 16, 2023)
 
 -   Add Group Member Attributes feature
 -   Fix `getHistoryMessages` catch error failed
 -   Optimize the implementation of chat room join and leave to improve performance
 -   Add `deliverOnlineOnly` field in the message creation parameters
+
 ## 4.1.3 (Feb 20, 2023)
 
 -   `getConversationlist` Getting the conversation list supports paging

package/Easemob-chat.d.ts

@@ -57,6 +57,30 @@ export declare namespace EasemobChat {
 		jid: Jid;
 	}
 
+	interface SendMsgResult {
+		/** The message local ID. */
+		localMsgId: string;
+		/** The ID of the message on the server. */
+		serverMsgId: string;
+	}
+
+	/** The modified message. */
+	type ModifiedMsg = TextMsgBody;
+
+	interface ModifyMsgResult extends SendMsgResult {
+		/** The modified message. */
+		message: ModifiedMsg;
+	}
+
+	interface ModifiedMsgInfo {
+		/** Gets the user ID of the operator that modified the message last time. */
+		operatorId: string;
+		/** Gets the number of times a message is modified. A message can be modified at most five times.*/
+		operationCount: number;
+		/** Gets the UNIX timestamp of the last message modification, in milliseconds. */
+		operationTime: number;
+	}
+
 	// eventHandle types
 	type OnPresenceMsgType =
 		| 'rmChatRoomMute'
@@ -1216,6 +1240,8 @@ export declare namespace EasemobChat {
 		WEBIM_UPLOADFILE_NO_LOGIN = 102,
 		/** File-downloading failed. */
 		WEBIM_DOWNLOADFILE_ERROR = 200,
+		/** Parse file failed. */
+		PARSE_FILE_ERROR = 203,
 		/** User does not found. */
 		USER_NOT_FOUND = 204,
 		/** The user is logged in on another device. */
@@ -4368,6 +4394,35 @@ export declare namespace EasemobChat {
 			}
 		): Promise<SendMsgResult>;
 
+		/**
+		 * Modifies a message on the server.
+		 *
+		 * This method can only modify a text message in one-to-one chats or group chats, but not in chat rooms.
+		 *
+		 * Upon a message modification, the callback `onModifiedMessage` will be received by the message recipient(s) and in multi-device login scenarios.
+		 *
+		 * ```typescript
+		 *
+		 * const textMessage = WebIM.message.create({
+		 *   type: "txt",
+		 *   msg: "message content",
+		 *   to: "username",
+		 *   chatType: "singleChat",
+		 * });
+		 *
+		 * connection.modifyMessage({ messageId: 'messageId', message: textMessage })
+		 * ```
+		 */
+		modifyMessage(
+			this: Connection,
+			option: {
+				/** The ID of the message to modify.*/
+				messageId: string;
+				/** The modified message.*/
+				modifiedMessage: ModifiedMsg;
+			}
+		): Promise<ModifyMsgResult>;
+
 		// listen @deprecated
 		listen(this: Connection, parameters: ListenParameters): void;
 
@@ -5261,6 +5316,7 @@ export declare namespace EasemobChat {
 		| 'onContactChange'
 		| 'onPresenceStatusChange'
 		| 'onReactionChange'
+		| 'onModifiedMessage'
 		| 'onChatThreadChange'
 		| 'onMultiDeviceEvent'
 		| 'onGroupEvent'
@@ -5421,6 +5477,8 @@ export declare namespace EasemobChat {
 		onRecallMessage?: (msg: RecallMsgBody) => void;
 		/** The callback to receive a session read ack. */
 		onChannelMessage?: (msg: ChannelMsgBody) => void;
+		/** Occurs when the message content is modified. */
+		onModifiedMessage?: (msg: ModifiedMsg) => void;
 		/** The callback to receive error. */
 		onError?: (error: ErrorEvent) => void;
 		/** The callback for network disconnection. */
@@ -5945,7 +6003,7 @@ export declare namespace EasemobChat {
 		/** Whether the message is a thread message. */
 		isChatThread?: boolean;
 		/** The reaction to be added to the message. The length is limited to 128 characters. */
-		reactions?: Reaction;
+		reactions?: Reaction[];
 		/** The message thread. */
 		chatThread?: ChatThread;
 		/** The message thread overview. */
@@ -5959,8 +6017,9 @@ 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;
+		/** Message modified info. */
+		modifiedInfo?: ModifiedMsgInfo;
 		/** The list of message recipients. */
-		/** 消息接收方列表。 */
 		receiverList?: string[];
 	}
 
@@ -5989,10 +6048,113 @@ export declare namespace EasemobChat {
 		 */
 		deliverOnlineOnly?: boolean;
 		/** The list of message recipients. */
-		/** 消息接收方列表。 */
 		receiverList?: string[];
 	}
 
+	interface CombineMsgBody {
+		/** The message ID. */
+		id: string;
+		/** The session type. */
+		chatType: ChatType;
+		/** The message type. */
+		type: 'combine';
+		/** The recipient. */
+		to: string;
+		/** The sender, which can only be the current user and can not be changed.*/
+		from?: string;
+		/** Message extension. */
+		ext?: { [key: string]: any };
+		/** Whether read receipts are required during a group session. */
+		msgConfig?: {
+			allowGroupAck?: boolean;
+			languages?: string[];
+		};
+		/** Time. */
+		time: number;
+		/** Whether the message is a thread message. */
+		isChatThread?: boolean;
+		/** Message priority. */
+		priority?: MessagePriority;
+		/** Whether the message is delivered only when the recipient(s) is/are online:
+		 *  - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is discarded.
+		 *  - (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;
+		/** The list of message recipients. */
+		receiverList?: string[];
+		/** The file URL. */
+		url?: string;
+		/** The secret key required to download the file. */
+		secret?: string;
+		/** The size of the  file. */
+		file_length?: number;
+		/** The file type. */
+		filename: string;
+		/** The title of the merged messages. */
+		title: string;
+		/** The summary list of merged messages. */
+		summary: string;
+		/** The reactions list of the message. */
+		reactions?: Reaction[];
+		/** The information of thread message. */
+		chatThread?: ChatThread;
+		/** The overview of thread message. */
+		chatThreadOverview?: ChatThreadOverview;
+		/** The online state. */
+		onlineState?: ONLINESTATETYPE;
+		/** Compatibility information for merging messages. */
+		compatibleText: string;
+		/** The level of the merged message. */
+		combineLevel: number;
+		/** The callback of a file upload error. */
+		onFileUploadError?: (error: any) => void;
+		/** The callback of file upload completion. */
+		onFileUploadComplete?: (data: { url: string; secret: string }) => void;
+	}
+
+	type CombineMsgList = Exclude<
+		MessagesType,
+		DeliveryMsgBody | ReadMsgBody | ChannelMsgBody
+	>[];
+
+	interface CreateCombineMsgParameters {
+		/** The conversation type. */
+		chatType: ChatType;
+		/** The message type. */
+		type: 'combine';
+		/** The recipient. */
+		to: string;
+		/** The sender, which can only be the current user and can not be changed. */
+		from?: string;
+		/** The message extension. */
+		ext?: { [key: string]: any };
+		/** Whether read receipts are required during a group session. */
+		msgConfig?: { allowGroupAck?: boolean; languages?: string[] };
+		/** Whether the message is a thread message. */
+		isChatThread?: boolean;
+		/** Message priority. */
+		priority?: MessagePriority;
+		/** Whether the message is delivered only when the recipient(s) is/are online:
+		 *  - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is discarded.
+		 *  - (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;
+		/** The list of message recipients. */
+		receiverList?: string[];
+		/** Compatibility information for merging messages. */
+		compatibleText: string;
+		/** The title of the merged messages. */
+		title: string;
+		/** The summary list of merged messages. */
+		summary: string;
+		/** The list of merged messages. */
+		messageList: CombineMsgList;
+		/** The callback of a file upload error. */
+		onFileUploadError?: (error: any) => void;
+		/** The callback of file upload completion. */
+		onFileUploadComplete?: (data: { url: string; secret: string }) => void;
+	}
+
 	interface CmdParameters {
 		/** The message type. */
 		type: 'cmd';
@@ -6048,7 +6210,7 @@ export declare namespace EasemobChat {
 		/** Whether the message is a thread message. */
 		isChatThread?: boolean;
 		/** The reaction to be added to the message. The length is limited to 128 characters. */
-		reactions?: Reaction;
+		reactions?: Reaction[];
 		/** The message thread. */
 		chatThread?: ChatThread;
 		/** The message thread overview. */
@@ -6158,7 +6320,7 @@ export declare namespace EasemobChat {
 		/** Whether the message is a thread message. */
 		isChatThread?: boolean;
 		/** The reaction to be added to the message. The length is limited to 128 characters. */
-		reactions?: Reaction;
+		reactions?: Reaction[];
 		/** The message thread. */
 		chatThread?: ChatThread;
 		/** The message thread overview. */
@@ -6276,7 +6438,7 @@ export declare namespace EasemobChat {
 		/** Whether the message is a thread message. */
 		isChatThread?: boolean;
 		/** The reaction to be added to the message. The length is limited to 128 characters. */
-		reactions?: Reaction;
+		reactions?: Reaction[];
 		/** The message thread. */
 		chatThread?: ChatThread;
 		/** The message thread overview. */
@@ -6418,7 +6580,7 @@ export declare namespace EasemobChat {
 		/** Time. */
 		time: number;
 		/** The reaction to be added to the message. The length is limited to 128 characters. */
-		reactions?: Reaction;
+		reactions?: Reaction[];
 		/** The message thread. */
 		chatThread?: ChatThread;
 		/** The message thread overview. */
@@ -6557,7 +6719,7 @@ export declare namespace EasemobChat {
 		/** Whether the message is a thread message. */
 		isChatThread?: boolean;
 		/** The reaction to be added to the message. The length is limited to 128 characters. */
-		reactions?: Reaction;
+		reactions?: Reaction[];
 		/** The message thread. */
 		chatThread?: ChatThread;
 		/** The message thread overview. */
@@ -6706,7 +6868,7 @@ export declare namespace EasemobChat {
 		/** Whether the message is a thread message. */
 		isChatThread?: boolean;
 		/** The reaction to be added to the message. The length is limited to 128 characters. */
-		reactions?: Reaction;
+		reactions?: Reaction[];
 		/** The message thread. */
 		chatThread?: ChatThread;
 		/** The message thread overview. */
@@ -6849,7 +7011,7 @@ export declare namespace EasemobChat {
 		/** Whether the message is a thread message. */
 		isChatThread?: boolean;
 		/** The reaction to be added to the message. The length is limited to 128 characters. */
-		reactions?: Reaction;
+		reactions?: Reaction[];
 		/** The message thread. */
 		chatThread?: ChatThread;
 		/** The message thread overview. */
@@ -6979,7 +7141,8 @@ export declare namespace EasemobChat {
 		| AudioMsgBody
 		| VideoMsgBody
 		| FileMsgBody
-		| ReadMsgBody;
+		| ReadMsgBody
+		| CombineMsgBody;
 
 	type MessageSetParameters =
 		| ReadMsgSetParameters
@@ -7005,7 +7168,8 @@ export declare namespace EasemobChat {
 		| CreateChannelMsgParameters
 		| CreateDeliveryMsgParameters
 		| CreateReadMsgParameters
-		| CreateAudioMsgParameters;
+		| CreateAudioMsgParameters
+		| CreateCombineMsgParameters;
 
 	type MessageBody =
 		| ReadMsgBody
@@ -7018,7 +7182,9 @@ export declare namespace EasemobChat {
 		| ImgMsgBody
 		| AudioMsgBody
 		| VideoMsgBody
-		| FileMsgBody;
+		| FileMsgBody
+		| CombineMsgBody;
+
 	type MessagePriority = 'high' | 'normal' | 'low';
 	interface PriorityExt {
 		chatroom_msg_tag: number;