easemob-websdk 4.3.1 → 4.4.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changes to easemob chat
 
+# 4.4.0 (Dec 22, 2023)
+
+-   Adds conversation Conversation Mark
+    - addConversationMark
+    - removeConversationMark
+    - getServerConversationsByFilter
+-   Adds Attach Slice Upload
+-   Adds `onMessage` Event
+-   Adds thumbnail to video message
+
 # 4.3.1 (Dec 13, 2023)
 
 -   Adds use replaced message contents

package/Easemob-chat.d.ts

@@ -195,11 +195,15 @@ export declare namespace EasemobChat {
 		operation:
 			| 'pinnedConversation'
 			| 'unpinnedConversation'
-			| 'deleteConversation';
+			| 'deleteConversation'
+			| 'markConversation'
+			| 'unMarkConversation';
 		/** The conversation ID. */
 		conversationId: string;
 		/** The conversation type. */
 		conversationType: 'singleChat' | 'groupChat';
+		/** The conversation mark. */
+		conversationMark?: MarkType;
 		/** The UNIX timestamp of the current operation. The unit is millisecond.*/
 		timestamp: number;
 	}
@@ -831,6 +835,8 @@ export declare namespace EasemobChat {
 		lastMessage: MessageBody | Record<string, never> | null;
 		/** The number of unread messages. */
 		unReadCount: number;
+		/** The conversation marks. */
+		marks?: Array<MarkType>;
 	}
 	interface PinConversation {
 		/** Whether the conversation is pinned. `true`: pinned; `false`: unpinned.*/
@@ -851,6 +857,30 @@ export declare namespace EasemobChat {
 		contacts: ContactItem[];
 	}
 
+	/** The conversation mark types. The mapping between each type of conversation mark and their actual meanings is maintained by the developer. */
+	enum MarkType {
+		mark_0,
+		mark_1,
+		mark_2,
+		mark_3,
+		mark_4,
+		mark_5,
+		mark_6,
+		mark_7,
+		mark_8,
+		mark_9,
+		mark_10,
+		mark_11,
+		mark_12,
+		mark_13,
+		mark_14,
+		mark_15,
+		mark_16,
+		mark_17,
+		mark_18,
+		mark_19,
+	}
+
 	interface OperateResult {
 		/** The userIds of the operation successfully. */
 		userIds: UserId[];
@@ -2367,7 +2397,7 @@ export declare namespace EasemobChat {
 				/** The chat room ID. */
 				chatRoomId: string;
 			}
-		): Promise<boolean>;
+		): Promise<AsyncResult<boolean>>;
 
 		/**
 		 * Gets the announcement of the chat room.
@@ -3710,7 +3740,7 @@ export declare namespace EasemobChat {
 				/** The group ID. */
 				groupId: string;
 			}
-		): Promise<boolean>;
+		): Promise<AsyncResult<boolean>>;
 
 		/**
 		 * Checks which members have read group message. This is a [value-added function] and .
@@ -4929,6 +4959,76 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<CursorContactsResult>>;
 
+		/**
+		 * Marks conversations.
+		 *
+		 * ```typescript
+		 * connection.addConversationMark({
+		 * 		conversations: [{conversationId: 'conversationId', conversationType: 'singleChat'}],
+		 *    mark: 0,
+		 * })
+		 * ```
+		 */
+		addConversationMark(
+			this: Connection,
+			params: {
+				/** The list of conversations. */
+				conversations: Array<
+					Pick<
+						ConversationItem,
+						'conversationId' | 'conversationType'
+					>
+				>;
+				/** The mark to add for the conversations. */
+				mark: MarkType;
+			}
+		): Promise<void>;
+
+		/**
+		 * Unmarks conversations.
+		 *
+		 * ```typescript
+		 * connection.removeConversationMark({
+		 * 		conversations: [{conversationId: 'conversationId', conversationType: 'singleChat'}],
+		 *    mark: 0,
+		 * })
+		 * ```
+		 */
+		removeConversationMark(
+			this: Connection,
+			params: {
+				/** The list of conversations. */
+				conversations: Array<
+					Pick<
+						ConversationItem,
+						'conversationId' | 'conversationType'
+					>
+				>;
+				/** The conversation mark to remove. */
+				mark: MarkType;
+			}
+		): Promise<void>;
+
+		/**
+		 * Get the list of filter conversations from the server with pagination.
+		 *
+		 * ```typescript
+		 * connection.getServerConversationsByFilter({pageSize:10, cursor: '',filter: {mark: 0})
+		 * ```
+		 */
+		getServerConversationsByFilter(
+			this: Connection,
+			params: {
+				/** The number of conversations that you expect to get on each page. The value range is [1,10] and the default value is `10`. */
+				pageSize?: number;
+				/** The position from which to start getting data. */
+				cursor?: string;
+				filter: {
+					mark: MarkType;
+				};
+			}
+		): Promise<AsyncResult<ServerConversations>>;
+
 		/**
 		 * Set the DND Settings for the current login user.
 		 *
@@ -5376,6 +5476,7 @@ export declare namespace EasemobChat {
 	type Event =
 		| 'onOpened'
 		| 'onPresence'
+		| 'onMessage'
 		| 'onTextMessage'
 		| 'onImageMessage'
 		| 'onAudioMessage'
@@ -5542,6 +5643,13 @@ export declare namespace EasemobChat {
 		onOpened?: (msg: any) => void;
 		/** @deprecated */
 		onPresence?: (msg: OnPresenceMsg) => void;
+		/** Occurs when a message is received. This callback is triggered to notify the user when a message such as texts or an image, video, voice, location, or file is received. */
+		onMessage?: (
+			msg: Exclude<
+				MessageBody,
+				ReadMsgBody | DeliveryMsgBody | ChannelMsgBody | CmdMsgBody
+			>[]
+		) => void;
 		/** The callback to receive a text message. */
 		onTextMessage?: (msg: TextMsgBody) => void;
 		/** The callback to receive a image message. */
@@ -7112,6 +7220,10 @@ export declare namespace EasemobChat {
 		url?: string;
 		/** Secret required to download the video file. */
 		secret?: string;
+		/** The thumbnail URL. */
+		thumb?: string;
+		/** The key required to download the thumbnail. */
+		thumb_secret?: string;
 		/** The file type. */
 		filetype?: string;
 		/** AccessToken needed to download files */