TIMSubscribeUserStatus
功能介绍
订阅用户状态
当成功订阅用户状态后,当对方的状态(包含在线状态、自定义状态)发生变更后,您可以监听 TIMSetUserStatusChangedCallback 回调来感知
如果您需要订阅好友列表的状态,您只需要在控制台上打开开关即可,无需调用该接口
该接口不支持订阅自己,您可以通过监听 TIMSetUserStatusChangedCallback 回调来感知自身的自定义状态的变更
订阅列表有个数限制,超过限制后,会自动淘汰最先订阅的用户
返回模板
Promise<commonResult<string>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: string | undefined;
json_params?: string | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | TIMResult | TIMErrCode | 返回状态码 |
desc | string | undefined | 返回描述 |
json_param | string | undefined | 根据具具体接口返回 |
json_params | string | undefined | 兼容的字段,某些情况下会返回这个,根据具体接口返回 |
user_data | string | undefined | ImSDK负责透传的用户自定义数据,未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import {userStatusParam} from "im_electron_sdk/dist/interfaces"
let userID = ''
let param:userStatusParam = {
id_array:[userID],
user_data:""
}
let {code} = timRenderInstance.TIMSubscribeUserStatus(param)
if(code == 0){
//调用成功
}