BarrageStore

Introduction
BarrageStore provides a complete set of barrage management APIs, including sending text barrages, sending custom barrages, and adding local tip messages. Through this class, you can implement barrage interaction functionality in live rooms.
Important: 
Use the create(liveID:) factory method to create a BarrageStore instance, which requires a valid live room ID.
Note: 
Barrage state updates are delivered through the state publisher. Subscribe to it to receive real-time updates of barrage data in the room.
Features
Text Barrage: Supports sending plain text barrage messages.
Custom Barrage: Supports sending custom format barrages (such as barrages with special effects).
Local Tips: Supports adding tip messages visible only locally.
Subscribable Data
BarrageState fields are described below:
Property
Type
Description
messageList
[Barrage]
Barrage message list of the current room, supports real-time updates and can be subscribed to.
API List
Function
Description
create
Create barrage management instance.
CustomMessageEventPublisher
Custom message event publisher.
sendTextMessage
Send text barrage.
sendCustomMessage
Send custom barrage.
appendLocalTip
Add local tip message.
Creating Instance
create
Barrage management core class for handling barrage related business logic in live rooms/voice chat rooms.
public static func create(liveID: String) -> BarrageStore {
    let store: BarrageStoreImpl = StoreFactory.shared.getStore(liveId: liveID)
    return store
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
liveID
String
Required
Live room ID.
Events Handling
CustomMessageEventPublisher
Custom message event publisher. Subscribe to receive one-time custom message events.
Data Structures：CustomMessageEvent
Sending Barrage
sendTextMessage
Send a text type barrage. After sending successfully, the receiver can obtain barrage messages by subscribing to messageList in BarrageState in advance.
public func sendTextMessage(text: String,
                            extensionInfo: [String: String]?,
                            completion: CompletionClosure?) {
    fatalError("\(#function) must be overridden by subclass")
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
text
String
Required
Text barrage content.
extensionInfo
[String: String]?
Required
Extension information, can contain custom fields (such as specifying barrage color, font size, etc.).
completion
CompletionClosure?
Required
Completion callback (success/failure status).
sendCustomMessage
Send a custom type barrage message. After sending successfully, the receiver can receive custom messages by subscribing to the CustomMessageEventPublisher provided by BarrageStore.
public func sendCustomMessage(businessID: String,
                              data: String,
                              completion: CompletionClosure?) {
    fatalError("\(#function) must be overridden by subclass")
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
businessID
String
Required
Business identifier ID, used to distinguish custom barrages from different business scenarios.
data
String
Required
Custom data content, usually JSON format string, used to pass business custom data.
completion
CompletionClosure?
Required
Completion callback (success/failure status).
Local Messages
appendLocalTip
Add local tip message (add tip or operation feedback message locally, visible only to the current client).
public func appendLocalTip(message: Barrage) {
    fatalError("\(#function) must be overridden by subclass")
}
Version
Supported since version 3.5.
Notes
Note: 
This message is only displayed locally and will not be sent to other users through the network.
Parameters
Parameter
Type
Required
Description
message
Barrage
Required
Local barrage message (such as system tips, operation feedback, etc., visible only to the current user).
Data Structures
BarrageType
Barrage type enumeration, used to distinguish different barrage message types.
Enum Value
Value
Description
text
0
Text type barrage, contains plain text content.
custom
1
Custom type barrage, supports business custom data format (such as barrages with special effects, interactive messages, etc.).
Barrage
Barrage data model, containing complete attribute information of a single barrage.
Property
Type
Description
liveID
String
Unique identifier ID of the live room/voice chat room the barrage belongs to.
sender
LiveUserInfo
User information of the barrage sender (such as user ID, nickname, avatar, etc.).
sequence
Int
Unique sequence ID of the barrage message, used for message sorting and deduplication.
timestampInSecond
TimeInterval
Barrage sending timestamp (unit: seconds), used to display sending time order.
messageType
BarrageType
Barrage message type (text or custom).
textContent
String
Message content of text type barrage, i.e., the text content of the barrage.
extensionInfo
[String: String]?
Barrage extension information, customizable fields (such as display style, priority, etc.). Valid when messageType is TEXT.
businessID
String
Business identifier ID of custom type barrage, used to distinguish custom barrages from different business scenarios.
data
String
Specific data content of custom type barrage (usually JSON format string), valid when messageType is CUSTOM.
BarrageState
Barrage state, managing the barrage data state of the current room.
Property
Type
Description
messageList
[Barrage]
Barrage message list of the current room, supports real-time updates and can be subscribed to.
CustomMessageEvent
Custom message event, representing one-time events for custom messages in the barrage system.
Enum Value
Parameter
Parameter Type
Description
customMessageReceived
barrage
Barrage
Event triggered when a custom message is received in the room.

Property	Type	Description
messageList	[Barrage]	Barrage message list of the current room, supports real-time updates and can be subscribed to.

Function	Description
create	Create barrage management instance.
CustomMessageEventPublisher	Custom message event publisher.
sendTextMessage	Send text barrage.
sendCustomMessage	Send custom barrage.
appendLocalTip	Add local tip message.

Parameter	Type	Required	Description
liveID	String	Required	Live room ID.

Enum Value	Value	Description
text	0	Text type barrage, contains plain text content.
custom	1	Custom type barrage, supports business custom data format (such as barrages with special effects, interactive messages, etc.).

Enum Value	Parameter	Parameter Type	Description
customMessageReceived	barrage	Barrage	Event triggered when a custom message is received in the room.