easemob-websdk 4.1.4-beta2 → 4.1.4

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;
@@ -3105,7 +3105,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 +3126,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 +3143,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 +3162,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;
 			}
@@ -4946,7 +4946,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 +5002,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 +5071,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 +5594,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 +5624,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 +5664,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 +5684,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 +5705,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 +5716,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 +5735,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 +5745,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 +5823,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 +5849,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 +5920,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 +5948,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 +6024,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 +6052,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 +6136,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 +6168,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 +6205,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 +6274,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 +6321,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 +6346,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 +6408,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 +6428,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 +6457,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 +6545,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 +6594,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 +6682,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 +6733,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 {