TUIConferenceInvitationManager

Copyright (c) 2024 Tencent. All rights reserved.
Module: TUIConferenceInvitationManager @ TUIKitEngine
Function: Conference invitation APIS.

TUIConferenceInvitationManager

TUIConferenceInvitationManager

FuncList
DESC
Receive invitation callback
Invitation has been handled on another device callback
Invitation has been cancelled callback
Invitation has been accepted callback
Invitation has been rejected callback
Invitation timeout callback
Invitation revoked by admin callback
Invitation has been added callback
Invitation has been removed callback
Invitation status change callback
Add event observer
Remove event observer
Invite users
Cancel invitation
Accept invitation
Reject invitation
Get invitation list

StructType

FuncList
DESC
Invitation information structure

EnumType

EnumType
DESC
Invitation status
Invitation error code enumeration
Invitation rejected reason enumeration

onReceiveInvitation

onReceiveInvitation
void onReceiveInvitation
(TUIRoomDefine.RoomInfo roomInfo

Invitation invitation

String extensionInfo)

Receive invitation callback

Param
DESC
extensionInfo
Extension information.
invitation
Invitation information.
roomInfo
Room information.

onInvitationHandledByOtherDevice

onInvitationHandledByOtherDevice
void onInvitationHandledByOtherDevice
(TUIRoomDefine.RoomInfo roomInfo

boolean accepted)

Invitation has been handled on another device callback

Param
DESC
accepted
Whether the invitation has been accepted.
roomInfo
Room information.

onInvitationCancelled

onInvitationCancelled
void onInvitationCancelled
(TUIRoomDefine.RoomInfo roomInfo

Invitation invitation)

Invitation has been cancelled callback

Param
DESC
invitation
Invitation information.
roomInfo
Room information.

onInvitationAccepted

onInvitationAccepted
void onInvitationAccepted
(TUIRoomDefine.RoomInfo roomInfo

Invitation invitation)

Invitation has been accepted callback

Param
DESC
invitation
Invitation information.
roomInfo
Room information.

onInvitationRejected

onInvitationRejected
void onInvitationRejected
(TUIRoomDefine.RoomInfo roomInfo

Invitation invitation

RejectedReason reason)

Invitation has been rejected callback

Param
DESC
invitation
Invitation information.
reason
Reason for rejection.
roomInfo
Room information.

onInvitationTimeout

onInvitationTimeout
void onInvitationTimeout
(TUIRoomDefine.RoomInfo roomInfo

Invitation invitation)

Invitation timeout callback

Param
DESC
invitation
Invitation information.
roomInfo
Room information.

onInvitationRevokedByAdmin

onInvitationRevokedByAdmin
void onInvitationRevokedByAdmin
(TUIRoomDefine.RoomInfo roomInfo

Invitation invitation

TUIRoomDefine.UserInfo admin)

Invitation revoked by admin callback

Param
DESC
admin
Admin information.
invitation
Invitation information.
roomInfo
Room information.

onInvitationAdded

onInvitationAdded
void onInvitationAdded
(String roomId

Invitation invitation)

Invitation has been added callback

Param
DESC
invitation
Invitation information.
roomId
Room ID.

onInvitationRemoved

onInvitationRemoved
void onInvitationRemoved
(String roomId

Invitation invitation)

Invitation has been removed callback

Param
DESC
invitation
Invitation information.
roomId
Room ID.

onInvitationStatusChanged

onInvitationStatusChanged
void onInvitationStatusChanged
(String roomId

Invitation invitation)

Invitation status change callback

Param
DESC
invitation
Invitation information.
roomId
Room ID.

addObserver

addObserver
void addObserver
(Observer observer)

Add event observer

Param
DESC
observer
Instance being observed to.

removeObserver

removeObserver
void removeObserver
(Observer observer)

Remove event observer

Param
DESC
observer
Instance being observed to.

inviteUsers

inviteUsers
void inviteUsers
(String roomId

List<String> userIdList

int timeout

String extensionInfo

InviteUsersCallback callback)

Invite users

Param
DESC
extensionInfo
Extension information.
roomId
Room ID.
timeout
Timeout duration.
userIdList
List of user IDs.

cancelInvitation

cancelInvitation
void cancelInvitation
(String roomId

List<String> userIdList

TUIRoomDefine.ActionCallback callback)

Cancel invitation

Param
DESC
roomId
Room ID.
userIdList
List of user IDs.

accept

accept
void accept
(String roomId

TUIRoomDefine.ActionCallback callback)

Accept invitation

Param
DESC
roomId
Room ID.

reject

reject
void reject
(String roomId

RejectedReason reason

TUIRoomDefine.ActionCallback callback)

Reject invitation

Param
DESC
reason
Reason for rejection.
roomId
Room ID.

getInvitationList

getInvitationList
void getInvitationList
(String roomId

String cursor

int count

GetInvitationListCallback callback)

Get invitation list

Param
DESC
count
The number of invitation to get this time.
cursor
Pagination index retrieval. For the first fetch, use an empty string. If the callback returns data with a non-empty cursor, it indicates that pagination is needed. Please call the interface again using the returned cursor as the parameter until the cursor returned is empty, indicating that all data has been fetched.
roomId
Room ID.

TUIInvitationStatus

TUIInvitationStatus

Invitation status

Enum
Value
DESC
NONE
0
None status.
PENDING
1
Pending status.
TIMEOUT
2
Timeout status.
ACCEPTED
3
Accepted status.
REJECTED
4
Rejected status.

TUIInvitationCode

TUIInvitationCode

Invitation error code enumeration

Enum
Value
DESC
SUCCESS
0
Invitation successful.
ALREADY_IN_INVITATION_LIST
1
The current user is already in the invitation list.
ALREADY_IN_CONFERENCE
2
The current user is already in the conference.

TUIInvitationRejectedReason

TUIInvitationRejectedReason

Invitation rejected reason enumeration

Enum
Value
DESC
REJECT_TO_ENTER
0
Reject to enter.
IN_OTHER_CONFERENCE
1
In other conference.

TUIInvitation

TUIInvitation

Invitation information structure

EnumType
DESC
invitee
Information of the invitee.
inviter
Information of the inviter.
status
Invitation status.