easemob-websdk 4.3.0-beta → 4.3.1-beta

package/CHANGELOG.md

@@ -1,12 +1,21 @@
 # Changes to easemob chat
 
+# 4.3.1 (Dec 13, 2023)
+
+-   Adds use replaced message contents
+-   Adds MiniCore SDK logger
+-   Verify that the `open` parameter user is not defined
+-   Types `SendMsgResult` add a message field
+-   Fixed the socket not closing when the network is offline on some device
+
 # 4.3.0 (Nov 13, 2023)
 
 -   Adds contact API
     - setContactRemark
-	- getAllContacts
-	- getContactsWithCursor
+    - getAllContacts
+    - getContactsWithCursor
 -   Adds chatRoom broadcast
+-   Adds token expiration callback
 
 # 4.2.1 (SEP 26, 2023)
 

package/Easemob-chat.d.ts

@@ -57,11 +57,18 @@ export declare namespace EasemobChat {
 		jid: Jid;
 	}
 
+	type ExcludeAckMessageBody = Exclude<
+		MessageBody,
+		ReadMsgBody | DeliveryMsgBody | ChannelMsgBody
+	>;
+
 	interface SendMsgResult {
 		/** The message local ID. */
 		localMsgId: string;
 		/** The ID of the message on the server. */
 		serverMsgId: string;
+		/** Message. */
+		message?: ExcludeAckMessageBody;
 	}
 
 	/** The modified message. */
@@ -214,6 +221,8 @@ export declare namespace EasemobChat {
 		deviceId?: string;
 		/** Whether to use your own upload function, for example, when uploading images and files to your server. - `true`: Use your own upload function; - (Default)`false`: Do not use your own upload function. */
 		useOwnUploadFun?: boolean;
+		/** When the moderation service replaces the content of a message, whether the adjusted message is returned to the sender. - `true`: Return the adjusted message to the sender. - `false`: Return the original message to the sender. */
+		useReplacedMessageContents?: boolean;
 		/** The maximum number of reconnection. */
 		autoReconnectNumMax?: number;
 		/** Whether DNS is enabled or not. It is enabled by default. The private cloud should be turned off */
@@ -790,13 +799,6 @@ export declare namespace EasemobChat {
 		result: 'ok';
 	}
 
-	interface SendMsgResult {
-		/** The local ID of the message. */
-		localMsgId: string;
-		/** The message ID on the server. */
-		serverMsgId: string;
-	}
-
 	interface HistoryMessages {
 		/** The starting message ID for the next query. If the number of messages returned by the SDK is smaller than the requested number, the cursor will be `undefined`. */
 		cursor?: string;
@@ -1210,6 +1212,15 @@ export declare namespace EasemobChat {
 		secret: string;
 	}
 
+	interface NewTokenResult {
+		/** Whether success. */
+		status: boolean;
+		/** The new token. */
+		token?: string;
+		/** The expire time. */
+		expire?: number;
+	}
+
 	/**
 	 * The error code defined by SDK.
 	 * @module Code
@@ -1486,6 +1497,8 @@ export declare namespace EasemobChat {
 		private reconnect(): void;
 		/** send message */
 		send(params: MessageBody): Promise<SendMsgResult>;
+		/** Updates token. */
+		renewToken(token: string): Promise<NewTokenResult>;
 
 		// ChatRoom API
 		/**
@@ -4324,7 +4337,7 @@ export declare namespace EasemobChat {
 				/** The user ID. You can type a specific user ID to add a single user to the blocklist or type an array of user IDs, like ["user1","user2"], to add multiple users. */
 				name: UserId | UserId[];
 			}
-		): Promise<OperateResult>;
+		): Promise<AsyncResult<OperateResult>>;
 
 		/**
 		 * @deprecated Use {@link addUsersToBlocklist} instead.
@@ -4335,7 +4348,7 @@ export declare namespace EasemobChat {
 				/** The user ID. You can type a specific user ID to add a single user to the blocklist or type an array of user IDs, like ["user1","user2"], to add multiple users. */
 				name: UserId | UserId[];
 			}
-		): Promise<void>;
+		): Promise<AsyncResult<OperateResult>>;
 
 		/**
 		 * Adds a contact to the blocklist.
@@ -4350,7 +4363,7 @@ export declare namespace EasemobChat {
 				/** The user ID. You can type a specific user ID to add a single user to the blocklist or type an array of user IDs, like ["user1","user2"], to add multiple users. */
 				name: UserId | UserId[];
 			}
-		): Promise<void>;
+		): Promise<AsyncResult<OperateResult>>;
 
 		/** @deprecated   Use {@link removeUserFromBlackList} instead. */
 		removeFromBlackList(
@@ -6092,6 +6105,8 @@ export declare namespace EasemobChat {
 		priority?: MessagePriority;
 		/** Whether global notify message or not. */
 		broadcast?: boolean;
+		/** Whether the message content is replaced. This property is valid only when `useReplacedMessageContent` is set to `true` during initialization. */
+		isContentReplaced?: boolean;
 		/** 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.
@@ -6157,6 +6172,8 @@ export declare namespace EasemobChat {
 		priority?: MessagePriority;
 		/** Whether global notify message or not. */
 		broadcast?: boolean;
+		/** Whether the message content is replaced. This property is valid only when `useReplacedMessageContent` is set to `true` during initialization. */
+		isContentReplaced?: boolean;
 		/** 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.
@@ -6303,6 +6320,8 @@ export declare namespace EasemobChat {
 		priority?: MessagePriority;
 		/** Whether global notify message or not. */
 		broadcast?: boolean;
+		/** Whether the message content is replaced. This property is valid only when `useReplacedMessageContent` is set to `true` during initialization. */
+		isContentReplaced?: boolean;
 		/** 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.
@@ -6413,6 +6432,8 @@ export declare namespace EasemobChat {
 		priority?: MessagePriority;
 		/** Whether global notify message or not. */
 		broadcast?: boolean;
+		/** Whether the message content is replaced. This property is valid only when `useReplacedMessageContent` is set to `true` during initialization. */
+		isContentReplaced?: boolean;
 		/** 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.
@@ -6531,6 +6552,8 @@ export declare namespace EasemobChat {
 		priority?: MessagePriority;
 		/** Whether global notify message or not. */
 		broadcast?: boolean;
+		/** Whether the message content is replaced. This property is valid only when `useReplacedMessageContent` is set to `true` during initialization. */
+		isContentReplaced?: boolean;
 		/** 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.
@@ -6675,6 +6698,8 @@ export declare namespace EasemobChat {
 		priority?: MessagePriority;
 		/** Whether global notify message or not. */
 		broadcast?: boolean;
+		/** Whether the message content is replaced. This property is valid only when `useReplacedMessageContent` is set to `true` during initialization. */
+		isContentReplaced?: boolean;
 		/** 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.
@@ -6813,6 +6838,8 @@ export declare namespace EasemobChat {
 		priority?: MessagePriority;
 		/** Whether global notify message or not. */
 		broadcast?: boolean;
+		/** Whether the message content is replaced. This property is valid only when `useReplacedMessageContent` is set to `true` during initialization. */
+		isContentReplaced?: boolean;
 		/** 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.
@@ -6964,6 +6991,8 @@ export declare namespace EasemobChat {
 		priority?: MessagePriority;
 		/** Whether global notify message or not. */
 		broadcast?: boolean;
+		/** Whether the message content is replaced. This property is valid only when `useReplacedMessageContent` is set to `true` during initialization. */
+		isContentReplaced?: boolean;
 		/** 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.
@@ -7107,6 +7136,8 @@ export declare namespace EasemobChat {
 		priority?: MessagePriority;
 		/** Whether global notify message or not. */
 		broadcast?: boolean;
+		/** Whether the message content is replaced. This property is valid only when `useReplacedMessageContent` is set to `true` during initialization. */
+		isContentReplaced?: boolean;
 		/** 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.