TencentCloudChat.TYPES.GRP_AVCHATROOM
(AVChatRoom) does not support this operation, error code 2687.chat.getGroupMemberProfile(options);
options
parameter is of the Object
type. It contains the following attribute values:Name | Type | Description |
groupID | String | Group ID |
userIDList | Array | List of IDs of the group members to be queried |
memberCustomFieldFilter | Array | undefined | Filtering the custom group member field. This attribute is optional. If it is not specified, all the custom group member fields are queried by default. |
Promise
let promise = chat.getGroupMemberProfile({groupID: 'group1',// Even if you retrieve the profile of only one group member, the value must be of array type// for example, userIDList: ['user1'].userIDList: ['user1', 'user2'],memberCustomFieldFilter: ['group_member_custom'],});promise.then(function(imResponse) {console.log(imResponse.data.memberList); // Group member list}).catch(function(imError){console.warn('getGroupMemberProfile error:', imError);});
TencentCloudChat.TYPES.GRP_AVCHATROOM
(AVChatRoom) does not support this operation, error code 2687.chat.setGroupMemberNameCard(options);
options
parameter is of the Object
type. It contains the following attribute values:Name | Type | Description |
groupID | String | Group ID or topic ID |
userID | String | undefined | It is optional. By default, the user's own name card is modified. |
nameCard | String | Name card of a group member |
Promise
let promise = chat.setGroupMemberNameCard({groupID: 'group1',userID: 'user1',nameCard: 'Name card'});promise.then(function(imResponse) {console.log(imResponse.data.group); // New group profileconsole.log(imResponse.data.member); // New group member profile}).catch(function(imError){console.warn('setGroupMemberNameCard error:', imError);});
TencentCloudChat.TYPES.GRP_AVCHATROOM
(AVChatRoom) does not support this operation, error code 2687.chat.setGroupMemberCustomField(options);
options
parameter is of the Object
type. It contains the following attribute values:Name | Type | Description |
groupID | String | Group ID or topic ID |
userID | String | undefined | Optional. If it is not specified, the user's own custom group member field is modified. |
memberCustomField | Array | Custom group member field. Its array elements are as structured below: key --- String --- Key of the custom fieldvalue --- String --- Value of the custom field |
Promise
let promise = chat.setGroupMemberCustomField({groupID: 'group1',memberCustomField: [{key: 'group_member_test', value: 'test'}]});promise.then(function(imResponse) {console.log(imResponse.data.group); // New group profileconsole.log(imResponse.data.member); // New group member profile}).catch(function(imError){console.warn('setGroupMemberCustomField error:', imError);});
chat.markGroupMemberList(options);
options
parameter is of the Object
type. It contains the following attribute values:Name | Type | Description |
groupID | String | Group ID or topic ID |
userIDList | Array.<String> | List of group member userIDs, with a maximum of 500 group members per request. |
markType | Number | Mark type. Greater than or equal to 1000, you can customize it. A maximum of 10 marks are allowed to be defined in an AVChatRoom. |
Promise
let promise = chat.markGroupMemberList({groupID: 'group1',userIDList: ['user1', 'user2'],markType: 1000,enableMark: true,});promise.then(function(imResponse) {const { successUserIDList, failureUserIDList } = imResponse.data;}).catch(function(imError) {console.warn('markGroupMemberList error:', imError);});
// Get the list of online members with a specified mark in the AVChatRoomlet promise = chat.getGroupMemberList({ groupID: 'group1', filter: 1000, offset: 0 });promise.then(function(imResponse) {console.log(imResponse.data.memberList); // Group member list}).catch(function(imError) {console.warn('getGroupMemberList error:', imError);});
Was this page helpful?