tencent cloud

BattleStore
Download PDF
Last updated:2026-03-05 17:06:12
BattleStore
Last updated: 2026-03-05 17:06:12
Download PDF

Introduction

PK feature enables real-time interactive battles between hosts. BattleStore provides a comprehensive set of APIs to manage the entire PK lifecycle.
Important:
Always use the factory method create(liveID:) with a valid live room ID to create a BattleStore instance. Do not attempt to initialize directly.
Note:
PK state updates are delivered through the state publisher. Subscribe to it to receive real-time updates about PK information, participating users, and scores.
Warning:
If a PK request does not receive a response within the specified timeout, a timeout event will be triggered. Always handle timeout scenarios in the UI.

Features

PK Request Management：Hosts can initiate PK requests, and invitees can accept or reject
State Management：Real-time tracking of PK information, participating users, and scores
Event-Driven Architecture：Provides complete PK event callbacks
Timeout Handling：Built-in timeout mechanism for PK requests

Subscribable Data

BattleState fields are described below:
Property
Type
Description
currentBattleInfo
Current PK information.
battleUsers
PK user list.
battleScore
[String: UInt]
PK score mapping.

API List

Function
Description
Create BattleStore instance.
PK event publisher.
Initiate PK request.
Cancel PK request.
Accept PK request.
Reject PK request.
Exit PK.

Creating Instance

create

Create BattleStore instance
public static func create(liveID: String) -> BattleStore {
    let store: BattleStoreImpl = StoreFactory.shared.getStore(liveId: liveID)
    return store
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
liveID
String
Required
Live room ID.

Observing State and Events

battleEventPublisher

PK event publisher

PK Operations

requestBattle

Initiate PK request
public func requestBattle(config: BattleConfig, userIDList: [String], timeout: TimeInterval, completion: BattleRequestClosure?) {
    fatalError("\\(#function) must be overridden by subclass")
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
config
Required
PK configuration.
userIDList
[String]
Required
List of user IDs to join PK.
timeout
TimeInterval
Required
Request timeout duration.
completion
BattleRequestClosure?
Required
Callback for successful request initiation.

cancelBattleRequest

Cancel PK request
public func cancelBattleRequest(battleId: String, userIdList: [String], completion: CompletionClosure?) {
    fatalError("\\(#function) must be overridden by subclass")
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
battleId
String
Required
PK ID.
userIdList
[String]
Required
User ID list.
completion
Required
Callback for successful cancellation.

acceptBattle

Accept PK request
public func acceptBattle(battleID: String, completion: CompletionClosure?) {
    fatalError("\\(#function) must be overridden by subclass")
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
battleID
String
Required
PK ID.
completion
Required
Callback for successful acceptance.

rejectBattle

Reject PK request
public func rejectBattle(battleID: String, completion: CompletionClosure?) {
    fatalError("\\(#function) must be overridden by subclass")
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
battleID
String
Required
PK ID.
completion
Required
Callback for successful rejection.

exitBattle

Exit PK
public func exitBattle(battleID: String, completion: CompletionClosure?) {
    fatalError("\\(#function) must be overridden by subclass")
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
battleID
String
Required
PK ID.
completion
Required
Callback for successful exit.

Data Structures

BattleEndedReason

Reason for PK ending received by users in an ongoing PK
Enum Value
Value
Description
timeOver
0
PK countdown ended.
allMemberExit
1
All PK members exited.

BattleEvent

PK-related callback events received
Enum Value
Description
onBattleStarted
This callback is triggered when PK officially starts, notifying all participants that PK has begun.
onBattleEnded
This callback is triggered when PK ends.
onUserJoinBattle
This callback is triggered when a user joins PK.
onUserExitBattle
This callback is triggered when a user exits PK.
onBattleRequestReceived
This callback is triggered when a PK request is received.
onBattleRequestCancelled
This callback is triggered when a PK request is cancelled.
onBattleRequestTimeout
This callback is triggered when a PK request times out.
onBattleRequestAccept
This callback is triggered when a PK request is accepted.
onBattleRequestReject
This callback is triggered when a PK request is rejected.

BattleConfig

PK configuration information set when sending a PK request
Property
Type
Description
duration
TimeInterval
PK duration (unit: seconds).
needResponse
Bool
Whether the invitee needs to reply with accept/reject.
extensionInfo
String
Extension information.

BattleInfo

PK information
Property
Type
Description
battleID
String
PK ID.
config
PK configuration information set when sending a PK request.
startTime
UInt
PK start marker timestamp (unit: seconds).
endTime
UInt
PK end marker timestamp (unit: seconds).

BattleState

PK-related state data provided by BattleStore
Property
Type
Description
currentBattleInfo
Current PK information.
battleUsers
PK user list.
battleScore
[String: UInt]
PK score mapping.

BattleRequestCallback

PK request callback
Callback interface for PK requests, used to handle success or failure results of PK requests.
Methods
onSuccess: Success callback.
fun onSuccess(battleInfo: BattleInfo, resultMap: Map<String, Int>)
Parameter
Type
Description
battleInfo
PK information, containing detailed configuration and status of the PK.
resultMap
Map<String, Int>
Response result callback for PK request.
onError: Failure callback.
fun onError(code: Int, desc: String)
Parameter
Type
Description
code
Int
Error code.
desc
String
Error description.

Usage Example

// Create store instance
let store = BattleStore.create(liveID: "live_room_123")

// Subscribe to state changes
store.state.subscribe { state in
    if let battleInfo = state.currentBattleInfo {
        print("Current PK ID: \\(battleInfo.battleID)")
    }
    print("PK user count: \\(state.battleUsers.count)")
}

// Subscribe to PK events
store.battleEventPublisher.sink { event in
    switch event {
    case .onBattleStarted(let battleInfo, let inviter, let invitees):
        print("PK started, initiator: \\(inviter.userName)")
    case .onBattleEnded(let battleInfo, let reason):
        print("PK ended, reason: \\(reason)")
    default:
        break
    }
}

// Initiate PK request
let config = BattleConfig(duration: 300, needResponse: true)
store.requestBattle(config: config, userIDList: ["user_456"], timeout: 30) { result in
    switch result {
    case .success(let (battleInfo, resultMap)):
        print("PK request successful: \\(battleInfo.battleID)")
    case .failure(let error):
        print("PK request failed: \\(error)")
    }
}

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback