LikeStore
Introduction
LikeStore provides a complete set of like management APIs, including sending likes, listening to like events, and getting like states. Through this class, you can implement like interaction features in live rooms.Notice:
Use the LikeStore.create factory method to create a
LikeStore instance, which requires a valid live room ID.Note:
Like state updates are delivered through the likeState publisher. Subscribe to it to receive real-time updates of like data in the room.
Features
Like Sending: Support sending likes to the current room.
Like State: Get the accumulated like count of the current room.
Event Listening: Listen to like receiving events.
Subscribable Data
LikeState fields are described below:
Property | Type | Description |
totalLikeCount | StateFlow<Long> | Total accumulated like count of the current live room/voice chat room, supporting real-time updates and subscription listening. |
API List
Function | Description |
Create like management instance. | |
Like event callbacks. | |
Like event callbacks. | |
Send likes. |
Creating Instance
LikeStore.create
Create like management instance.
Observing State and Events
addLikeListener
Add like event listener.
abstract fun addLikeListener(listener: LikeListener?)
Version
Supported since version 3.5.
Parameters
Parameter | Type | Description |
listener | Listener. |
removeLikeListener
Remove like event listener.
abstract fun removeLikeListener(listener: LikeListener?)
Version
Supported since version 3.5.
Parameters
Parameter | Type | Description |
listener | Listener. |
Like Operations
sendLike
Send likes to the current room. All users who have subscribed to like events will receive this like notification.
abstract fun sendLike(count: Int = 1, completion: CompletionHandler?)
Version
Supported since version 3.5.
Parameters
Parameter | Type | Description |
count | Int | Like count, default is 1. |
completion | Completion callback (success/failure status). |
Data Structures
LikeState
Like state, used to display and subscribe to like information in live rooms/voice chat rooms.
Property | Type | Description |
totalLikeCount | StateFlow<Long> | Total accumulated like count of the current live room/voice chat room, supporting real-time updates and subscription listening. |
LikeListener
Like event, used to receive like dynamics in live rooms/voice chat rooms.
This listener is used to receive like dynamics in live rooms/voice chat rooms.
Methods
onReceiveLikesMessage: Event callback for receiving new like messages. When other audiences send likes in the live room/voice chat room, this event will be triggered and return relevant information.
open fun onReceiveLikesMessage(liveID: String, totalLikesReceived: Long, sender: LiveUserInfo) {}
Parameter | Type | Description |
liveID | String | Live room ID. |
totalLikesReceived | Long | Number of new likes received this time. |
sender | Like sender information. |
