登录
大约 3 分钟
Windows 集成文档
登录
初始化 IM SDK 后,你需要首先调用接口登录。登录成功后,才能使用 IM 的功能。
用户注册
用户注册模式分为以下两种:
- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在环信即时通讯云控制台的即时通讯 > 服务概览的设置区域,将用户注册模式设置为开放注册。只有打开该开关,才能使用客户端或 REST API开放注册用户。
示例代码如下所示:
SDKClient.Instance.CreateAccount(username, password,
callback: new CallBack(
onSuccess: () => {
Debug.Log("CreateAccount succeed");
},
onError: (code, desc) => {
Debug.Log($"CreateAccount failed, code: {code} ; desc: {desc}");
}
)
);
- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在环信即时通讯云控制台的即时通讯 > 服务概览的设置区域,将用户注册模式设置为授权注册。相关的 REST API 介绍,详见授权注册单个用户和批量授权注册用户的接口介绍。
除此以外,可以在环信即时通讯云控制台创建正式环境下和测试环境下的用户,详见创建用户相关介绍。
主动登录
- 用户 ID + token 是更加安全的登录方式。
测试环境下,你在环信即时通讯云控制台创建用户后,环信服务器会自动为这些用户分配用户 Token,详见测试环境下创建用户的介绍。
使用 token 登录时需要处理 token 过期的问题,比如在每次登录时更新 token 等机制。
SDKClient.Instance.LoginWithToken(username, token, true,
callback: new CallBack(
onSuccess: () =>
{
Debug.Log("login succeed");
},
onError: (code, desc) =>
{
if (code == 200)
{
Debug.Log("Already login.");;
}
else
{
Debug.Log($"login failed, code: {code} ; desc: {desc}");
}
}
)
);
- 用户 ID + 密码登录是传统的登录方式。用户名和密码均由你的终端用户自行决定,密码需要符合密码规则要求。
SDKClient.Instance.Login(username, password,
callback: new CallBack(
onSuccess: () =>
{
Debug.Log("login succeed");
},
onError: (code, desc) =>
{
if (code == 200)
{
Debug.Log("Already login.");;
}
else
{
Debug.Log($"login failed, code: {code} ; desc: {desc}");
}
}
)
);
自动登录
暂时不支持自动登录。
获取当前登录的用户
你可以调用 SDKClient#CurrentUsername
方法获取当前登录用户的用户 ID。
获取登录状态
你可以调用 SDKClient#IsLoggedIn
方法获取当前用户的登录状态。
退出登录
你可以调用 Logout
方法退出登录。退出登录后,你不会再收到其他用户发送的消息。
异步方法:
SDKClient.Instance.Logout(false,
callback: new CallBack(
onSuccess: () =>
{
Debug.Log("Logout succeed");
},
onError: (code, desc) =>
{
Debug.Log($"Logout failed, code:{code}, desc:{desc}");
}
)
);
提示
如果调用退出方法,在收到 onSuccess
回调后才能去调用 IM 相关方法,例如 Login
。
账号切换
若在 app 中从当前账号切换到其他账号,你需要首先调用 Logout
方法登出,然后再调用 LoginWithToken
或 Login
方法登录。
多设备登录
除了单端单设备登录,环信即时通讯 IM 支持同一账号在多端的多个设备上登录。多设备登录时,若同端设备数量超过限制,新登录的设备会将之前登录的设备踢下线。
关于多设备登录场景中的设备数量限制、互踢策略以及信息同步,详见多设备登录文档。
更多
登录被封禁账号的提示
在环信即时通讯控制台或调用 REST API 封禁用户账号后,若仍使用该账号登录,SDK会返回 "service is disabled"(305 错误), 可以根据用户这个返回值来进行相应的提示或者处理。