easemob-websdk 4.1.4-beta2 → 4.1.5-beta

package/CHANGELOG.md

@@ -1,4 +1,9 @@
 # Changes to easemob chat
+## 4.1.5 (April 13, 2023)
+
+- Adds four parameters, `from`, `msgTypes`, `startTime`, and `endTime` in `searchOptions` in the `getHistoryMessage` 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

package/Easemob-chat.d.ts

@@ -162,7 +162,7 @@ export declare namespace EasemobChat {
 		id: GroupId;
 		/** The name of the multi-device event. */
 		operation: 'memberAttributesUpdate';
-		/** The user ID of the group member whose custom attributes are set.  */
+		/** The user ID of the group member whose custom attributes are set.   */
 		userId: UserId;
 	}
 
@@ -781,7 +781,6 @@ export declare namespace EasemobChat {
 			score: number;
 		};
 	}
-
 	interface SubscribePresence {
 		/** The expiration time of the presence subscription. */
 		expiry: number;
@@ -990,6 +989,7 @@ export declare namespace EasemobChat {
 		/** The conversation list. */
 		channel_infos: ConversationList[];
 	}
+
 	interface SilentModeConversationType {
 		/** Silent mode type. */
 		type: string;
@@ -1205,6 +1205,10 @@ export declare namespace EasemobChat {
 		MESSAGE_MODERATION_BLOCKED = 508,
 		/** Group chat ID current limiting. */
 		MESSAGE_CURRENT_LIMITING = 509,
+		/** The network is disconnected, causing message sending failure. */
+		MESSAGE_WEBSOCKET_DISCONNECTED = 510,
+		/** You have exceeded the maximum allowed size of a message body.*/
+		MESSAGE_SIZE_LIMIT = 511,
 		/** The group is not found. */
 		GROUP_NOT_EXIST = 605,
 		/** The user being operated is not in the group. */
@@ -3105,7 +3109,7 @@ export declare namespace EasemobChat {
 			this: Connection,
 			params: {
 				/** The ID of the group member to mute. */
-				username: UserId;
+				username: UserId | UserId[];
 				/** The mute duration in milliseconds. The value `-1` indicates that the member is muted permanently.*/
 				muteDuration: number;
 				/** The group ID. */
@@ -3126,7 +3130,7 @@ export declare namespace EasemobChat {
 			this: Connection,
 			params: {
 				/** The ID of the group member to mute. */
-				username: UserId;
+				username: UserId | UserId[];
 				/** The mute duration in milliseconds. The value `-1` indicates that the member is muted permanently.*/
 				muteDuration: number;
 				/** The group ID. */
@@ -3143,7 +3147,7 @@ export declare namespace EasemobChat {
 				/** The group ID. */
 				groupId: string;
 				/** The group member ID to unmute. */
-				username: UserId;
+				username: UserId | UserId[];
 				success?: (res: AsyncResult<UnmuteGroupMemberResult[]>) => void;
 				error?: (error: ErrorEvent) => void;
 			}
@@ -3162,7 +3166,7 @@ export declare namespace EasemobChat {
 				/** The group ID. */
 				groupId: string;
 				/** The group member ID to unmute. */
-				username: UserId;
+				username: UserId | UserId[];
 				success?: (res: AsyncResult<UnmuteGroupMemberResult[]>) => void;
 				error?: (error: ErrorEvent) => void;
 			}
@@ -4095,7 +4099,7 @@ export declare namespace EasemobChat {
 		 * Gets the message history.
 		 *
 		 * ```typescript
-		 * connection.getHistoryMessages({targetId:'user1',chatType:'groupChat', pageSize: 20})
+		 * connection.getHistoryMessages({targetId:'targetId',chatType:'groupChat', pageSize: 20})
 		 * ```
 		 */
 		getHistoryMessages(
@@ -4110,16 +4114,28 @@ export declare namespace EasemobChat {
 				/** The chat type:
 				 * - `singleChat`: one-to-one chat;
 				 * - `groupChat`: group chat;
-				 * - `chatRoom`: chat room.
 				 * - (Default)`singleChat`: No.
 				 */
-				chatType?: 'singleChat' | 'groupChat' | 'chatRoom';
+				chatType?: 'singleChat' | 'groupChat';
 				/** Whether to select pull history messages in positive order(Pull message from the oldest to the latest).
 				 * - `up`: means searching from the newer messages to the older messages.
 				 * - `down`: means searching from the older messages to the newer messages.
 				 * - (Default)`up`.
 				 */
-				searchDirection?: string;
+				searchDirection?: 'down' | 'up';
+				/** Query conditions. */
+				searchOptions?: {
+					/** The user ID of the message sender. This parameter is used only for group chat. */
+					from?: UserId;
+					/** An array of message types for query. If no value is passed in, all message types will be queried. */
+					msgTypes?: Array<
+						Exclude<MessageType, 'read' | 'delivery' | 'channel'>
+					>;
+					/** The start timestamp for query. The unit is millisecond. */
+					startTime?: number;
+					/** The end timestamp for query. The unit is millisecond. */
+					endTime?: number;
+				};
 				success?: (res: MessageBody[]) => void;
 				fail?: (error: ErrorEvent) => void;
 			}
@@ -4946,7 +4962,7 @@ export declare namespace EasemobChat {
 				 * (Default)`true`: Yes.
 				 * `false`: No. */
 				autoDelete?: boolean;
-				/** Whether to allow a member to overwrite custom chat room attributes set by others.
+				/** Whether to allow a member to overwrite the chat room attribute set by another member.
 				 * `true`: Yes.
 				 * （Default）`false`: No. */
 				isForced?: boolean;
@@ -5002,9 +5018,9 @@ export declare namespace EasemobChat {
 			params: {
 				/** The chat room ID. */
 				chatRoomId: string;
-				/** The maximum number of keys to delete is 10. */
+				/** The array of keys of attributes to remove. The array can contain a maximum number of 10 attribute keys. */
 				attributeKeys: Array<string>;
-				/** Whether to allow chat room members to delete all of the chat room attributes.
+				/** Whether to allow chat room members to overwrite the chat room attributes set by others.
 				 * - `true`: Yes;
 				 * - (Default)`false`: No.
 				 */
@@ -5071,6 +5087,8 @@ export declare namespace EasemobChat {
 		from: string;
 		/** Additional data for the operation event. */
 		data?: any;
+		/** The modified group info. */
+		detail?: GroupModifyInfo;
 		/** ChatRoom attributes.  */
 		attributes?: {
 			[key: string]: string;
@@ -5592,6 +5610,13 @@ export declare namespace EasemobChat {
 		isChatThread?: boolean;
 		/** Message online state type. */
 		onlineState?: ONLINESTATETYPE;
+		/** 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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 	interface ReadParameters {
 		/** The message type. */
@@ -5615,6 +5640,13 @@ export declare namespace EasemobChat {
 		ackContent?: 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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface DeliveryParameters {
@@ -5648,6 +5680,13 @@ export declare namespace EasemobChat {
 		isChatThread?: boolean;
 		/** Message online state type. */
 		onlineState?: ONLINESTATETYPE;
+		/** 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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface CreateDeliveryMsgParameters {
@@ -5661,6 +5700,13 @@ export declare namespace EasemobChat {
 		from?: 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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface ChannelMsgSetParameters {
@@ -5675,6 +5721,7 @@ export declare namespace EasemobChat {
 	interface ChannelMsgBody extends ChannelMsgSetParameters {
 		/** The message ID. */
 		id: string;
+		mid?: string;
 		/** Whether it's group chat. */
 		group?: string;
 		/** The message type. */
@@ -5685,6 +5732,13 @@ export declare namespace EasemobChat {
 		isChatThread?: boolean;
 		/** Message online state type. */
 		onlineState?: ONLINESTATETYPE;
+		/** 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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface ChannelParameters {
@@ -5697,6 +5751,8 @@ export declare namespace EasemobChat {
 	interface CreateChannelMsgParameters {
 		/** The message type. */
 		type: 'channel';
+		/** The ID of the read message. */
+		id?: string;
 		/** The session type. */
 		chatType: ChatType;
 		/** The receipt. */
@@ -5705,6 +5761,13 @@ export declare namespace EasemobChat {
 		from?: 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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface TextParameters {
@@ -5776,6 +5839,11 @@ export declare namespace EasemobChat {
 		onlineState?: ONLINESTATETYPE;
 		/** 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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface CreateTextMsgParameters {
@@ -5797,6 +5865,11 @@ export declare namespace EasemobChat {
 		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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface CmdParameters {
@@ -5863,6 +5936,11 @@ export declare namespace EasemobChat {
 		onlineState?: ONLINESTATETYPE;
 		/** 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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface CreateCmdMsgParameters {
@@ -5886,6 +5964,11 @@ export declare namespace EasemobChat {
 		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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface CustomParameters {
@@ -5957,6 +6040,11 @@ export declare namespace EasemobChat {
 		onlineState?: ONLINESTATETYPE;
 		/** 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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface CreateCustomMsgParameters {
@@ -5980,6 +6068,11 @@ export declare namespace EasemobChat {
 		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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface LocationParameters {
@@ -6059,6 +6152,11 @@ export declare namespace EasemobChat {
 		onlineState?: ONLINESTATETYPE;
 		/** 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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface CreateLocationMsgParameters {
@@ -6086,6 +6184,11 @@ export declare namespace EasemobChat {
 		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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface FileParameters {
@@ -6118,6 +6221,8 @@ export declare namespace EasemobChat {
 		filename?: string;
 		/** The input ID of the file to be uploaded. */
 		fileInputId?: string;
+		/** The size of the  file. */
+		file_length?: number;
 		/** The recipient. */
 		to: string;
 		/** The sender, which can only be the current user and can not be changed.*/
@@ -6185,6 +6290,11 @@ export declare namespace EasemobChat {
 		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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface CreateFileMsgParameters {
@@ -6227,6 +6337,11 @@ export declare namespace EasemobChat {
 		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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface ImgParameters {
@@ -6247,6 +6362,8 @@ export declare namespace EasemobChat {
 		width?: number;
 		/** The image height. */
 		height?: number;
+		/** The image file length. */
+		file_length?: number;
 		/** The input ID of the file to be uploaded. */
 		fileInputId?: string;
 		/** The sender, which can only be the current user and can not be changed.*/
@@ -6307,6 +6424,11 @@ export declare namespace EasemobChat {
 		onlineState?: ONLINESTATETYPE;
 		/** 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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface CreateImgMsgParameters {
@@ -6322,6 +6444,8 @@ export declare namespace EasemobChat {
 		width?: number;
 		/** The image height. */
 		height?: number;
+		/** The image file length. */
+		file_length?: number;
 		/** The recipient. */
 		to: string;
 		/** The sender, which can only be the current user and can not be changed.*/
@@ -6349,6 +6473,11 @@ export declare namespace EasemobChat {
 		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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface AudioParameters {
@@ -6432,6 +6561,11 @@ export declare namespace EasemobChat {
 		onlineState?: ONLINESTATETYPE;
 		/** 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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface CreateAudioMsgParameters {
@@ -6476,6 +6610,11 @@ export declare namespace EasemobChat {
 		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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface VideoParameters {
@@ -6559,6 +6698,11 @@ export declare namespace EasemobChat {
 		onlineState?: ONLINESTATETYPE;
 		/** 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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface CreateVideoMsgParameters {
@@ -6605,6 +6749,11 @@ export declare namespace EasemobChat {
 		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 not delivered.
+		 *  - (Default) `false`: The message is delivered to the recipients regardless of whether they are online or offline.
+		 */
+		deliverOnlineOnly?: boolean;
 	}
 
 	interface ReceivedMsgBody {