tencent cloud

Tencent Real-Time Communication

Release Notes and Announcements
Release Notes
Recent Product Announcement
TRTC Live (TUILiveKit) Product Launch Announcement
TRTC Conference Official Editions Launched
The commercial version of Conference is coming soon
Terms and Conditions Applicable to $9.9 Starter Package
Rules for the "First Subscription $100 Discount" Promotion
Announcement on the Start of Beta Testing for Multi-person Audio and Video Conference
TRTC Call Official Editions Launched
License Required for Video Playback in New Version of LiteAV SDK
TRTC to Offer Monthly Packages
Product Introduction
Overview
Concepts
Features
Strengths
Use Cases
Performance Statistics
Tencent RTC Quickplay: Experience Ultimate Real-Time Audio and Video Interaction!
Purchase Guide
Billing Overview
Free Minutes
Monthly subscription
Pay-as-you-go
TRTC Overdue and Suspension Policy
FAQs
Refund Instructions
User Tutorial
Free Demo
Call
Overview
Activate the Service
Run Demo
Integration
Offline Call Push
Conversational Chat
On-Cloud Recording
AI Noise Reduction
UI Customization
Calls integration to Chat
Additional Features
No UI Integration
Server APIs
Client APIs
Solution
ErrorCode
Release Notes
FAQs
Conference
Overview（TUIRoomKit）
Activate the Service (TUIRoomKit)
Run Demo（TUIRoomKit）
Integration（TUIRoomKit）
Screen Sharing (TUIRoomKit)
Schedule a meeting (TUIRoomKit)
In-meeting Call (TUIRoomKit)
UI Customization（TUIRoomKit）
Virtual Background (TUIRoomKit)
Conference Control (TUIRoomKit)
Cloud Recording (TUIRoomKit)
AI Noise Reduction (TUIRoomKit)
In-Conference Chat (TUIRoomKit)
Robot Streaming (TUIRoomKit)
Enhanced Features (TUIRoomKit)
Client APIs (TUIRoomKit)
Server APIs (TUIRoomKit)
FAQs (TUIRoomKit)
Error Code (TUIRoomKit)
SDK Update Log (TUIRoomKit)
Live
Billing of Video Live Component
Overview
Activating the Service (TUILiveKit)
Run Demo
No UI Integration
UI Customization
Live Broadcast Monitoring
Video Live Streaming
Voice Chat Room
Advanced Features
Client APIs
Server APIs
Error Codes
Release Notes
FAQs
RTC Engine
Activate Service
SDK Download
API Examples
Usage Guidelines
API Reference Manual
Advanced Features
AI Integration
Overview
Configure MCP Server
Install Skills
Integration Guide
FAQ
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
Console Guide
Application Management
Package Management
Usage Statistics
Monitoring Dashboard
Development Assistance
Solution
Real-Time Chorus
FAQs
Migration Guide
Billing
Features
UserSig
Firewall Restrictions
How to Downsize Installation Package
Android and iOS
Web
Flutter
Electron
TRTCCalling for Web
Audio and Video Quality
Others
Legacy Documentation
RTC RoomEngine SDK（Old）
Integrating TUIRoom (Web)
Integrating TUIRoom (Android)
Integrating TUIRoom (iOS)
Integrating TUIRoom (Flutter)
Integrating TUIRoom (Electron)
TUIRoom APIs
On-Cloud Recording and Playback (Old)
RTC Analytics Monthly Packages (Previous Version)
Protocols and Policies
Compliance
Security White Paper
Notes on Information Security
Service Level Agreement
Apple Privacy Policy: PrivacyInfo.xcprivacy
TRTC Policy
Privacy Policy
Data Processing And Security Agreement
Glossary
DocumentationTencent Real-Time CommunicationLiveClient APIsAndroidLoginStore

LoginStore

PDF
Focus Mode
Font Size
Last updated: 2026-03-05 17:36:40

Introduction

LoginStore provides a complete set of login management APIs, including user login, logout, and personal information settings.
Through this class, you can manage user login status and user profiles.
Important:
Use LoginStore.shared singleton object to access the LoginStore instance.
Note:
Login status updates are delivered through loginState publisher. Subscribe to it to receive real-time updates about login status.

Features

User Login：Supports login using SDK application ID, user ID and user signature
User Logout：Supports user logout operation
Personal Information Settings：Supports setting user nickname, avatar, gender and other personal information

Subscribable Data

LoginState fields are described below:
Property
Type
Description
loginStatus
StateFlow<LoginStatus>
Login status.
loginUserInfo
StateFlow<UserProfile?>
Logged-in user information.

API List

Function
Description
Singleton object.
Login event listener.
Login event listener.
Login.
Logout.
Set personal information.

Getting Instance

LoginStore.shared

Singleton object

Observing Events

addLoginListener

Add login listener
abstract fun addLoginListener(listener: LoginListener)
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
listener
Required
Login listener.

removeLoginListener

Remove login listener
abstract fun removeLoginListener(listener: LoginListener)
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
listener
Required
Login listener.

Login Operations

login

Login
abstract fun login(
    context: Context,
    sdkAppID: Int,
    userID: String,
    userSig: String,
    completion: CompletionHandler? = null
)
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
context
Context
Required
Context.
sdkAppID
Int
Required
SDK application ID.
userID
String
Required
User ID.
userSig
String
Required
User signature.
completion
Required
Completion callback.

logout

Logout
abstract fun logout(completion: CompletionHandler? = null)
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
completion
Required
Completion callback.

setSelfInfo

Set personal information
abstract fun setSelfInfo(
    userProfile: UserProfile,
    completion: CompletionHandler? = null
)
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
userProfile
Required
User profile.
completion
Required
Completion callback.

Data Structures

LoginStatus

Login status.
Enum Value
Description
UNLOGIN
Not logged in.
LOGINED
Logged in.

AllowType

Friend verification type.
Enum Value
Value
Description
ALLOW_ANY
0
Allow anyone.
NEED_CONFIRM
1
Need confirmation.
DENY_ANY
2
Deny anyone.

Gender

Gender.
Enum Value
Value
Description
UNKNOWN
0
Unknown.
MALE
1
Male.
FEMALE
2
Female.

LoginListener

Login event.
Methods
Method
Description
onKickedOffline
Current user kicked offline.
onLoginExpired
Login ticket expired.

UserProfile

User profile
Property
Type
Description
userID
String
User ID.
nickname
String?
Nickname.
avatarURL
String?
Avatar URL.
selfSignature
String?
Personal signature.
gender
Gender.
role
Int?
Role.
level
Int?
Level.
birthday
Long?
Birthday.
allowType
Friend verification type.
customInfo
Map<String, ByteArray>?
Custom information.

LoginState

Login state
Property
Type
Description
loginStatus
StateFlow<LoginStatus>
Login status.
loginUserInfo
StateFlow<UserProfile?>
Logged-in user information.
Previous Topic: LiveSeatStoreNext Topic: Web

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback