tencent cloud

即时通信 IM

动态与公告
产品动态
公告
产品简介
产品概述
基本概念
应用场景
功能介绍
账号系统
用户资料与关系链
消息管理
群组相关
公众号系统
音视频通话 Call
使用限制
购买指南
计费概述
价格说明
购买指引
续费指引
停服说明
退费说明
开发指引
Demo 专区
开通服务
体验 Demo
快速跑通
下载中心
SDK & Demo 源码
更新日志
聊天互动(含 UI)
TUIKit 组件介绍
快速开始
全功能接入
单功能接入
AI 集成
构建基础界面
更多特性
定义外观
国际化界面语言
推送服务(Push)
服务概述
名词解释
开通服务
快速跑通
厂商通道
数据统计
排查工具
客户端 API
服务端 API
推送回调
高级功能
更新日志
错误码
常见问题
智能客服
功能概述
快速入门
集成指引
管理员操作手册
客服操作手册
更多实践
直播间搭建
AI 聊天机器人方案
超大娱乐协作社群
Discord 实现指南
游戏内集成 Chat 指南
类 WhatsApp Channel 搭建方案
发送红包
Chat 应对防火墙限制相关
无 UI 集成
快速开始
集成 SDK
初始化
登录登出
消息相关
会话相关
群组相关
社群话题
用户管理
离线推送
云端搜索
本地搜索
公众号
客户端 API
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C 接口
C++
服务端 API
生成 UserSig
REST API
第三方回调
控制台指南
新版控制台介绍
创建并升级应用
基本配置
功能配置
账号管理
群组管理
公众号管理
回调配置
用量统计
资源包查看指南
实时监控
开发辅助工具
访问管理
高级功能
常见问题
uni-app 常见问题
购买相关问题
SDK 相关问题
账号鉴权相关问题
用户资料与关系链相关问题
消息相关问题
群组相关问题
直播群相关问题
昵称头像相关问题
协议与认证
服务等级协议
安全合规认证
IM 政策
隐私政策
数据隐私和安全协议
平滑迁移方案
平滑迁移完整版
平滑迁移简化版
错误码
联系我们

React Native

PDF
聚焦模式
字号
最后更新时间: 2025-01-14 15:11:28

功能描述

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

登录

说明:
1. 登录成功,需等待 SDK 处于 ready 状态后(监听事件 TencentCloudChat.EVENT.SDK_READY)才能调用 sendMessage 等需要鉴权的接口。
2. 默认情况下,不支持多实例登录,即如果此账号已在其他页面登录,若继续在当前页面登录成功,有可能会将其他页面踢下线。用户被踢下线时会触发事件 TencentCloudChat.EVENT.KICKED_OUT,用户可在监听到事件后做相应处理。
3. 如需支持多实例登录(允许在多个网页中同时登录同一账号),请到 Chat Console,找到相应 SDKAppID,点击 Application > Chat > Configuration > Login and Message > Login Settings > Max Login Instances per User per Platform 配置实例个数。配置将在5分钟内生效。
4. 小程序、小游戏和 uni-app 和 React Native(即使打包成 native app) 平台集成,登录后都算作 web 实例。
5. 如果此接口返回错误码 60020,意味着您未购买套餐包,或套餐包已过期,或购买的套餐包正在配置中暂未生效。请登录 Chat 购买页面 重新购买套餐包。购买后,将在5分钟后生效。
6. 如果在小程序平台此接口返回错误码 2801,请您检查小程序受信域名配置。
7. 默认情况下,每种平台只支持1个终端在线(如 Android 和 Android 会互踢)。如果需要使用“同平台多设备在线”功能,请 升级专业版、专业版plus或企业版,详见 价格说明
接口
chat.login(options);
参数
参数 options 为 Object 类型,包含的属性值如下:
名称
类型
描述
userID
String
用户 ID。
userSig
String
用户登录 Tencent Cloud Chat 的密码,其本质是对 UserID 等信息加密后得到的密文。具体生成方法请参见 生成 UserSig
返回值
Promise
示例
let promise = chat.login({userID: 'your userID', userSig: 'your userSig'});
promise.then(function(imResponse) {
console.log(imResponse.data); // 登录成功
if (imResponse.data.repeatLogin === true) {
// 标识账号已登录,本次登录操作为重复登录。
console.log(imResponse.data.errorInfo);
}
}).catch(function(imError) {
console.warn('login error:', imError); // 登录失败的相关信息
});

获取登录用户信息

API
chat.getLoginUser();
Parameter
Returned value
String
Sample
const userID = chat.getLoginUser();

获取服务器时间

API
chat.getServerTime();
Parameter
Returned value
Number
Sample
const serverTime = chat.getServerTime();

SDK 是否 ready

After the SDK is ready, developers can call the SDK's APIs to send messages and use various features of the SDK.
Developers can also listen for:
SDK_READY, which is triggered when the SDK enters the ready state.
SDK_NOT_READY, which is triggered when the SDK enters the not ready state.
API
chat.isReady();
Parameter
Returned value
Boolean
Sample
let isReady = chat.isReady();

登出

登出 Chat SDK,通常在切换账号的时候调用,清除登录态以及内存中的所有数据。
说明:
1. 调用此接口的实例会发布 SDK_NOT_READY 事件,此时该实例下线,无法收、发消息。
2. 如果您在 Chat Console 配置的“Web端实例同时在线个数”大于 1,且同一账号登录了a1和a2两个实例(含小程序端),当执行a1.logout()后,a1会下线,无法收、发消息。而a2实例不会受影响。
3. 多实例被踢:基于第 2 点,如果“Web端实例同时在线个数”配置为 2,且您的某一账号已经登录了 a1,a2两个实例,当使用此账号成功登录第三个实例a3时,a1或a2中的一个实例会被踢下线(通常是最先处在登录态的实例会触发),这种情况称之为“多实例被踢”。假设a1实例被踢下线,a1实例内部会执行登出流程,然后抛出KICKED_OUT事件,接入侧可以监听此事件,并在触发时跳转到登录页。此时a1实例下线,而a2、a3实例可以正常运行。
接口
chat.logout();
参数
返回值
Promise
示例
let promise = chat.logout();
promise.then(function(imResponse) {
console.log(imResponse.data); // 登出成功
}).catch(function(imError) {
console.warn('logout error:', imError);
});

销毁

销毁 SDK 实例。SDK 会先 logout,然后断开 WebSocket 长连接,并释放资源。
接口
chat.destroy();
参数
返回值
Promise
示例
let promise = chat.destroy();

登录设置

默认情况下,SDK 不支持多实例登录,即如果此已在其他页面登录,若继续在当前页面登录成功,有可能会将其他页面踢下线。用户被踢下线时会触发事件TencentCloudChat.EVENT.KICKED_OUT,用户可在监听到事件后做相应处理。
let onKickedOut = function(event) {
console.log(event.data.type);
// TencentCloudChat.TYPES.KICKED_OUT_MULT_ACCOUNT(Web端,同一账号,多页面登录被踢)
// TencentCloudChat.TYPES.KICKED_OUT_MULT_DEVICE(同一账号,多端登录被踢)
// TencentCloudChat.TYPES.KICKED_OUT_USERSIG_EXPIRED(签名过期)
// TencentCloudChat.TYPES.KICKED_OUT_REST_API(REST API kick 接口踢出)
};

chat.on(TencentCloudChat.EVENT.KICKED_OUT, onKickedOut);


帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈