TUILiveBattleManager
Copyright (c) 2024 Tencent. All rights reserved.
Module: TUILiveBattleManager @ TUIKitEngine
Function: Live-Battle APIs
TUILiveBattleManager
TUILiveBattleObserver
FuncList | DESC |
Callback for received the battle start. | |
Callback for received tht battle end. | |
Callback for received user notification of joined the battle. | |
Callback for received user notification of exited the battle. | |
Callback for received score update notification of battle user. | |
Callback for received the battle invitation | |
Callback for canceled the connection invitation | |
Callback for timeout the battle invitation | |
Callback for accpeted the battle invitation | |
Callback for rejected the battle invitation |
TUILiveBattleManager
FuncList | DESC |
Add event callback | |
Remove event callback | |
Request battle invitation. | |
Cancel request about battle invitation. | |
Accept the battle invitaion. | |
Reject the battle invitaion. | |
Exit the battle |
StructType
FuncList | DESC |
Battle User Info | |
Battle Config | |
Battle Info |
EnumType
EnumType | DESC |
Battle Request Status | |
Battle Stopped Reason |
onBattleStarted:
onBattleStarted:
- (void)onBattleStarted: |
Callback for received the battle start.
Param | DESC |
battleInfo | Battle information. |
onBattleEnded:reason:
onBattleEnded:reason:
- (void)onBattleEnded: | |
reason: |
Callback for received tht battle end.
Param | DESC |
battleInfo | Battle information. |
reason | The reason why the PK ended. |
onUserJoinBattle:battleUser:
onUserJoinBattle:battleUser:
- (void)onUserJoinBattle: | (NSString*)battleId |
battleUser: |
Callback for received user notification of joined the battle.
Param | DESC |
battleId | Battle ID. |
battleUser |
onUserExitBattle:battleUser:
onUserExitBattle:battleUser:
- (void)onUserExitBattle: | (NSString*)battleId |
battleUser: |
Callback for received user notification of exited the battle.
Param | DESC |
battleId | Battle ID. |
battleUser |
onBattleScoreChanged:battleUserList:
onBattleScoreChanged:battleUserList:
- (void)onBattleScoreChanged: | (NSString*)battleId |
battleUserList: |
Callback for received score update notification of battle user.
Param | DESC |
battleId | Battle ID. |
battleUserList |
onBattleRequestReceived:inviter:invitee:
onBattleRequestReceived:inviter:invitee:
- (void)onBattleRequestReceived: | |
inviter: | |
invitee: |
Callback for received the battle invitation
Param | DESC |
battleInfo | Battle information. |
invitee | |
inviter |
onBattleRequestCancelled:inviter:invitee:
onBattleRequestCancelled:inviter:invitee:
- (void)onBattleRequestCancelled: | |
inviter: | |
invitee: |
Callback for canceled the connection invitation
Param | DESC |
battleInfo | Battle information. |
invitee | |
inviter |
onBattleRequestTimeout:inviter:invitee:
onBattleRequestTimeout:inviter:invitee:
- (void)onBattleRequestTimeout: | |
inviter: | |
invitee: |
Callback for timeout the battle invitation
Param | DESC |
battleInfo | Battle information. |
invitee | |
inviter |
onBattleRequestAccept:inviter:invitee:
onBattleRequestAccept:inviter:invitee:
- (void)onBattleRequestAccept: | |
inviter: | |
invitee: |
Callback for accpeted the battle invitation
Param | DESC |
battleInfo | Battle information. |
invitee | |
inviter |
onBattleRequestReject:inviter:invitee:
onBattleRequestReject:inviter:invitee:
- (void)onBattleRequestReject: | |
inviter: | |
invitee: |
Callback for rejected the battle invitation
Param | DESC |
battleInfo | Battle information. |
invitee | |
inviter |
addObserver:
addObserver:
- (void)addObserver: |
Add event callback
Param | DESC |
observer | The instance being listened to. |
removeObserver:
removeObserver:
- (void)removeObserver: |
Remove event callback
Param | DESC |
observer | The instance being listened to. |
requestBattle:roomIdList:timeout:onSuccess:onError:
requestBattle:roomIdList:timeout:onSuccess:onError:
- (void)requestBattle: | |
roomIdList: | (NSArray<NSString *> *)roomIdList |
timeout: | (NSTimeInterval)timeout |
onSuccess: | (TUIBattleRequestBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Request battle invitation.
Param | DESC |
config | Battle configuration. |
roomIdList | The list of room IDs will be invited. |
timeout | Timeout time. |
cancelBattleRequest:userIdList:onSuccess:onError:
cancelBattleRequest:userIdList:onSuccess:onError:
- (void)cancelBattleRequest: | (NSString*)battleId |
userIdList: | (NSArray<NSString *> *)userIdList |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Cancel request about battle invitation.
Param | DESC |
battleId | Battle ID. |
roomIdList | The list of room IDs whose battle requests will be canceled. |
acceptBattle:onSuccess:onError:
acceptBattle:onSuccess:onError:
- (void)acceptBattle: | (NSString *)battleId |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Accept the battle invitaion.
Param | DESC |
battleId | Battle ID. |
rejectBattle:onSuccess:onError:
rejectBattle:onSuccess:onError:
- (void)rejectBattle: | (NSString *)battleId |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Reject the battle invitaion.
Param | DESC |
battleId | Battle ID. |
exitBattle:onSuccess:onError:
exitBattle:onSuccess:onError:
- (void)exitBattle: | (NSString *)battleId |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Exit the battle
Param | DESC |
battleId | Battle ID. |
TUIBattleCode
TUIBattleCode
Battle Request Status
Enum | Value | DESC |
TUIBattleCodeUnknown | -1 | default. |
TUIBattleCodeSuccess | 0 | Request success. |
TUIBattleCodeRoomNotExist | 1 | Request Room not exist. |
TUIBattleCodeBattling | 2 | The room you are invited to join the battle is already joined battle. |
TUIBattleCodeBattlingOtherRoom | 3 | The room you are invited to battle to is battling with other rooms. |
TUIBattleCodeRoomExit | 4 | The room is exited. |
TUIBattleCodeRetry | 5 | An internal error occurs. You are advised to try again. |
TUIBattleStoppedReason
TUIBattleStoppedReason
Battle Stopped Reason
Enum | Value | DESC |
TUIBattleStoppedReasonTimeOver | 0 | The Battle reaches the maximum duration and the timeout ends. |
TUIBattleStoppedReasonOtherExit | 1 | The rest of the users has exited. |
TUIBattleUser
TUIBattleUser
Battle User Info
EnumType | DESC |
avatarUrl | The user avatar url of the battle user. |
roomId | The room id of the battle user. |
score | The score of the battle user. |
userId | The user id of the battle user. |
userName | The user name of the battle user. |
TUIBattleConfig
TUIBattleConfig
Battle Config
EnumType | DESC |
duration | The maximum duration of the battle (Unit: seconds). |
extensionInfo | The extension information of battle. |
needResponse | Whether the invited user needs to reply accept/reject. |
TUIBattleInfo
TUIBattleInfo
Battle Info
EnumType | DESC |
battleId | Battle ID. |
config | The configuration of battle. |
endTime | The timestamp marking the end of the battle (Unit: seconds). |
inviteeList | The people who are invited to join the battle. |
inviter | The person who requests the battle. |
startTime | The timestamp marking the start of the battle (Unit: seconds). |
- TUILiveBattleObserver
- TUILiveBattleManager
- StructType
- EnumType
- onBattleStarted:
- onBattleEnded:reason:
- onUserJoinBattle:battleUser:
- onUserExitBattle:battleUser:
- onBattleScoreChanged:battleUserList:
- onBattleRequestReceived:inviter:invitee:
- onBattleRequestCancelled:inviter:invitee:
- onBattleRequestTimeout:inviter:invitee:
- onBattleRequestAccept:inviter:invitee:
- onBattleRequestReject:inviter:invitee:
- addObserver:
- removeObserver:
- requestBattle:roomIdList:timeout:onSuccess:onError:
- cancelBattleRequest:userIdList:onSuccess:onError:
- acceptBattle:onSuccess:onError:
- rejectBattle:onSuccess:onError:
- exitBattle:onSuccess:onError:
- TUIBattleCode
- TUIBattleStoppedReason
- TUIBattleUser
- TUIBattleConfig
- TUIBattleInfo