登录

大约 4 分钟

登录

初始化 IM SDK 后,你需要首先调用接口登录。登录成功后,才能使用 IM 的功能。

用户注册

用户注册模式分为以下两种:

  • 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在环信即时通讯云控制台open in new window即时通讯 > 服务概览设置区域,将用户注册模式设置为开放注册。只有打开该开关,才能使用客户端或 REST API开放注册用户。

示例代码如下所示:

// 异步方法
[[EMClient sharedClient] registerWithUsername:@"username"
                                         password:@"your password"
                                       completion:^(NSString *aUsername, EMError *aError) {
                                   }];

除此以外,可以在环信即时通讯云控制台open in new window创建用户,详见创建用户相关介绍

主动登录

  1. 用户 ID + token 是更加安全的登录方式。

使用 token 登录时需要处理 token 过期的问题,比如在每次登录时更新 token 等机制。

EMClient.shared().login(withUsername: "userId", token: "token") { userId, err in
    if err == nil {
        // 登录成功
    } else {
    // 登录失败
    }
}
  1. 用户 ID + 密码 是传统的登录方式。用户名和密码均由你的终端用户自行决定,密码需要符合密码规则要求。
    //SDK 初始化 `EMOptions` 时可以传入 `loginExtensionInfo` 属性投递给被踢下线的设备。该属性需要开启多设备登录的情况下才能生效。
    EMOptions *options = [EMOptions optionsWithAppkey:<#AppKey#>];
    options.loginExtensionInfo = @"you was kicked out by other device";
    [EMClient.sharedClient initializeSDKWithOptions:options];
// 异步方法
[[EMClient sharedClient] loginWithUsername:@"username"
                                     password:@"your password"
                                   completion:^(NSString *aUsername, EMError *aError) {

}];

自动登录

初始化时,你可以设置 EMOptions#isAutoLogin 选项确定是否自动登录。如果设置为自动登录,则登录成功之后,后续初始化 SDK 时会自动登录,并收到以下回调。

extension ViewController: EMClientDelegate {
    func autoLoginDidCompleteWithError(_ aError: EMError?) {
        
    }
}

获取当前登录的用户

你可以调用 EMClient.shared().currentUsername 方法获取当前登录用户的用户 ID。

获取登录状态

你可以调用 EMClient.shared().isLoggedIn 方法获取当前用户的登录状态。

退出登录

你可以调用 logout 方法退出登录。退出登录后,你不会再收到其他用户发送的消息。

异步方法:

EMClient.shared().logout(true) { aError in
    if aError == nil {
        // 退出成功
    } else {
        // 退出失败
    }
}

提示

  1. 如果集成了 APNs 等第三方推送,logout 方法中 aIsUnbindDeviceToken 参数需设为 true,退出时会解绑设备 token,否则可能会出现退出了,还能收到消息推送通知的现象。 有时可能会遇到网络问题而解绑失败,app 处理时可以弹出提示框让用户选择,是否继续退出(弹出框提示继续退出能收到消息的风险),如果用户选择继续退出,传 false 再调用 logout 方法退出成功。当然也可以失败后还是返回退出成功,然后在后台起个线程不断调用 logout 方法直到成功。这样存在风险,即用户杀掉了 app,网络恢复后用户还会继续收到消息。

  2. 如果调用异步退出方法,在收到 completion 回调后才能去调用 IM 相关方法,例如 login

账号切换

若在 app 中从当前账号切换到其他账号,你需要首先调用 logout 方法登出,然后再调用 login 方法登录,此时aIsUnbindDeviceToken参数需设为false

多设备登录

除了单端单设备登录,环信即时通讯 IM 支持同一账号在多端的多个设备上登录。多设备登录时,若同端设备数量超过限制,新登录的设备会将之前登录的设备踢下线。

关于多设备登录场景中的设备数量限制、互踢策略以及信息同步,详见多设备登录文档

更多

登录被封禁账号的提示

在环信即时通讯控制台或调用 REST API 封禁用户账号后,若仍使用该账号登录,SDK会返回 "service is disabled"(305 错误), 可以根据用户这个返回值来进行相应的提示或者处理。