tencent cloud

实时音视频

动态与公告
产品动态
产品近期公告
关于 TRTC Live 正式上线的公告
关于TRTC Conference 正式版上线的公告
Conference 商业化版本即将推出
关于多人音视频 Conference 开启内测公告
关于音视频通话 Call 正式版上线的公告
关于腾讯云音视频终端 SDK 播放升级及新增授权校验的公告
关于 TRTC 应用订阅套餐服务上线的相关说明
产品简介
产品概述
基本概念
产品功能
产品优势
应用场景
性能数据
购买指南
计费概述
免费时长说明
月订阅
现收现付
TRTC 逾期与暂停政策
常见问题解答
退款说明
新手指引
Demo 体验
视频通话 SDK
组件介绍
开通服务
跑通 Demo
快速接入
离线唤醒
会话聊天
云端录制
AI 降噪
界面定制
Chat 集成通话能力
更多特性
无 UI 集成
服务端 API
客户端 API
解决方案
错误码表
发布日志
常见问题
视频会议 SDK
组件介绍(TUIRoomKit)
开通服务(TUIRoomKit)
跑通 Demo(TUIRoomKit)
快速接入(TUIRoomKit)
屏幕共享(TUIRoomKit)
预定会议(TUIRoomKit)
会中呼叫(TUIRoomKit)
界面定制(TUIRoomKit)
虚拟背景(TUIRoomKit)
会议控制(TUIRoomKit)
云端录制(TUIRoomKit)
AI 降噪(TUIRoomKit)
会中聊天(TUIRoomKit)
机器人推流(TUIRoomKit)
更多特性(TUIRoomKit)
客户端 API(TUIRoomKit)
服务端 API(TUIRoomKit)
常见问题(TUIRoomKit)
错误码 (TUIRoomKit)
SDK更新日志(TUIRoomKit)
直播与语聊 SDK
Live 视频直播计费说明
组件介绍
开通服务(TUILiveKit)
跑通 Demo
无 UI 集成
UI 自定义
直播监播
视频直播
语聊房
高级功能
客户端 API
服务端 API
错误码
发布日志
常见问题
RTC Engine
开通服务
SDK 下载
API-Example
接入指引
API-参考手册
高级功能
AI 集成
概述
MCP 配置
Skills 配置
集成指南
常见问题
RTC RESTFUL API
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
控制台指南
应用管理
套餐包管理
用量统计
监控仪表盘
开发辅助
解决方案
实时合唱
常见问题
迁移指南
计费相关
功能相关
UserSig 相关
应对防火墙限制相关
缩减安装包体积相关
Andriod 与 iOS 相关
Web 端相关
Flutter 相关
Electron 相关
TRTCCalling Web 相关
音视频质量相关
其他问题
旧版文档
RTC RoomEngine SDK(旧)
集成 TUIRoom (Web)
集成 TUIRoom (Android)
集成 TUIRoom (iOS)
集成 TUIRoom (Flutter)
集成 TUIRoom (Electron)
TUIRoom API 查询
实现云端录制与回放(旧)
监控仪表盘计费(旧)
协议与策略
安全合规认证
安全白皮书
信息安全说明
服务等级协议
苹果隐私策略:PrivacyInfo.xcprivacy
TRTC 政策
隐私协议
数据处理和安全协议
词汇表

LoginStore

PDF
聚焦模式
字号
最后更新时间: 2026-03-05 17:36:41

简介

LoginStore 提供了一套完整的登录管理 API,包括用户登录、登出、设置个人信息等功能。
通过该类,可以管理用户的登录状态和用户资料。
重要:
使用 LoginStore.shared 单例对象访问 LoginStore 实例。
说明:
登录状态更新通过 loginState 发布者传递。订阅它以接收登录状态的实时更新。

功能特性

用户登录:支持使用 SDK 应用 ID、用户 ID 和用户签名进行登录。
用户登出:支持用户登出操作。
个人信息设置:支持设置用户昵称、头像、性别等个人资料。

可订阅数据

LoginState 的字段描述如下:
属性名
类型
描述
loginStatus
StateFlow<LoginStatus>
登录状态。
loginUserInfo
StateFlow<UserProfile?>
登录用户信息。

API 列表

函数名
描述
单例对象。
登录事件监听器。
登录事件监听器。
登录。
登出。
设置个人信息。

获取实例

LoginStore.shared

单例对象。

观察事件

addLoginListener

添加登录监听器
abstract fun addLoginListener(listener: LoginListener)
版本信息
从 3.5 版本开始支持。
参数说明
参数名
类型
是否必填
描述
listener
必填
登录监听器。

removeLoginListener

移除登录监听器
abstract fun removeLoginListener(listener: LoginListener)
版本信息
从 3.5 版本开始支持。
参数说明
参数名
类型
是否必填
描述
listener
必填
登录监听器。

登录操作

login

登录
abstract fun login(
context: Context,
sdkAppID: Int,
userID: String,
userSig: String,
completion: CompletionHandler? = null
)
版本信息
从 3.5 版本开始支持。
参数说明
参数名
类型
是否必填
描述
context
Context
必填
上下文。
sdkAppID
Int
必填
SDK 应用 ID。
userID
String
必填
用户 ID。
userSig
String
必填
用户签名。
completion
必填
完成回调。

logout

登出
abstract fun logout(completion: CompletionHandler? = null)
版本信息
从 3.5 版本开始支持。
参数说明
参数名
类型
是否必填
描述
completion
必填
完成回调。

setSelfInfo

设置个人信息
abstract fun setSelfInfo(
userProfile: UserProfile,
completion: CompletionHandler? = null
)
版本信息
从 3.5 版本开始支持。
参数说明
参数名
类型
是否必填
描述
userProfile
必填
用户资料。
completion
必填
完成回调。

数据结构

LoginStatus

登录状态。
枚举值
说明
UNLOGIN
未登录。
LOGINED
已登录。

AllowType

好友验证方式。
枚举值
说明
ALLOW_ANY
0
允许任何人。
NEED_CONFIRM
1
需要验证。
DENY_ANY
2
拒绝任何人。

Gender

性别。
枚举值
说明
UNKNOWN
0
未知。
MALE
1
男性。
FEMALE
2
女性。

LoginListener

登录事件。
方法
方法名
说明
onKickedOffline
当前用户被踢下线。
onLoginExpired
登录票据过期。

UserProfile

用户资料。
属性
类型
说明
userID
String
用户 ID。
nickname
String?
昵称。
avatarURL
String?
头像URL。
selfSignature
String?
个性签名。
gender
性别。
role
Int?
角色。
level
Int?
等级。
birthday
Long?
生日。
allowType
好友验证方式。
customInfo
Map<String, ByteArray>?
自定义信息。

LoginState

登录状态。
属性
类型
说明
loginStatus
StateFlow<LoginStatus>
登录状态。
loginUserInfo
StateFlow<UserProfile?>
登录用户信息。

帮助和支持

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

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

文档反馈