登录登出

登录集成必读

手动登录

正常登录会收到三次回调，分别表示登录的不同过程，登录过程中的不同步骤和返回的错误码参考 枚举 NIMLoginStep 和 NIMResCode说明。 当登录步骤为 nim::kNIMLoginStepLogin 并且 错误码为 nim::kNIMResSuccess 时表明登录成功。

• API原型

static bool Login (const std::string &app_key, const std::string &account, const std::string &password, const LoginCallback &cb, const std::string &json_extension="")

• 参数说明

• 示例

void OnLoginCallback(const nim::LoginRes& login_res, const void* user_data)
{
    if (login_res.res_code_ == nim::kNIMResSuccess)
    {
        if (login_res.login_step_ == nim::kNIMLoginStepLogin)
        {
            //登录成功
        }
    }
    else
    {
        //登录过程出现错误
    }
}

void foo()
{
    nim::Client::Login(app_key, "app acount", "token", &OnLoginCallback);
}

• SDK回调注册

  SDK 登录后会同步群信息，离线消息，漫游消息，系统通知等数据，所以首次登录前需要 提前注册好全局广播类通知的回调。

自动登录

SDK 在网络连接断开后，会监听网络状况，开发者可以通过注册连接断开广播通知，在通知的回调函数中开发者只要根据需要打印log或通知用户即可。

• 网络断开回调

  注册回调函数获取网络断开通知

    static void RegDisconnectCb (const DisconnectCallback &cb, const std::string &json_extension="")

• 重连结果回调

  网络恢复时SDK会执行自动登录，注册回调获取自动登录的结果，与手动登录结果回调相同。

    static void RegReloginCb(const LoginCallback& cb, const std::string& json_extension = "");

登出

应用层登出/注销自己的账号时需要调用 SDK 的登出操作， 该操作会通知云信服务器断开连接。在调用 Logout 时需要设置正确的 NIMLogoutType 参数。清理SDK必须在完全退出（收到退出回调）后执行。

• API原型

/** @fn void Logout(nim::NIMLogoutType logout_type, const LogoutCallback& cb, const std::string& json_extension = "")
* NIM客户端注销/退出
* @param[in] logout_type Logout操作类型，其定义见nim_client_def.h
* @param[in] cb 注销/退出的回调函数
* @param[in] json_extension json扩展参数（备用，目前不需要）
* @return void 无返回值
* @note 错误码
*/
static void Logout(NIMLogoutType logout_type
    , const LogoutCallback& cb
    , const std::string& json_extension = "");

• 参数说明

• 示例

void LoginCallback::OnLogoutCallback(nim::NIMResCode res_code)
{
    //如果是退出程序需要调用nim::Client::Cleanup() 然后退出进程
    //如果是登出到登录界面，这里不能执行清理SDK工作，否则会报错
}

void foo()
{
    //登出到登录界面(nim::kNIMLogoutChangeAccout) 或者 退出程序(nim::kNIMLogoutAppExit)
    nim::Client::Logout(nim::kNIMLogoutAppExit, &OnLogoutCallback);
}

多端登录

通过提前注册全局的多端登录广播通知，当用户在某个客户端登录或登出时，其他没有被踢掉的端会触发这个通知的回调函数，并携带当前时间登录的设备列表的数据。

• API原型

static void RegMultispotLoginCb (const MultiSpotLoginCallback &cb, const std::string &json_extension="")

• 示例

void LoginCallback::OnMultispotLoginCallback(const nim::MultiSpotLoginRes& res)
{
    //通过res参数获取登录或登出设备信息
}
nim::Client::RegMultispotLoginCb(&nim_comp::LoginCallback::OnMultispotLoginCallback);

互踢

通过接口nim::Client::RegKickoutCb来注册被踢出回调函数，当收到此通知时，一般是退出程序然后回到登录窗口，回调函数参数中详细说明了被踢出的原因。 网易云信内置踢人策略为：移动端(Android,iOS)互踢，桌面端(PC,Web)互踢，移动端和桌面端共存。 如果当前的互踢策略无法满足业务需求的话，可以联系我们取消内置互踢，根据多端登录的回调和当前的设备列表，判断本设备是否需要被踢出。如果需要踢出，直接调用登出接口并在界面上给出相关提示即可。

• API原型

static void RegKickoutCb (const KickoutCallback &cb, const std::string &json_extension="")

• 示例

void OnKickoutCallback(const nim::KickoutRes& res)
{
    //处理被其他端踢下线
}

void foo()
{
    nim::Client::RegKickoutCb(&OnKickoutCallback);
}

本篇文档内容是否对您有帮助？

有帮助 我要吐槽

如果遇到产品相关问题，您可 提交工单 或 在线客服 寻求帮助。

此文档对你是否有帮助

×

有帮助 我要吐槽

×

反馈成功

非常感谢您的反馈，我们会继续努力做得更好。

确定