easemob-websdk 4.8.1-beta → 4.9.0-beta

package/CHANGELOG.md

@@ -1,66 +1,80 @@
 # Changes to easemob chat
 
-# 4.8.1 (Jul 2, 2024)
+# 4.9.0 (August 29, 2024)
 
-- Fix the mini program is not able to report logs
-- Fix not export types issue
+- Add `onOfflineMessageSyncStart` and `onOfflineMessageSyncFinish` event.
+- Add multi device events `setSilentModeForConversation` and `removeSilentModeForConversation`.
+- Fix `ChatroomEvent` and `GroupEvent` missed `reason` field.
+- PIN message support single chat.
+- Add callback error when get DNS failed
+- Remove redundant judgment at reconnecting.
+- chore: fix type errors and debug logs
+
+# 4.8.1 (Jul 15, 2024)
+
+-   Fix uploading logs takes too much time
+
+# 4.8.1-beta (Jul 2, 2024)
+
+-   Fix the mini program is not able to report logs
+-   Fix not export types issue
 
 # 4.8.0 (June 28, 2024)
 
-- `onDisconnected` event add callback params to give the disconnected reason.
-- Adds allow extension field to be carried when the device logs in and passes them to the kicked device.
-   - `setLoginInfoCustomExt` Set the device's login extension field.
-   - `onDisconnected` In a multi-device login scenario, if the current device is kicked offline by the newly logged-in device, the event received by the kicked device will carry the extended information of the new device.
- - Adds `Connection Parameters#isFixedDeviceId` initialization params, default is `true`, use fixed deviceId, precede version SDK is used random deviceId.
- - `destroyChatRoom` supports the chatroom owner to destroy a chatroom.
- - `joinChatRoom` supports passing in extension field and whether to exit other joined chatrooms when joining a chatroom.
-- Adds report SDK log feature.
-- Increase the timeout period for SDK to connect to the server.
-- Fix on uniapp vue3 platform SDK reconnect failed.
+-   `onDisconnected` event add callback params to give the disconnected reason.
+-   Adds allow extension field to be carried when the device logs in and passes them to the kicked device.
+    -   `setLoginInfoCustomExt` Set the device's login extension field.
+    -   `onDisconnected` In a multi-device login scenario, if the current device is kicked offline by the newly logged-in device, the event received by the kicked device will carry the extended information of the new device.
+-   Adds `Connection Parameters#isFixedDeviceId` initialization params, default is `true`, use fixed deviceId, precede version SDK is used random deviceId.
+-   `destroyChatRoom` supports the chatroom owner to destroy a chatroom.
+-   `joinChatRoom` supports passing in extension field and whether to exit other joined chatrooms when joining a chatroom.
+-   Adds report SDK log feature.
+-   Increase the timeout period for SDK to connect to the server.
+-   Fix on uniapp vue3 platform SDK reconnect failed.
 
 # 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
+-   `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)
 
-- Adds pin message feature.
-    - pinMessage
-    - unpinMessage
-    - getServerPinnedMessages
-- Adds `onMessagePinEvent` callback to handle the message pin event.        
-- `onModifiedMessage` support custom message.
-- `getHistoryMessages` support get chat room history message.
-- Support custom chat room ID.
-- Optimize token login failed error code for make the reason more clearly.
-- Fix the message field  `onlineState` status error.
+-   Adds pin message feature.
+    -   pinMessage
+    -   unpinMessage
+    -   getServerPinnedMessages
+-   Adds `onMessagePinEvent` callback to handle the message pin event.
+-   `onModifiedMessage` support custom message.
+-   `getHistoryMessages` support get chat room history message.
+-   Support custom chat room ID.
+-   Optimize token login failed error code for make the reason more clearly.
+-   Fix the message field `onlineState` status error.
 
 # 4.5.1 (Feb 21, 2024)
 
-- Format the attachment file url.
-- Fixed bug when UniApp run ios platform send receiverList msg 
+-   Format the attachment file url.
+-   Fixed bug when UniApp run ios platform send receiverList msg
 
 # 4.5.0 (Jan 30, 2024)
 
 -   The member absence and presence events of chat rooms and groups have added a `memberCount` field
 -   Adds the `deleteAllMessagesAndConversations` methods, which can clear the chat history of the current user, including messages and conversations
 -   Adds the getSelfIdsOnOtherPlatform method, which can get a list of login IDs of the current user on other login devices, and realize sending messages to specified devices
-- Removed unnecessary unique fields from the Web local database
-- Format the customExts field of the most recent custom message in the conversation list
-- Fix the issue of pulling messages repeatedly
-- Fix the issue of abnormal message order in the `onMessage` callback
-- Fix the error of introducing the MiniCore plugin in vite electron
-- Fix the issue of abnormal API request parameters for `updateOwnUserInfo` after introducing the WeChat SDK in H5
+-   Removed unnecessary unique fields from the Web local database
+-   Format the customExts field of the most recent custom message in the conversation list
+-   Fix the issue of pulling messages repeatedly
+-   Fix the issue of abnormal message order in the `onMessage` callback
+-   Fix the error of introducing the MiniCore plugin in vite electron
+-   Fix the issue of abnormal API request parameters for `updateOwnUserInfo` after introducing the WeChat SDK in H5
 
 # 4.4.0 (Dec 22, 2023)
 
 -   Adds conversation Conversation Mark
-    - addConversationMark
-    - removeConversationMark
-    - getServerConversationsByFilter
+    -   addConversationMark
+    -   removeConversationMark
+    -   getServerConversationsByFilter
 -   Adds Attach Slice Upload
 -   Adds `onMessage` Event
 -   Adds thumbnail to video message
@@ -76,21 +90,22 @@
 # 4.3.0 (Nov 13, 2023)
 
 -   Adds contact API
-    - setContactRemark
-    - getAllContacts
-    - getContactsWithCursor
+    -   setContactRemark
+    -   getAllContacts
+    -   getContactsWithCursor
 -   Adds chatRoom broadcast
 -   Adds token expiration callback
 
 # 4.2.1 (SEP 26, 2023)
 
 -   Adds LocalCache API
-    - getLocalConversations
-	- setLocalConversationCustomField
-	- getLocalConversation
-	- removeLocalConversation
-	- clearConversationUnreadCount
+    -   getLocalConversations
+    -   setLocalConversationCustomField
+    -   getLocalConversation
+    -   removeLocalConversation
+    -   clearConversationUnreadCount
 -   onGroupEvent `joinPublicGroupDeclined` callback add the applicant userID
+
 # 4.2.0 (Jul 27, 2023)
 
 -   Adds editing message after sent function

package/Easemob-chat.d.ts

@@ -154,7 +154,10 @@ export declare namespace EasemobChat {
 		| 'chatThreadDestroy'
 		| 'chatThreadJoin'
 		| 'chatThreadLeave'
-		| 'chatThreadNameUpdate';
+		| 'chatThreadNameUpdate'
+		| 'setSilentModeForUser'
+		| 'removeSilentModeForConversation'
+		| 'setSilentModeForConversation';
 
 	interface ThreadMultiDeviceInfo {
 		/** Event name of thread multi device event. */
@@ -211,11 +214,37 @@ export declare namespace EasemobChat {
 		timestamp: number;
 	}
 
+	interface NotificationConMultiDeviceInfo {
+		operation:
+			| 'setSilentModeForConversation'
+			| 'removeSilentModeForConversation';
+		resource: string;
+		conversationId: string;
+		type: 'singleChat' | 'groupChat';
+		data: {
+			type?: 'AT' | 'NONE' | 'ALL';
+			ignoreDuration?: number;
+		};
+	}
+	interface NotificationUserMultiDeviceInfo {
+		operation: 'setSilentModeForUser';
+		resource: string;
+		// user: string;
+		data: {
+			ignoreInterval: string;
+		};
+	}
+
+	type NotificationMultiDeviceInfo =
+		| NotificationConMultiDeviceInfo
+		| NotificationUserMultiDeviceInfo;
+
 	type MultiDeviceEvent =
 		| ThreadMultiDeviceInfo
 		| ConversationChangedInfo
 		| RoamingDeleteMultiDeviceInfo
-		| GroupMemberAttributesUpdateMultiDeviceInfo;
+		| GroupMemberAttributesUpdateMultiDeviceInfo
+		| NotificationMultiDeviceInfo;
 
 	interface ConnectionParameters {
 		/** The unique application key registered in console. */
@@ -1230,6 +1259,22 @@ export declare namespace EasemobChat {
 		| SilentModeDuration
 		| SilentModeInterval;
 
+	interface ConversationWithRemindType {
+		/** Conversation id. */
+		conversationId: string;
+		/** Conversation type. */
+		type: 'singleChat' | 'groupChat';
+		/** Silent mode type. */
+		remindType: SILENTMODETYPE;
+	}
+
+	interface GetSilentModeRemindTypeConversationsResult {
+		/** The cursor that specifies where to start to get data. */
+		cursor: string;
+		/** conversations with remind type. */
+		conversations: ConversationWithRemindType[];
+	}
+
 	interface GetReactionDetailResult {
 		/** The reaction to be added to the message. The length is limited to 128 characters. */
 		reaction: string;
@@ -1358,6 +1403,9 @@ export declare namespace EasemobChat {
 		 */
 		USER_NOT_FRIEND = 221,
 
+		/** get DNS failed */
+		SERVER_GET_DNSLIST_FAILED = 304,
+
 		/** The server is busy. */
 		SERVER_BUSY = 500,
 		/** The message content contains illegal or sensitive words. */
@@ -1642,10 +1690,12 @@ export declare namespace EasemobChat {
 			params: {
 				/** The chat room ID. */
 				chatRoomId: string;
-				success?: (res: AsyncResult<GetChatRoomDetailsResult>) => void;
+				success?: (
+					res: AsyncResult<Array<GetChatRoomDetailsResult>>
+				) => void;
 				error?: (error: ErrorEvent) => void;
 			}
-		): Promise<AsyncResult<GetChatRoomDetailsResult>>;
+		): Promise<AsyncResult<Array<GetChatRoomDetailsResult>>>;
 
 		/**
 		 * Modifies the specifications of the chat room.
@@ -5110,7 +5160,7 @@ export declare namespace EasemobChat {
 				/** The conversation ID. */
 				conversationId: string;
 				/** The conversation type. */
-				conversationType: 'groupChat' | 'chatRoom';
+				conversationType: ChatType;
 				/** The ID of the message to be pinned. */
 				messageId: string;
 			}
@@ -5131,7 +5181,7 @@ export declare namespace EasemobChat {
 				/** The conversation ID. */
 				conversationId: string;
 				/** The conversation type. */
-				conversationType: 'groupChat' | 'chatRoom';
+				conversationType: ChatType;
 				/** The ID of the message to be unpinned. */
 				messageId: string;
 			}
@@ -5153,7 +5203,7 @@ export declare namespace EasemobChat {
 				/** The conversation ID. */
 				conversationId: string;
 				/** The conversation type. */
-				conversationType: 'groupChat' | 'chatRoom';
+				conversationType: ChatType;
 				/** The number of pinned messages to retrieve on each page. The value range is [1,50] and the default value is `10`. */
 				pageSize?: number;
 				/** The position from which to start getting data. For the first call of the method, an empty string ('') is passed in and the SDK returns the list of pinned messages in the descending order of when they are pinned.  */
@@ -5608,6 +5658,8 @@ export declare namespace EasemobChat {
 		memberCount?: number;
 		/** The extension fields. */
 		ext?: string;
+		/** The reason for the event. */
+		reason?: string;
 	}
 
 	interface GetChatroomAttributesResult {
@@ -5655,6 +5707,7 @@ export declare namespace EasemobChat {
 		| 'onTokenExpired'
 		| 'onContactInvited'
 		| 'onConnected'
+		| 'onReconnecting'
 		| 'onDisconnected'
 		| 'onGroupChange'
 		| 'onChatroomChange'
@@ -5666,7 +5719,9 @@ export declare namespace EasemobChat {
 		| 'onMultiDeviceEvent'
 		| 'onGroupEvent'
 		| 'onChatroomEvent'
-		| 'onMessagePinEvent';
+		| 'onMessagePinEvent'
+		| 'onOfflineMessageSyncStart'
+		| 'onOfflineMessageSyncFinish';
 
 	interface GroupEvent {
 		/** The type of operation. <br/>
@@ -5732,12 +5787,16 @@ export declare namespace EasemobChat {
 		id: string;
 		/** Message sender. */
 		from: string;
+		/** The userId of a group event.  */
+		userId?: string;
 		/** The name of a group.  */
 		name?: string;
 		/** The modified group info. */
 		detail?: GroupModifyInfo;
 		/** The member count. */
 		memberCount?: number;
+		/** The reason for the event. */
+		reason?: string;
 	}
 
 	interface ChatroomEvent {
@@ -5796,11 +5855,13 @@ export declare namespace EasemobChat {
 		memberCount?: number;
 		/** The extension fields. */
 		ext?: string;
+		/** The reason for the event. */
+		reason?: string;
 	}
 
 	interface MessagePinEvent {
 		/** The conversation type. */
-		conversationType: 'groupChat' | 'chatRoom';
+		conversationType: ChatType;
 		/** The conversation ID. */
 		conversationId: string;
 		/** The ID of the message that is pinned or unpinned. */
@@ -5880,6 +5941,8 @@ export declare namespace EasemobChat {
 		onContactInvited?: (msg: ContactMsgBody) => void;
 		/** The callback for successful connection. */
 		onConnected?: () => void;
+		/** The callback for reconnecting. */
+		onReconnecting?: () => void;
 		/** The callback for disconnected. */
 		onDisconnected?: (error?: ErrorEvent) => void;
 		/** @deprecated  Use { onGroupEvent } instead. */
@@ -5902,6 +5965,10 @@ export declare namespace EasemobChat {
 		onChatroomEvent?: (eventData: ChatroomEvent) => void;
 		/** The callback to receive a pin message event. */
 		onMessagePinEvent?: (eventData: MessagePinEvent) => void;
+		/** Occurs when the SDK starts pulling offline messages from the server. */
+		onOfflineMessageSyncStart?: () => void;
+		/** Occurs when the SDK finishes pulling offline messages from the server.*/
+		onOfflineMessageSyncFinish?: () => void;
 	}
 
 	interface HandlerData {
@@ -6149,6 +6216,7 @@ export declare namespace EasemobChat {
 		reason?: string;
 		kicked?: string;
 		detail?: GroupModifyInfo;
+		ext?: string;
 	}
 
 	interface ReadMsgSetParameters {
@@ -7633,6 +7701,9 @@ export declare namespace EasemobChat {
 		static createOldMsg(options: NewMessageParamters): MessageBody;
 		/** Create messages. */
 		static create(options: CreateMsgType): MessageBody;
+		/** When sending attachment messages, use this method to obtain the file path. */
+		static getFileUrl: (fileInputId: string | HTMLInputElement) => FileObj;
+
 		/** @deprecated */
 		set(options: MessageSetParameters): void;
 	}