tencent cloud

文档反馈

最后更新时间:2022-09-08 17:43:11

    功能描述

    用户登录 IM SDK 才能正常收发消息,登录需要用户提供 UserID、UserSig 等信息,具体含义请参见 登录鉴权

    登录

    注意:

    • 登录成功,需等待 sdk 处于 ready 状态后(监听事件 TIM.EVENT.SDK_READY)才能调用 sendMessage 等需要鉴权的接口。
    • 如需支持多实例登录(允许在多个网页中同时登录同一帐号),请登录 即时通信 IM 控制台,找到相应 SDKAppID,选择应用配置>功能配置>登录与消息>登录设置>Web 端可同时在线个数配置实例个数。配置将在5分钟内生效。

    接口

    tim.login(options);

    参数

    参数 options 为 Object 类型,包含的属性值如下:

    名称 类型 描述
    userID String 用户 ID。
    userSig String 用户登录即时通信 IM 的密码,其本质是对 UserID 等信息加密后得到的密文。
    具体生成方法请参见 生成 UserSig

    返回值

    Promise 对象。

    示例

    let promise = tim.login({userID: 'your userID', userSig: 'your userSig'});
    promise.then(function(imResponse) {
    console.log(imResponse.data); // 登录成功
    if (imResponse.data.repeatLogin === true) {
    // 标识帐号已登录,本次登录操作为重复登录。v2.5.1 起支持
    console.log(imResponse.data.errorInfo);
    }
    }).catch(function(imError) {
    console.warn('login error:', imError); // 登录失败的相关信息
    });

    登出

    登出即时通信 IM,通常在切换帐号的时候调用,清除登录态以及内存中的所有数据。

    注意:

    • 调用此接口的实例会发布 SDK_NOT_READY 事件,此时该实例下线,无法收、发消息。
    • 如果您在即时通信 IM 控制台配置的“Web 端实例同时在线个数”大于 1,且同一帐号登录了a1a2两个实例,当执行a1.logout()后,a1会下线,无法收、发消息。而a2实例不会受影响。
    • 多实例被踢:基于第 2 点,如果“Web 端实例同时在线个数”配置为 2,且您的某一帐号已经登录了 a1a2两个实例,当使用此帐号成功登录第三个实例a3时,a1a2中的一个实例会被踢下线(通常是最先处在登录态的实例会触发),这种情况称之为“多实例被踢”。假设a1实例被踢下线,a1实例内部会执行登出流程,然后抛出KICKED_OUT事件,接入侧可以监听此事件,并在触发时跳转到登录页。此时a1实例下线,而a2a3实例可以正常运行。

    接口

    tim.logout();

    参数

    返回值

    Promise 对象。

    示例

    let promise = tim.logout();
    promise.then(function(imResponse) {
    console.log(imResponse.data); // 登出成功
    }).catch(function(imError) {
    console.warn('logout error:', imError);
    });

    销毁

    销毁 SDK 实例,包括:登出,断开长连接,并释放所有资源。

    接口

    tim.destroy();

    参数

    返回值

    Promise 对象。

    示例

    tim.destroy().then(() => {
    console.log('sdk destroyed');
    });

    登录设置

    默认情况下,不支持多实例登录,即如果此帐号已在其他页面登录,若继续在当前页面登录成功,有可能会将其他页面踢下线。用户被踢下线时会触发事件TIM.EVENT.KICKED_OUT,用户可在监听到事件后做相应处理。示例如下:

    let onKickedOut = function (event) {
    console.log(event.data.type);
    // TIM.TYPES.KICKED_OUT_MULT_ACCOUNT(Web 端,同一帐号,多页面登录被踢)
    // TIM.TYPES.KICKED_OUT_MULT_DEVICE(同一帐号,多端登录被踢)
    // TIM.TYPES.KICKED_OUT_USERSIG_EXPIRED(签名过期)
    // TIM.TYPES.KICKED_OUT_REST_API(REST API kick 接口踢出。v2.20.0起支持)
    };
    tim.on(TIM.EVENT.KICKED_OUT, onKickedOut);
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持