一、功能描述
·关注功能允许用户选择他们感兴趣的其它用户,从而在他们的动态、发布或活动中保持更新,系统可以根据用户的关注列表提供个性化的内容推荐。
·粉丝功能是指用户被其他人关注的状态,当用户 A 关注用户 B 时,A 就成为了 B 的粉丝。用户可以在自己的个人资料页面上查看粉丝数量、粉丝列表或者粉丝的资料信息等。
注意:说明:
注意:v3.2.6 起支持,该功能为旗舰版或企业版功能,需要你购买 旗舰版或企业版套餐。
二、关注用户
调用 followUser 接口可以关注用户。接口调用成功后:
·自己会收到 TencentCloudChat.EVENT.MY_FOLLOWING_LIST_UPDATED 事件通知。
·被关注的用户会收到 TencentCloudChat.EVENT.MY_FOLLOWERS_LIST_UPDATED 事件通知。
·如果关注的是自己的粉丝,自己和被关注用户都会收到 TencentCloudChat.EVENT.MUTUAL_FOLLOWERS_LIST_UPDATED 事件通知。
注意:说明:
接口
chat.followUser(userIDList);
参数
| 属性 | 含义 | 说明 |
| userIDList | 用户 userID 列表 | 需要关注的用户 userID 列表,一次最多支持关注 20 个用户。 |
返回值
Promise
示例
let promise = chat.followUser(['user1', 'user2']);promise.then(function(imResponse) { // 关注成功}).catch(function(imError) { // 关注失败 console.warn('followUser error:', imError);});
三、取消关注
调用 unfollowUser 接口可以取消关注。接口调用成功后:
·自己会收到 TencentCloudChat.EVENT.MY_FOLLOWING_LIST_UPDATED 事件通知。
·被取消关注的用户会收到 TencentCloudChat.EVENT.MY_FOLLOWERS_LIST_UPDATED 事件通知。
·如果取消关注的是自己粉丝,自己和被取消关注的用户都会收到 TencentCloudChat.EVENT.MUTUAL_FOLLOWERS_LIST_UPDATED 事件通知。
注意:说明:
注意:一次最多支持取消关注 20 个用户。
接口
chat.unfollowUser(userIDList);
参数
| 属性 | 含义 | 说明 |
| userIDList | 用户 userID 列表 | 需要取消关注的用户 userID 列表,一次最多支持取消关注 20 个用户。 |
返回值
Promise
示例
let promise = chat.unfollowUser(['user1', 'user2']);promise.then(function(imResponse) { console.log(imResponse.data); // 取消关注的结果信息}).catch(function(imError) { console.warn('unfollowUser error:', imError);});
四、获取我的粉丝列表
调用 getMyFollowersList 接口可以获取我的粉丝列表。
注意:说明:
注意:该接口每次最多返回 500 个用户。
接口
chat.getMyFollowersList(nextCursor);
参数
| 属性 | 含义 | 说明 |
| nextCursor | 分页拉取的起始位置 | 首页拉取默认为空,可不传,获取成功时 nextCursor 不为 '' 表示需要分页,可以传入该值再次拉取,直至 nextCursor 返回为 ''。 |
返回值
Promise
示例
let promise = chat.getMyFollowersList();promise.then(function(imResponse) { const { resultList, nextCursor = '' } = imResponse.data; // ressultList – 我的粉丝列表 // nextCursor – 分页续拉的标识 if (nextCursor != '') { // 需要续拉 }}).catch(function(imError) { console.warn('getMyFollowersList error:', imError);});
五、获取我的关注列表
调用 getMyFollowingList 接口可以获取我的关注列表。
注意:说明:
注意:该接口每次最多返回 500 个用户。
接口
chat.getMyFollowingList(nextCursor);
参数
| 属性 | 含义 | 说明 |
| nextCursor | 分页拉取的起始位置 | 首页拉取默认为空,可不传,获取成功时 nextCursor 不为 '' 表示需要分页,可以传入该值再次拉取,直至 nextCursor 返回为 ''。 |
返回值
Promise
示例
let promise = chat.getMyFollowingList();promise.then(function(imResponse) { const { resultList, nextCursor = '' } = imResponse.data; // ressultList – 我的关注列表 // nextCursor – 分页续拉的标识 if (nextCursor != '') { // 需要续拉 }}).catch(function(imError) { console.warn('getMyFollowingList error:', imError);});
六、获取互关列表
调用 getMutualFollowersList 接口可以获取互关列表。
注意:说明:
注意:该接口每次最多返回 500 个用户。
接口
chat.getMutualFollowersList(nextCursor);
参数
| 属性 | 含义 | 说明 |
| nextCursor | 分页拉取的起始位置 | 首页拉取默认为空,可不传,获取成功时 nextCursor 不为 '' 表示需要分页,可以传入该值再次拉取,直至 nextCursor 返回为 ''。 |
返回值
Promise
示例
let promise = chat.getMutualFollowersList();promise.then(function(imResponse) { const { resultList, nextCursor = '' } = imResponse.data; // ressultList – 互关列表 // nextCursor – 分页续拉的标识 if (nextCursor != '') { // 需要续拉 }}).catch(function(imError) { console.warn('getMutualFollowersList error:', imError);});
七、获取指定用户的关注/粉丝/互关数量信息
调用 getUserFollowInfo 接口可以获取指定用户的关注/粉丝/互关数量信息。
接口
chat.getUserFollowInfo(userIDList);
参数
| 属性 | 含义 | 说明 |
| userIDList | 指定的用户 userID 列表 | 用户 userID 列表,不传 userIDList 表示获取我自己的 关注/粉丝/互关 数量信息。 |
返回值
Promise
示例
获取自己的关注/粉丝/互关数量信息:
let promise = chat.getUserFollowInfo();promise.then(function(imResponse) { console.log(imResponse.data); // 获取成功}).catch(function(imError) { console.warn('getUserFollowInfo error:', imError);});
获取指定用户的关注/粉丝/互关数量信息:
let promise = chat.getUserFollowInfo(['user1', 'user2']);promise.then(function(imResponse) { console.log(imResponse.data); // 获取成功}).catch(function(imError) { console.warn('getUserFollowInfo error:', imError);});
八、检查指定用户的关注关系
调用 checkFollowType 接口可以检查与指定用户的关注关系。
注意:说明:
注意:业务侧调用该接口默认限制 5 秒 20 次请求,超频后 SDK 返回错误码 2996。
接口
chat.checkFollowType(userIDList);
参数
| 属性 | 含义 | 说明 |
| userIDList | 指定的用户 userID 列表 | 待校验用户 userID 列表,单次请求最多支持 100 个 userID。 |
返回值
Promise
示例
let promise = chat.checkFollowType(['user1', 'user2']);promise.then(function(imResponse) { console.log(imResponse.data); // 校验结果列表 imResponse.data.forEach((item) => { // item.userID – 用户 userID // item.followType – 关注关系(0 – 没有关系, 1 – 粉丝, 2 – 关注, 3 – 互关) });}).catch(function(imError) { console.warn('checkFollowType error:', imError);});
九、我的粉丝列表更新事件
当我的粉丝列表发生变更时,SDK 会派发 TencentCloudChat.EVENT.MY_FOLLOWERS_LIST_UPDATED 事件,你可以在注册的回调中获取到变更的粉丝信息。
示例
let onMyFollowersListUpdated = function(event) { console.log(event.data); const { userInfoList, isAdd } = event.data; userInfoList – 变更的用户信息列表, isAdd = false 时列表只返回 userID isAdd – true 表示增加的粉丝信息, false 表示减少的粉丝信息}chat.on(TencentCloudChat.EVENT.MY_FOLLOWERS_LIST_UPDATED, onMyFollowersListUpdated);
十、我的关注列表更新事件
当我的关注列表发生变更时,SDK 会派发 TencentCloudChat.EVENT.MY_FOLLOWING_LIST_UPDATED 事件,你可以在注册的回调中获取到变更的关注信息。
示例
let onMyFollowingListUpdated = function(event) { console.log(event.data); const { userInfoList, isAdd } = event.data; userInfoList – 变更的用户信息列表, isAdd = false 时列表只返回 userID isAdd – true 表示增加的关注信息, false 表示减少的关注信息}chat.on(TencentCloudChat.EVENT.MY_FOLLOWING_LIST_UPDATED, onMyFollowingListUpdated);
十一、互关列表更新事件
当互关列表发生变更时,SDK 会派发 TencentCloudChat.EVENT.MUTUAL_FOLLOWERS_LIST_UPDATED 事件,你可以在注册的回调中获取到变更的互关信息。
示例
let onMutualFollowersListUpdated = function(event) { console.log(event.data); const { userInfoList, isAdd } = event.data; userInfoList – 变更的用户信息列表, isAdd = false 时列表只返回 userID isAdd – true 表示增加的互关信息, false 表示减少的互关信息}chat.on(TencentCloudChat.EVENT.MUTUAL_FOLLOWERS_LIST_UPDATED, onMutualFollowersListUpdated);