TIMLogout
功能介绍
登出
退出登录，如果切换账号，需要 logout 回调成功或者失败后才能再次 login，否则login可能会失败。
普通情况下，如果您的应用生命周期跟 IM SDK 生命周期一致，退出应用前可以不登出，直接退出即可。
App 启动后首次使用 IM SDK 的功能。
但有些特殊场景，例如您只在进入特定界面后才使用 IM SDK，退出界面后不再使用，此时可以调用logout 接口登出 SDK。登出成功后，不会再收到其他人发送的新消息。注意这种情况下，登出成功后还需要调 unInitSDK 对 SDK 进行反初始化。
如果您希望在应用中实现账号切换的需求，只需要每次切换账号时调用 login 即可。
例如已经登录了 alice，现在要切换到 bob，只需要直接 login bob 即可。login bob 前无需显式调用 logout alice，IM SDK 内部会自动处理。
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| param | logoutParam | 是 | 登出的参数 |
返回模板
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";
import { logoutParam } from "im_electron_sdk/dist/interfaces";
const timRenderInstance = new TimRender();
let param:logoutParam={
userData: "logout" // 选填
}
let {code} = await timRenderInstance.TIMLogout(param)
if (code == 0){
// logout 成功
}