chat.getFriendList();
Promise
let promise = chat.getFriendList();promise.then(function(imResponse) {const friendList = imResponse.data; // 好友列表}).catch(function(imError) {console.warn('getFriendList error:', imError); // 获取好友列表失败的相关信息});
chat.addFriend(options);
Name | Type | Description |
to | String | 用户 ID |
source | String | 好友来源。加好友来源字段包含前缀和关键字两部分; 加好友来源字段的前缀是:AddSource_Type_ ; 关键字:必须是英文字母,且长度不得超过 8 字节,建议用一个英文单词或该英文单词的缩写。 示例:加好友来源的关键字是 Android,则加好友来源字段是:AddSource_Type_Android |
wording | String | undefined | 加好友附言,长度最长不得超过 256 个字节 |
type | String | undefined | 加好友方式(默认双向加好友方式): TencentCloudChat.TYPES.SNS_ADD_TYPE_SINGLE 单向加好友(单向好友:用户 A 的好友表中有用户 B,但 B 的好友表中却没有 A)TencentCloudChat.TYPES.SNS_ADD_TYPE_BOTH 双向加好友(双向好友:用户 A 的好友表中有用户 B,B 的好友表中也有 A) |
remark | String | undefined | 好友备注,备注长度最长不得超过 96 个字节 |
groupName | String | undefined | 分组名,分组名长度不得超过 30 个字节 |
Promise
// 添加好友let promise = tim.addFriend({to: 'user1',source: 'AddSource_Type_Web',remark: '小橙子',groupName: '好友',wording: '我是 user0',type: TencentCloudChat.TYPES.SNS_ADD_TYPE_BOTH,});promise.then(function(imResponse) {// 添加好友的请求发送成功const { code } = imResponse.data;if (code === 30539) {// 30539 说明 user1 设置了【需要经过自己确认对方才能添加自己为好友】// 此时 SDK 会触发 TencentCloudChat.EVENT.FRIEND_APPLICATION_LIST_UPDATED 事件} else if (code === 0) {// 0 说明 user1 设置了【允许任何人添加自己为好友】// 此时 SDK 会触发 TencentCloudChat.EVENT.FRIEND_LIST_UPDATED 事件}}).catch(function(imError) {console.warn('addFriend error:', imError); // 添加好友失败的相关信息});
chat.deleteFriend(options);
Name | Type | Description |
userIDList | Array | 待删除的好友的 userID 列表,单次请求的 userID 数不得超过100 |
type | String | undefined | 删除模式(默认双向删除好友): TencentCloudChat.TYPES.SNS_DELETE_TYPE_SINGLE 单向删除(只将 B 从 A 的好友表中删除,但不会将 A 从 B 的好友表中删除)TencentCloudChat.TYPES.SNS_DELETE_TYPE_BOTH 双向删除(将 B 从 A 的好友表中删除,同时将 A 从 B 的好友表中删除) |
Promise
let promise = chat.deleteFriend({userIDList: ['user1','user2'],type: TencentCloudChat.TYPES.SNS_DELETE_TYPE_BOTH});promise.then(function(imResponse) {const { successUserIDList, failureUserIDList } = imResponse.data;// 删除成功的 userIDListsuccessUserIDList.forEach((item) => {const { userID } = item;});// 删除失败的 userIDListfailureUserIDList.forEach((item) => {const { userID, code, message } = item;});// 如果好友列表有变化,则 SDK 会触发 TencentCloudChat.EVENT.FRIEND_LIST_UPDATED 事件}).catch(function(imError) {console.warn('removeFromFriendList error:', imError);});
chat.checkFriend(options);
Name | Type | Description |
userIDList | Array | 要校验的 userID 列表,单次请求的 userID 数不得超过1000 |
type | String | undefined | 校验模式(默认双向校验好友关系): TencentCloudChat.TYPES.SNS_CHECK_TYPE_SINGLE 单向校验好友关系(只会检查 A 的好友表中是否有 B,不会检查 B 的好友表中是否有 A)TencentCloudChat.TYPES.SNS_CHECK_TYPE_BOTH 双向校验好友关系(既会检查 A 的好友表中是否有 B,也会检查 B 的好友表中是否有 A) |
Promise
let promise = chat.checkFriend({userIDList: ['user0','user1'],type: TencentCloudChat.TYPES.SNS_CHECK_TYPE_BOTH,});promise.then(function(imResponse) {const { successUserIDList, failureUserIDList } = imResponse.data;// 校验成功的 userIDListsuccessUserIDList.forEach((item) => {const { userID, code, relation } = item; // 此时 code 始终为0// 单向校验好友关系时可能的结果有:// - relation: TencentCloudChat.TYPES.SNS_TYPE_NO_RELATION A 的好友表中没有 B,// 但无法确定 B 的好友表中是否有 A// - relation: TencentCloudChat.TYPES.SNS_TYPE_A_WITH_B A 的好友表中有 B,但无法确定 B 的好友表中是否有 A// 双向校验好友关系时可能的结果有:// - relation: TencentCloudChat.TYPES.SNS_TYPE_NO_RELATION A 的好友表中没有 B,B 的好友表中也没有 A// - relation: TencentCloudChat.TYPES.SNS_TYPE_A_WITH_B A 的好友表中有 B,但 B 的好友表中没有 A// - relation: TencentCloudChat.TYPES.SNS_TYPE_B_WITH_A A 的好友表中没有 B,但 B 的好友表中有 A// - relation: TencentCloudChat.TYPES.SNS_TYPE_BOTH_WAY A 的好友表中有 B,B 的好友表中也有 A});// 校验失败的 userIDListfailureUserIDList.forEach((item) => {const { userID, code, message } = item;});}).catch(function(imError) {console.warn('checkFriend error:', imError);});
本页内容是否解决了您的问题?