LoginStore
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 | Login status. | |
loginUserInfo | 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
LoginState
Login state
Property | Type | Description |
loginStatus | Login status. | |
loginUserInfo | Logged-in user information. |
