TUIConferenceInvitationManager

Copyright (c) 2024 Tencent. All rights reserved.
Module:   TUIConferenceInvitationManager @ TUIKitEngine
Function:  Conference invitation APIS.
﻿
TUIConferenceInvitationManager
TUIConferenceInvitationManager
FuncList
DESC
onReceiveInvitation
Receive invitation callback
onInvitationHandledByOtherDevice
Invitation has been handled on another device callback
onInvitationCancelled
Invitation has been cancelled callback
onInvitationAccepted
Invitation has been accepted callback
onInvitationRejected
Invitation has been rejected callback
onInvitationTimeout
Invitation timeout callback
onInvitationRevokedByAdmin
Invitation revoked by admin callback
onInvitationAdded
Invitation has been added callback
onInvitationRemoved
Invitation has been removed callback
onInvitationStatusChanged
Invitation status change callback
addObserver
Add event observer
removeObserver
Remove event observer
inviteUsers
Invite users
cancelInvitation
Cancel invitation
accept
Accept invitation
reject
Reject invitation
getInvitationList
Get invitation list
StructType
FuncList
DESC
Invitation
Invitation information structure
EnumType
EnumType
DESC
InvitationStatus
Invitation status
InvitationCode
Invitation error code enumeration
RejectedReason
Invitation rejected reason enumeration
onReceiveInvitation
onReceiveInvitation
void onReceiveInvitation
(TUIRoomDefine.﻿RoomInfo﻿ roomInfo
﻿
﻿Invitation﻿ invitation
﻿
String extensionInfo)
Receive invitation callbackParam
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 callbackParam
DESC
accepted
Whether the invitation has been accepted.
roomInfo
Room information.
onInvitationCancelled
onInvitationCancelled
void onInvitationCancelled
(TUIRoomDefine.﻿RoomInfo﻿ roomInfo
﻿
﻿Invitation﻿ invitation)
Invitation has been cancelled callbackParam
DESC
invitation
Invitation information.
roomInfo
Room information.
onInvitationAccepted
onInvitationAccepted
void onInvitationAccepted
(TUIRoomDefine.﻿RoomInfo﻿ roomInfo
﻿
﻿Invitation﻿ invitation)
Invitation has been accepted callbackParam
DESC
invitation
Invitation information.
roomInfo
Room information.
onInvitationRejected
onInvitationRejected
void onInvitationRejected
(TUIRoomDefine.﻿RoomInfo﻿ roomInfo
﻿
﻿Invitation﻿ invitation
﻿
﻿RejectedReason﻿ reason)
Invitation has been rejected callbackParam
DESC
invitation
Invitation information.
reason
Reason for rejection.
roomInfo
Room information.
onInvitationTimeout
onInvitationTimeout
void onInvitationTimeout
(TUIRoomDefine.﻿RoomInfo﻿ roomInfo
﻿
﻿Invitation﻿ invitation)
Invitation timeout callbackParam
DESC
invitation
Invitation information.
roomInfo
Room information.
onInvitationRevokedByAdmin
onInvitationRevokedByAdmin
void onInvitationRevokedByAdmin
(TUIRoomDefine.﻿RoomInfo﻿ roomInfo
﻿
﻿Invitation﻿ invitation
﻿
TUIRoomDefine.﻿UserInfo﻿ admin)
Invitation revoked by admin callbackParam
DESC
admin
Admin information.
invitation
Invitation information.
roomInfo
Room information.
onInvitationAdded
onInvitationAdded
void onInvitationAdded
(String roomId
﻿
﻿Invitation﻿ invitation)
Invitation has been added callbackParam
DESC
invitation
Invitation information.
roomId
Room ID.
onInvitationRemoved
onInvitationRemoved
void onInvitationRemoved
(String roomId
﻿
﻿Invitation﻿ invitation)
Invitation has been removed callbackParam
DESC
invitation
Invitation information.
roomId
Room ID.
onInvitationStatusChanged
onInvitationStatusChanged
void onInvitationStatusChanged
(String roomId
﻿
﻿Invitation﻿ invitation)
Invitation status change callbackParam
DESC
invitation
Invitation information.
roomId
Room ID.
addObserver
addObserver
void addObserver
(Observer observer)
Add event observerParam
DESC
observer
Instance being observed to.
removeObserver
removeObserver
void removeObserver
(Observer observer)
Remove event observerParam
DESC
observer
Instance being observed to.
inviteUsers
inviteUsers
void inviteUsers
(String roomId
﻿
List<String> userIdList
﻿
int timeout
﻿
String extensionInfo
﻿
InviteUsersCallback callback)
Invite usersParam
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 invitationParam
DESC
roomId
Room ID.
userIdList
List of user IDs.
accept
accept
void accept
(String roomId
﻿
TUIRoomDefine.ActionCallback callback)
Accept invitationParam
DESC
roomId
Room ID.
reject
reject
void reject
(String roomId
﻿
﻿RejectedReason﻿ reason
﻿
TUIRoomDefine.ActionCallback callback)
Reject invitationParam
DESC
reason
Reason for rejection.
roomId
Room ID.
getInvitationList
getInvitationList
void getInvitationList
(String roomId
﻿
String cursor
﻿
int count
﻿
GetInvitationListCallback callback)
Get invitation listParam
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 statusEnum
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 enumerationEnum
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 enumerationEnum
Value
DESC
REJECT_TO_ENTER
0
Reject to enter.
IN_OTHER_CONFERENCE
1
In other conference.
TUIInvitation
TUIInvitation
Invitation information structureEnumType
DESC
invitee
Information of the invitee.
inviter
Information of the inviter.
status
Invitation status.

void onInvitationRejected	(TUIRoomDefine.RoomInfo roomInfo
	Invitation invitation
	RejectedReason reason)

void onInvitationRevokedByAdmin	(TUIRoomDefine.RoomInfo roomInfo
	Invitation invitation
	TUIRoomDefine.UserInfo admin)

FuncList	DESC
onReceiveInvitation	Receive invitation callback
onInvitationHandledByOtherDevice	Invitation has been handled on another device callback
onInvitationCancelled	Invitation has been cancelled callback
onInvitationAccepted	Invitation has been accepted callback
onInvitationRejected	Invitation has been rejected callback
onInvitationTimeout	Invitation timeout callback
onInvitationRevokedByAdmin	Invitation revoked by admin callback
onInvitationAdded	Invitation has been added callback
onInvitationRemoved	Invitation has been removed callback
onInvitationStatusChanged	Invitation status change callback
addObserver	Add event observer
removeObserver	Remove event observer
inviteUsers	Invite users
cancelInvitation	Cancel invitation
accept	Accept invitation
reject	Reject invitation
getInvitationList	Get invitation list

EnumType	DESC
InvitationStatus	Invitation status
InvitationCode	Invitation error code enumeration
RejectedReason	Invitation rejected reason enumeration

void onReceiveInvitation	(TUIRoomDefine.RoomInfo roomInfo
	Invitation invitation
	String extensionInfo)

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

void onInvitationHandledByOtherDevice	(TUIRoomDefine.RoomInfo roomInfo
	boolean accepted)

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

void onInvitationCancelled	(TUIRoomDefine.RoomInfo roomInfo
	Invitation invitation)

void onInvitationAccepted	(TUIRoomDefine.RoomInfo roomInfo
	Invitation invitation)

void onInvitationTimeout	(TUIRoomDefine.RoomInfo roomInfo
	Invitation invitation)

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

void onInvitationRemoved	(String roomId
	Invitation invitation)

void onInvitationStatusChanged	(String roomId
	Invitation invitation)

void inviteUsers	(String roomId
	List<String> userIdList
	int timeout
	String extensionInfo
	InviteUsersCallback callback)

void cancelInvitation	(String roomId
	List<String> userIdList
	TUIRoomDefine.ActionCallback callback)

void accept	(String roomId
	TUIRoomDefine.ActionCallback callback)

void reject	(String roomId
	RejectedReason reason
	TUIRoomDefine.ActionCallback callback)

void getInvitationList	(String roomId
	String cursor
	int count
	GetInvitationListCallback callback)

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.

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

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