SetKickedOfflineCallback
功能介绍
设置被踢下线通知回调
用户如果在其他终端登陆,会被踢下线,这时会收到用户被踢下线的通知,出现这种情况常规的做法是提示用户进行操作(退出,或者再次把对方踢下线)
用户如果在离线状态下被踢,下次登陆将会失败,可以给用户一个非常强的提醒(登陆错误码ERR_IMSDK_KICKED_BY_OTHERS:6208),开发者也可以选择忽略这次错误,再次登陆即可
用户在线情况下的互踢情况:
用户在设备1登陆,保持在线状态下,该用户又在设备2登陆,这时用户会在设备1上强制下线,收到 KickedOfflineCallback 回调
用户在设备1上收到回调后,提示用户,可继续调用login上线,强制设备2下线。这里是在线情况下互踢过程
用户离线状态互踢:
用户在设备1登陆,没有进行logout情况下进程退出。该用户在设备2登陆,此时由于用户不在线,无法感知此事件
为了显式提醒用户,避免无感知的互踢,用户在设备1重新登陆时,会返回(ERR_IMSDK_KICKED_BY_OTHERS:6208)错误码,表明之前被踢,是否需要把对方踢下线
如果需要,则再次调用login强制上线,设备2的登陆的实例将会收到 KickedOfflineCallback 回调
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
callback | KickedOfflineCallback | 是 | 回调 KickedOfflineCallback |
返回模板
TIMResult
调用成功后回调函数参数:
code:int
desc:string
json_param:'' // json_params为空字符串""
user_data:string
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
TIMResult | TIMResult | 调用接口的返回值 |
code | int | 值为ERR_SUCC表示成功,其他值表示失败。详情请参考 错误码 |
desc | string | 错误描述字符串 |
json_param | string | Json字符串,不同的接口,Json字符串不一样 |
user_data | string | ImSDK负责透传的用户自定义数据,未做任何处理 |