easemob-websdk 4.1.4-beta → 4.1.4-beta2

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changes to easemob chat
+## 4.1.4 (Mar 16, 2023)
 
+-   Add Group Member Attributes feature
+-   Fix `getHistoryMessages` catch error failed
+-   Optimize the implementation of chat room join and leave to improve performance
+-   Add `deliverOnlineOnly` field in the message creation parameters
 ## 4.1.3 (Feb 20, 2023)
 
 -   `getConversationlist` Getting the conversation list supports paging

package/Easemob-chat.d.ts

@@ -23,6 +23,9 @@ export declare namespace EasemobChat {
 	/** The user ID.  */
 	type UserId = string;
 
+	/** The group ID.  */
+	type GroupId = string;
+
 	interface CommonRequestResult {
 		/** The result of request. */
 		result: boolean;
@@ -133,7 +136,7 @@ export declare namespace EasemobChat {
 		chatThreadId?: string;
 		/** The message thread name. */
 		chatThreadName?: string;
-		/** The group ID to which the message thread belongs.  */
+		/** The ID of the parent message in the message thread. */
 		parentId?: string;
 	}
 
@@ -148,9 +151,25 @@ export declare namespace EasemobChat {
 		resource: string;
 	}
 
+	interface GroupMemberAttributesUpdateMultiDeviceInfo {
+		/**
+		 * Custom attributes of a group member.
+		 */
+		attributes: MemberAttributes;
+		/** The user ID of the message sender. */
+		from: UserId;
+		/** The group ID. */
+		id: GroupId;
+		/** The name of the multi-device event. */
+		operation: 'memberAttributesUpdate';
+		/** The user ID of the group member whose custom attributes are set.  */
+		userId: UserId;
+	}
+
 	type MultiDeviceEvent =
 		| ThreadMultiDeviceInfo
-		| RoamingDeleteMultiDeviceInfo;
+		| RoamingDeleteMultiDeviceInfo
+		| GroupMemberAttributesUpdateMultiDeviceInfo;
 
 	interface ConnectionParameters {
 		/** The unique application key registered in console. */
@@ -582,6 +601,32 @@ export declare namespace EasemobChat {
 		created: number;
 	}
 
+	interface GroupInfo {
+		/** The number of existing members. */
+		affiliationsCount?: number;
+		/** The group name. */
+		groupName: string;
+		/** The group ID. */
+		groupId: string;
+		/** The current user role in the group. */
+		role?: 'member' | 'admin' | 'owner';
+		/** Whether the group disabled. */
+		disabled: boolean;
+		/** Whether a user requires the approval from the group owner or admin to join the group. -`true`: Yes; -`false`: No. */
+		approval: boolean;
+		/** Whether to allow group members to invite others to join the group. */
+		allowInvites: boolean;
+		/** The group description. */
+		description: string;
+		/** The maximum number of group members. */
+		maxUsers: number;
+		/** Whether it is a public group. */
+		public: boolean;
+	}
+	type MemberAttributes = Record<string, string>;
+
+	type GetGroupMembersAttributesResult = Record<UserId, MemberAttributes>;
+
 	interface GroupModifyInfo {
 		/** The name of a group.  */
 		name?: string;
@@ -1176,6 +1221,8 @@ export declare namespace EasemobChat {
 		GROUP_MEMBERS_LIMIT = 607,
 		/** Group disabled */
 		GROUP_IS_DISABLED = 608,
+		/** Failed to set the custom attributes of a group member. */
+		GROUP_MEMBER_ATTRIBUTES_SET_FAILED = 609,
 		/** Invalid token or App Key. */
 		REST_PARAMS_STATUS = 700,
 		/** The user being operated is not in the chatroom. */
@@ -2496,9 +2543,11 @@ export declare namespace EasemobChat {
 		 * Lists all the groups a user has joined.
 		 *
 		 * @note
-		 * If either `needAffiliations` or `needAffiliations` is set, when you get data with pagination, the current page number (pageNum) starts from 0 and you can get a maximum of 20 groups (pageSize) on each page.
+		 * If either `needAffiliations` or `needAffiliations` is set `true`, when you get data with pagination, the current page number (pageNum) starts from 0 and you can get a maximum of 20 groups (pageSize) on each page and
+		 * the function return type is `Promise<AsyncResult<GroupTypes.GroupInfo[]>`
 		 *
-		 * If neither of the parameters is set, when you get data with pagination, the current page number (pageNum) starts from 1 and you can get a maximum of 500 groups (pageSize) on each page.
+		 * If neither of the parameters is set, when you get data with pagination, the current page number (pageNum) starts from 1 and you can get a maximum of 500 groups (pageSize) on each page and and
+		 * the function return type is `Promise<AsyncResult<GroupTypes.BaseGroupInfo[]>`
 		 *
 		 * ```typescript
 		 * connection.getJoinedGroups({
@@ -2534,10 +2583,12 @@ export declare namespace EasemobChat {
 				 * （Default）`false`: No.
 				 */
 				needRole?: boolean;
-				success?: (res: AsyncResult<BaseGroupInfo[]>) => void;
+				success?: (
+					res: AsyncResult<BaseGroupInfo[] | GroupInfo[]>
+				) => void;
 				error?: (error: ErrorEvent) => void;
 			}
-		): Promise<AsyncResult<BaseGroupInfo[]>>;
+		): Promise<AsyncResult<BaseGroupInfo[] | GroupInfo[]>>;
 
 		/**  @deprecated */
 		changeOwner(
@@ -3712,6 +3763,62 @@ export declare namespace EasemobChat {
 			}
 		): void;
 
+		/**
+		 * Sets custom attributes of a group member.
+		 * After custom attributes of a group member are set, other members in the group receive the `operation: 'memberAttributesUpdate'`  in the `onGroupEvent` callback and the other devices of the group member receive the  the `operation: 'memberAttributesUpdate'`  in the `onMultiDeviceEvent` callback.
+		 *
+		 * ```typescript
+		 * connection.setGroupMemberAttributes({groupId: 'groupId', userId: 'userId', memberAttributes: {key: 'value'}})
+		 * ```
+		 */
+		setGroupMemberAttributes(
+			this: Connection,
+			params: {
+				/** The group ID. */
+				groupId: string;
+				/** The user ID of the group member. */
+				userId: string;
+				/**
+				 * The custom attributes to set in key-value format. In a key-value pair, if the value is set to an empty string, the custom attribute will be deleted.
+				 */
+				memberAttributes: MemberAttributes;
+			}
+		): Promise<void>;
+
+		/**
+		 * Gets all custom attributes of a group member.
+		 * ```typescript
+		 * connection.getGroupMemberAttributes({groupId: 'groupId', userId: 'userId'})
+		 * ```
+		 */
+		getGroupMemberAttributes(
+			this: Connection,
+			params: {
+				/** The group ID. */
+				groupId: string;
+				/** The user ID of the group member. */
+				userId: string;
+			}
+		): Promise<AsyncResult<MemberAttributes>>;
+
+		/**
+		 * Gets custom attributes of multiple group members by attribute key.
+		 * ```typescript
+		 * connection.getGroupMembersAttributes({groupId: 'groupId', userIds: ['userId'], keys: ['avatar', 'nickname']})
+		 * ```
+		 */
+		getGroupMembersAttributes(
+			this: Connection,
+			params: {
+				/** The group ID. */
+				groupId: string;
+				/** The array of user IDs of group members whose custom attributes are retrieved. */
+				userIds: UserId[];
+				/** The array of keys of custom attributes to be retrieved. If you pass in an empty array or do not set this parameter, the SDK gets all custom attributes of these group members. */
+				keys?: string[];
+			}
+		): Promise<AsyncResult<GetGroupMembersAttributesResult>>;
+
 		// Contact API
 		/**
 		 * @deprecated Use {@link getBlocklist} instead.
@@ -5032,6 +5139,7 @@ export declare namespace EasemobChat {
 		 * destroy:  Occurs when the group was destroyed.<br/>
 		 * requestToJoin: Occurs when someone applied to join the group. Only the group owner and administrator will receive this event. <br/>
 		 * acceptRequest: Occurs when your group adding application is approved. Only the person who applies for group will receive this event.<br/>
+		 * joinPublicGroupDeclined: Occurs when your group adding application is refused. Only the person who applies for group will receive this event.<br/>
 		 * inviteToJoin: Occurs when you receive an invitation to join a group. <br/>
 		 * acceptInvite: Occurs when someone accepted your invitation to join the group. <br/>
 		 * rejectInvite: Occurs when someone refused your invitation to join the group. <br/>
@@ -5054,12 +5162,14 @@ export declare namespace EasemobChat {
 		 * removeAllowlistMember: Occurs when being removed from the allow list.  <br/>
 		 * muteAllMembers: Occurs when the group was set with a ban for all members.  <br/>
 		 * unmuteAllMembers: Occurs when the group lifted the ban.  <br/>
+		 * memberAttributesUpdate: Occurs when a custom attributes of a group member is updated. <br/>
 		 */
 		operation:
 			| 'create'
 			| 'destroy'
 			| 'requestToJoin'
 			| 'acceptRequest'
+			| 'joinPublicGroupDeclined'
 			| 'inviteToJoin'
 			| 'acceptInvite'
 			| 'rejectInvite'
@@ -5081,7 +5191,8 @@ export declare namespace EasemobChat {
 			| 'addUserToAllowlist'
 			| 'removeAllowlistMember'
 			| 'muteAllMembers'
-			| 'unmuteAllMembers';
+			| 'unmuteAllMembers'
+			| 'memberAttributesUpdate';
 		/** The ID of a group. */
 		id: string;
 		/** Message sender. */