easemob-websdk 4.0.4 → 4.0.5

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changes to easemob chat
 
+## ## 4.0.5 (May 15, 2022)
+
+- Add reporting API for content auditing
+- Add push setting API to support different push configuration
+- Add the data reporting function
+- The API for getting groups that you have joined supports paging
+- When creating a group, the SDK supports setting the number of group members
+- Add thumbnail address parameter to receive picture message
+- Fixed group chat message cache issues
+
 ## 4.0.4 (April 19, 2022)
 
 - Add presence feature

package/Easemob-chat.d.ts

@@ -730,6 +730,91 @@ export declare namespace EasemobChat {
 		expire: number;
 	}
 
+	interface SilentModeConversationType {
+		/** Silent mode type. */
+		type: string;
+		/** Silent mode duration, duration of Unix timestamp. */
+		ignoreDuration: number;
+		/** Silent mode interval. */
+		ignoreInterval: string;
+	}
+
+	interface ConversationSilentModeType {
+		/** User push map. */
+		user: {
+			[propname: UserId]: SilentModeConversationType;
+		};
+		/** Group push map. */
+		group: {
+			[propname: string]: SilentModeConversationType;
+		};
+	}
+
+	interface TranslationLanguageType {
+		/** Translation language. */
+		language: string;
+	}
+
+	enum SILENTMODETYPE {
+		/** All messsage. */
+		ALL = 'ALL',
+		/** @ messaage of myself. */
+		AT = 'AT',
+		/** None. */
+		NONE = 'NONE',
+	}
+
+	enum CONVERSATIONTYPE {
+		/** Single chat. */
+		SINGLECHAT = 'singleChat',
+		/** Group chat. */
+		GROUPCHAT = 'groupChat',
+		/** Chat room. */
+		CHATROOM = 'chatRoom',
+	}
+
+	type ConversationListType = {
+		/** Conversation id. */
+		id: string;
+		/** Conversation type. */
+		type: string;
+	};
+
+	interface SilentModeRemindType {
+		/** Silent mode type. */
+		paramType: 0;
+		/** Silent mode type. */
+		remindType: SILENTMODETYPE;
+	}
+
+	interface SilentModeDuration {
+		/** Silent mode type. */
+		paramType: 1;
+		/** Silent mode duration, duration of Unix timestamp. */
+		duration: number;
+	}
+
+	interface SilentModeInterval {
+		/** Silent mode type. */
+		paramType: 2;
+		/** Start time interval. */
+		startTime: Interval;
+		/** End time interval. */
+		endTime: Interval;
+	}
+
+	type Interval = {
+		/** Hours. */
+		hours: number;
+		/** Minutes. */
+		minutes: number;
+	};
+
+	type SilentModeParamType =
+		| SilentModeRemindType
+		| SilentModeDuration
+		| SilentModeInterval;
+
 	enum Code {
 		REQUEST_SUCCESS = 0,
 		REQUEST_TIMEOUT = -1,
@@ -1684,6 +1769,7 @@ export declare namespace EasemobChat {
 					approval: boolean;
 					allowinvites: boolean;
 					inviteNeedConfirm: boolean;
+					maxusers: number;
 				};
 				success?: (res: AsyncResult<CreateGroupResult>) => void;
 				error?: (error: ErrorEvent) => void;
@@ -1719,6 +1805,7 @@ export declare namespace EasemobChat {
 					approval: boolean;
 					allowinvites: boolean;
 					inviteNeedConfirm: boolean;
+					maxusers: number;
 				};
 				success?: (res: AsyncResult<CreateGroupResult>) => void;
 				error?: (error: ErrorEvent) => void;
@@ -1776,6 +1863,7 @@ export declare namespace EasemobChat {
 		 * connection.getGroup()
 		 * ```
 		 * @since 1.4.11
+		 * @deprecated
 		 */
 		getGroup(
 			this: Connection,
@@ -1785,6 +1873,23 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<BaseGroupInfo[]>>;
 
+		/**
+		 * Lists all the groups a user has joined.
+		 *
+		 * ```typescript
+		 * connection.getJoinedGroups()
+		 * ```
+		 */
+		getJoinedGroups(
+			this: Connection,
+			params: {
+				pageNum: number;
+				pageSize: number;
+				success?: (res: AsyncResult<BaseGroupInfo[]>) => void;
+				error?: (error: ErrorEvent) => void;
+			}
+		): Promise<AsyncResult<BaseGroupInfo[]>>;
+
 		/**  @deprecated */
 		changeOwner(
 			this: Connection,
@@ -3090,6 +3195,179 @@ export declare namespace EasemobChat {
 				error?: (error: ErrorEvent) => void;
 			}
 		): Promise<AsyncResult<SubscribePresenceResult>>;
+
+		/**
+		 * Reports a message.
+		 *
+		 * ```typescript
+		 * reportMessage({reportType: 'adult', reportReason: 'reason', messageId: 'id'})
+		 * ```
+		 */
+		reportMessage(
+			this: Connection,
+			params: {
+				reportType: string; // 举报类型。
+				reportReason: string; // 举报原因。
+				messageId: string;
+			}
+		): Promise<void>;
+
+		/**
+		 * Set the DND Settings for the current login user.
+		 *
+		 * ```typescript
+		 * connection.setSilentModeForAll({options: {paramType: 0, remindType: 'ALL'}})
+		 * ```
+		 */
+		setSilentModeForAll(
+			this: Connection,
+			params: {
+				/** Options object include paramType,remindType,duration,startTime,endTime. */
+				options: SilentModeParamType;
+				success?: (
+					res: AsyncResult<SilentModeConversationType>
+				) => void;
+				error?: (error: ErrorEvent) => void;
+			}
+		): Promise<AsyncResult<SilentModeConversationType>>;
+
+		/**
+		 * Get the DND Settings of the current user.
+		 *
+		 * ```typescript
+		 * connection.getSilentModeForAll()
+		 * ```
+		 */
+		getSilentModeForAll(
+			this: Connection,
+			params?: {
+				success?: (
+					res: AsyncResult<SilentModeConversationType>
+				) => void;
+				error?: (error: ErrorEvent) => void;
+			}
+		): Promise<AsyncResult<SilentModeConversationType>>;
+
+		/**
+		 * Set the DND of the session.
+		 *
+		 * ```typescript
+		 * connection.setSilentModeForConversation({conversationId: '100', type: 'singleChat', params: {paramType: 0, remindType: 'ALL'}})
+		 * ```
+		 */
+		setSilentModeForConversation(
+			this: Connection,
+			params: {
+				/** The Conversation id.
+				 * For one-to-one chat, conversation ID is to chat user's name.
+				 * For group chat, conversation ID is group ID, different with group name.
+				 * For chat room, conversation ID is chat room ID, different with chat room name.
+				 * For help desk, it is same with one-to-one chat, conversation ID is also chat user's name.
+				 */
+				conversationId: string;
+				/** Conversation type. */
+				type: CONVERSATIONTYPE;
+				/** Options object include paramType,remindType,duration,startTime,endTime. */
+				options: SilentModeParamType;
+				success?: (
+					res: AsyncResult<SilentModeConversationType>
+				) => void;
+				error?: (error: ErrorEvent) => void;
+			}
+		): Promise<AsyncResult<SilentModeConversationType>>;
+
+		/**
+		 * Clear the setting of offline push notification type for the session.
+		 *
+		 * ```typescript
+		 * connection.clearRemindTypeForConversation({conversationId: '123', type: 'singleChat'})
+		 * ```
+		 */
+		clearRemindTypeForConversation(
+			this: Connection,
+			params: {
+				/** Conversation id. */
+				conversationId: string;
+				/** Conversation type. */
+				type: CONVERSATIONTYPE;
+				success?: (
+					res: AsyncResult<SilentModeConversationType>
+				) => void;
+				error?: (error: ErrorEvent) => void;
+			}
+		): Promise<AsyncResult<SilentModeConversationType>>;
+
+		/**
+		 * Gets the DND setting of the session.
+		 *
+		 * ```typescript
+		 * connection.getSilentModeForConversation({conversationId: '3333', type: 'singleChat'})
+		 * ```
+		 */
+		getSilentModeForConversation(
+			this: Connection,
+			params: {
+				/** Conversation id. */
+				conversationId: string;
+				/** Conversation type. */
+				type: CONVERSATIONTYPE;
+				success?: (
+					res: AsyncResult<SilentModeConversationType>
+				) => void;
+				error?: (error: ErrorEvent) => void;
+			}
+		): Promise<AsyncResult<SilentModeConversationType>>;
+
+		/**
+		 * Obtain the DND Settings of specified sessions in batches.
+		 *
+		 * ```typescript
+		 * connection.getSilentModeForConversations({conversationList:[{id: 'test', type: 'singleChat'}, {id: '12345', type: 'groupChat'}]})
+		 * ```
+		 */
+		getSilentModeForConversations(
+			this: Connection,
+			params: {
+				/** Conversation list. */
+				conversationList: ConversationListType[];
+				success?: (
+					res: AsyncResult<ConversationSilentModeType>
+				) => void;
+				error?: (error: ErrorEvent) => void;
+			}
+		): Promise<AsyncResult<ConversationSilentModeType>>;
+
+		/**
+		 * Set user push translation language.
+		 *
+		 * ```typescript
+		 * connection.setPushPerformLanguage({language: 'EU'})
+		 * ```
+		 */
+		setPushPerformLanguage(
+			this: Connection,
+			params: {
+				/** translation language */
+				language: string;
+				success?: (res: AsyncResult<TranslationLanguageType>) => void;
+				error?: (error: ErrorEvent) => void;
+			}
+		): Promise<AsyncResult<TranslationLanguageType>>;
+
+		/**
+		 * Gets the push translation language set by the user.
+		 *
+		 * ```typescript
+		 * connection.getPushPerformLanguage()
+		 * ```
+		 */
+		getPushPerformLanguage(
+			this: Connection,
+			params?: {
+				success?: (res: AsyncResult<TranslationLanguageType>) => void;
+				error?: (error: ErrorEvent) => void;
+			}
+		): Promise<AsyncResult<TranslationLanguageType>>;
 	}
 
 	/**