easemob-websdk 4.12.1 → 4.14.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changes to easemob chat
 
+## 4.14.0 (Apr 18, 2025)
+
+### 新增特性
+
+-   支持 [GIF 图片消息]。
+-   支持 [群组头像功能]。
+-   支持 [附件鉴权功能]。该功能需要联系商务开通，开通后必须调用 SDK 的 API 才能下载消息附件。
+-   支持 [支持自定义设备平台]。
+-   unipush 推送安卓平台支持 Google FCM
+
+## 4.13.0 (Mar 12, 2025)
+
+### 新增特性
+
+1. `modifyMessage` 发送后修改消息接口新增可修改的消息类型：
+   支持修改的消息类型如下：
+    - 文本消息：支持修改 `msg` 和 `ext` 字段。
+    - 自定义消息：支持修改 `customEvent` 、 `customExts` 和 `ext` 字段。
+    - 图片/语音/视频/文件/位置/合并消息：仅支持修改 `ext` 字段。
+    - 命令消息：不支持修改。
+2. 小程序 SDK 支持运行到微信小游戏平台
+
+### 优化
+
+1. SDK 内部捕获重试 DNS 失败的错误
+
 ## 4.12.0 (Jan 9, 2025)
 
 ### 新增特性
@@ -9,15 +35,14 @@
 
 ### 修复
 
-1. 格式化小程序SDK API 请求失败错误码， 和Web端统一。
-2. 修复uniapp sdk 在4.36版本运行到鸿蒙平台，无限重连的问题。
+1. 格式化小程序 SDK API 请求失败错误码， 和 Web 端统一。
+2. 修复 uniapp sdk 在 4.36 版本运行到鸿蒙平台，无限重连的问题。
 3. 修复偶现无法拉取消息的问题。
 
 ### 优化
 
 1. 优化重连时间间隔
-2. 小程序SDK支持httpDNS, 默认开启
-
+2. 小程序 SDK 支持 httpDNS, 默认开启
 
 ## 4.11.0 (Nov 29, 2024)
 

package/Easemob-chat.d.ts

@@ -59,14 +59,14 @@ export declare namespace EasemobChat {
 	}
 
 	/** The modified message. */
-	type ModifiedMsg = TextMsgBody;
+	type ModifiedMsg = ExcludeAckMessageBody;
 
 	/** Messages supported by the `onModifiedMessage` event. */
-	type ModifiedEventMessage = TextMsgBody | CustomMsgBody;
+	type ModifiedEventMessage = ExcludeAckMessageBody;
 
 	interface ModifyMsgResult extends SendMsgResult {
-		/** The modified message. */
-		message: ModifiedMsg;
+		/** The modified info of the message. */
+		modifiedInfo: ModifiedMsgInfo;
 	}
 
 	interface ModifiedMsgInfo {
@@ -274,6 +274,10 @@ export declare namespace EasemobChat {
 		 * <br> This parameter has an impact on the kicking policy during a multi-device login scenario.
 		 */
 		isFixedDeviceId?: boolean;
+		/** Custom platform, optional values [1-100]. Please refer to the multi device login document for details. */
+		customOSPlatform?: number;
+		/** Customize device name.  The device name can only be set through this parameter after configuring customOSPlatform. */
+		customDeviceName?: string;
 	};
 
 	interface RegisterUserResult extends AsyncResult {
@@ -551,6 +555,8 @@ export declare namespace EasemobChat {
 		public: boolean;
 		/** Whether on the blacklist. */
 		shieldgroup: boolean;
+		/** The group avatar. */
+		avatar: string;
 	}
 
 	interface ModifyGroupResult {
@@ -564,6 +570,8 @@ export declare namespace EasemobChat {
 		membersonly?: boolean;
 		/** Whether the permission invitation is modified successfully. */
 		allowinvites?: boolean;
+		/** Whether the group avatar is changed successfully. -`true`: Yes; -`false`: No. */
+		avatar?: boolean;
 	}
 
 	type GroupMember = { owner: UserId } | { member: UserId };
@@ -739,7 +747,7 @@ export declare namespace EasemobChat {
 		name?: string;
 		/** The description of a group.  */
 		description?: string;
-		/** Whether it is a public group. -`true`: Yes; -`false`: No. Public group: the group that others can query by calling `listgroups`. */
+		/** Whether it is a public group. -`true`: Yes; -`false`: No. Public group: the group that others can query by calling `getPublicGroups`. */
 		public?: boolean;
 		/** Whether a user requires the approval from the group owner or admin to join the group. -`true`: Yes; -`false`: No. */
 		approval?: boolean;
@@ -756,6 +764,8 @@ export declare namespace EasemobChat {
 		ext?: string;
 		/** Last Modified Timestamp.  */
 		lastModified?: number;
+		/** The group avatar. */
+		avatar?: string;
 	}
 
 	// The group api result end.
@@ -1420,6 +1430,11 @@ export declare namespace EasemobChat {
 		 */
 		USER_NOT_FRIEND = 221,
 
+		/** No permission to download file. */
+		WEBIM_DOWNLOADFILE_ERROR_NO_PERMISSION = 222,
+		/** The file has expired. */
+		WEBIM_DOWNLOADFILE_ERROR_EXPIRED = 223,
+
 		/** get DNS failed */
 		SERVER_GET_DNSLIST_FAILED = 304,
 
@@ -1727,11 +1742,11 @@ export declare namespace EasemobChat {
 				/** The chat room ID. */
 				chatRoomId: string;
 				/** The chat room name. */
-				chatRoomName: string;
+				chatRoomName?: string;
 				/** The description of the chat room. */
-				description: string;
+				description?: string;
 				/** The maximum number of members in the chat room. */
-				maxusers: number;
+				maxusers?: number;
 				success?: (res: AsyncResult<ModifyChatRoomResult>) => void;
 				error?: (error: ErrorEvent) => void;
 			}
@@ -2641,11 +2656,13 @@ export declare namespace EasemobChat {
 				data: {
 					/** The group name. */
 					groupname: string;
+					/** The group avatar. */
+					avatar?: string;
 					/** The description of the group. */
 					desc: string;
 					/** The array of member IDs to add to the group. These users will be added directly into the group and receive "operation: 'directJoined'" in the callback of onGroupEvent. */
 					members: UserId[];
-					/** Whether it is a public group. -`true`: Yes; -`false`: No. Public group: the group that others can query by calling `listgroups`. */
+					/** Whether it is a public group. -`true`: Yes; -`false`: No. Public group: the group that others can query by calling `getPublicGroups`. */
 					public: boolean;
 					/** Whether a user requires the approval from the group admin to join the group. -`true`: Yes; -`false`: No.*/
 					approval: boolean;
@@ -2668,11 +2685,13 @@ export declare namespace EasemobChat {
 
 		/**
          * Creates group
+		 * @deprecated Use {@link createGroupVNext instead.}
          * 
          * ```typescript
          * connection.createGroup({
             data: {
                 groupname: 'groupname',
+				avatar: 'avatar',
                 desc: 'this is my group',
                 members: ['user1', 'user2'],
                 public: true,
@@ -2690,11 +2709,13 @@ export declare namespace EasemobChat {
 				data: {
 					/** The group name. */
 					groupname: string;
+					/** The group avatar. */
+					avatar?: string;
 					/** The description of the group. */
 					desc: string;
 					/** The array of member IDs to add to the group. These users will be added directly into the group and receive "operation: 'directJoined'" in the callback of onGroupEvent. */
 					members: UserId[];
-					/** Whether it is a public group. -`true`: Yes; -`false`: No. Public group: the group that others can query by calling `listgroups`. */
+					/** Whether it is a public group. -`true`: Yes; -`false`: No. Public group: the group that others can query by calling `getPublicGroups`. */
 					public: boolean;
 					/** Whether a user requires the approval from the group admin to join the group. -`true`: Yes; -`false`: No.*/
 					approval: boolean;
@@ -2715,6 +2736,54 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<CreateGroupResult>>;
 
+		/**
+		 * Creates a group instance.
+		 *
+		 * ```typescript
+		 * connection.createGroupVNext({
+		 *  groupName: 'groupname',
+		 * 	avatar: 'group avatar',
+		 *  description: 'this is my group',
+		 *  members: ['user1', 'user2'],
+		 *  isPublic: true,
+		 * 	needApprovalToJoin: false,
+		 * 	allowMemberToInvite: true,
+		 * 	inviteNeedConfirm: false,
+		 * 	maxMemberCount: 200,
+		 * 	extension: JSON.stringify({info: 'group info'})
+		 * })
+		 * ```
+		 */
+		createGroupVNext(
+			this: Connection,
+			params: {
+				/** The group name. */
+				groupName?: string;
+				/** The group avatar. */
+				avatar?: string;
+				/** The description of the group. */
+				description?: string;
+				/** The array of member IDs to add to the group. These users will be added directly into the group and receive "operation: 'directJoined'" in the callback of onGroupEvent. */
+				members?: UserId[];
+				/** Whether it is a public group. -`true`: Yes; -`false`: No. Public group: the group that others can query by calling `getPublicGroups`. */
+				isPublic?: boolean;
+				/** Whether a user requires the approval from the group admin to join the group. -`true`: Yes; -`false`: No.*/
+				needApprovalToJoin?: boolean;
+				/** Whether to allow group members to invite others to the group. `true`: Allow; `false`: Do not allow.*/
+				allowMemberToInvite?: boolean;
+				/**
+				 * Whether the invitee needs to accept the invitation before joining the group.
+				 * - `true`: The invitee's consent is required. The default value is `true`.
+				 * - `false`: The invitee will be directly added to the group without confirmation.
+				 */
+				inviteNeedConfirm?: boolean;
+				/** The group max users. */
+				maxMemberCount?: number;
+				/** Group detail extensions which can be in the JSON format to contain more group information. */
+				extension?: string;
+			}
+		): Promise<AsyncResult<{ groupId: string }>>;
+
 		/**  @deprecated Use {@link blockGroupMessages instead.} */
 		blockGroup(
 			this: Connection,
@@ -2912,6 +2981,8 @@ export declare namespace EasemobChat {
 				groupName?: string;
 				/** The group description. */
 				description?: string;
+				/** The group avatar. */
+				avatar?: string;
 				/** Group detail extensions which can be in the JSON format to contain more group information. */
 				ext?: string;
 				success?: (res: AsyncResult<ModifyGroupResult>) => void;
@@ -4588,11 +4659,15 @@ export declare namespace EasemobChat {
 		): Promise<SendMsgResult>;
 
 		/**
-		 * Modifies a message on the server.
+		 * Modifies a message in the server.
 		 *
-		 * This method can only modify a text message in one-to-one chats or group chats, but not in chat rooms.
+		 * - Text message: Both the message body `msg` and extension information `ext` can be modified.
+		 * - Custom message: The custom extension property field  `customExts`, custom event type field `customEvent` , and message extension field `ext`  can be modified.
+		 * - Image/video/voice/file/location/combined message: Only the message extension field `ext` can be modified.
+		 * - Command message: This type of message cannot be modified.
+		 *
+		 * The message recipient can listen for message changes via `onModifiedMessage`.  Also, this callback applies in multi-device scenarios.
 		 *
-		 * Upon a message modification, the callback `onModifiedMessage` will be received by the message recipient(s) and in multi-device login scenarios.
 		 *
 		 * ```typescript
 		 *
@@ -6612,6 +6687,8 @@ 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[];
 		/** The file URL. */
@@ -6764,6 +6841,8 @@ 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[];
 		/** Has the message been read (only single chat messages have this field). */
@@ -7006,6 +7085,8 @@ 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[];
 		/** Has the message been read (only single chat messages have this field). */
@@ -7156,6 +7237,8 @@ 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;
 		/** Has the message been read (only single chat messages have this field). */
 		isRead?: boolean;
 		/** Has the message been delivered (only single chat messages have this field). */
@@ -7306,6 +7389,8 @@ export declare namespace EasemobChat {
 		thumbnailWidth?: number;
 		/** The thumbnail height. */
 		thumbnailHeight?: number;
+		/** Message modified info. */
+		modifiedInfo?: ModifiedMsgInfo;
 		/** Has the message been read (only single chat messages have this field). */
 		isRead?: boolean;
 		/** Has the message been delivered (only single chat messages have this field). */
@@ -7365,6 +7450,8 @@ export declare namespace EasemobChat {
 		thumbnailWidth?: number;
 		/** The thumbnail height. */
 		thumbnailHeight?: number;
+		/** Whether the image is a gif. */
+		isGif?: boolean;
 	}
 
 	interface AudioParameters {
@@ -7457,6 +7544,8 @@ 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[];
 		/** Has the message been read (only single chat messages have this field). */
@@ -7610,6 +7699,8 @@ 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[];
 		/** Has the message been read (only single chat messages have this field). */