- Release Notes and Announcements
- Release Notes
- TRTC Live (TUILiveKit) Product Launch Announcement
- TRTC Conference Official Editions Launched
- The commercial version of Conference is coming soon
- Terms and Conditions Applicable to $9.9 Starter Package
- Rules for the "First Subscription $100 Discount" Promotion
- Announcement on the Start of Beta Testing for Multi-person Audio and Video Conference
- TRTC Call Official Editions Launched
- License Required for Video Playback in New Version of LiteAV SDK
- TRTC to Offer Monthly Packages
- Product Introduction
- Purchase Guide
- User Tutorial
- Free Demo
- Video Calling (Including UI)
- Overview (TUICallKit)
- Activate the Service（TUICallKit）
- Run Demo（TUICallKit）
- Integration (TUICallKit)
- UI Customization (TUICallKit)
- Offline Call Push (TUICallKit)
- AI Noise Reduction (TUICallKit)
- Virtual Background (TUICallKit)
- On-Cloud Recording (TUICallKit)
- Additional Features（TUICallKit）
- Solution (TUICallKit)
- Server APIs (TUICallKit)
- Client APIs (TUICallKit)
- ErrorCode(TUICallKit)
- Release Notes (TUICallKit)
- FAQs(TUICallKit)
- Multi-Participant Conference (with UI)
- Overview（TUIRoomKit）
- Activate the Service (TUIRoomKit)
- Run Demo（TUIRoomKit）
- Integration（TUIRoomKit）
- Schedule a meeting (TUIRoomKit)
- UI Customization（TUIRoomKit）
- Virtual Background (TUIRoomKit)
- Conference Control (TUIRoomKit)
- Cloud Recording (TUIRoomKit)
- AI Noise Reduction (TUIRoomKit)
- In-Conference Chat (TUIRoomKit)
- Robot Streaming (TUIRoomKit)
- Enhanced Features (TUIRoomKit)
- Client APIs (TUIRoomKit)
- Server APIs (TUIRoomKit)
- FAQs (TUIRoomKit)
- Error Code (TUIRoomKit)
- SDK Update Log (TUIRoomKit)
- Live Streaming (Including UI)
- Overview (TUILiveKit)
- Activating the Service (TUILiveKit)
- Run Demo（TUILiveKit）
- Integration (TUILiveKit)
- Customizable Interface (TUILiveKit)
- Room List (TUILiveKit)
- Follow Anchors (TUILiveKit)
- Anchor connection (TUILiveKit)
- Host Competition (TUILiveKit)
- Mic Connect (TUILiveKit)
- Interactive Bullet Comments (TUILiveKit)
- Interactive Gifts (TUILiveKit)
- Gift Effects (TUILiveKit)
- Beauty Effects (TUILiveKit)
- Client APIs (TUICallKit)
- Server APIs (TUILiveKit)
- Error Codes (TUILiveKit)
- Release Notes（TUILiveKit）
- FAQs（TUILiveKit）
- Voice Chat Room (with UI)
- Overview (TUILiveKit)
- Activating the Service (TUILiveKit)
- Run Demo（TUILiveKit）
- Integration (TUILiveKit)
- Room List (TUILiveKit)
- Follow Anchors (TUILiveKit)
- Interactive Bullet Comments (TUILiveKit)
- Interactive Gifts (TUILiveKit)
- Gift Effects (TUILiveKit)
- Client APIs (TUICallKit)
- Server APIs (TUILiveKit)
- Error Codes (TUILiveKit)
- Release Notes（TUILiveKit）
- FAQs（TUILiveKit）
- Integration (No UI)
- SDK Download
- API Examples
- API Usage Guidelines
- API Reference Manual
- Advanced Features
- Relay to CDN
- Enabling Advanced Permission Control
- Push Media Stream into TRTC
- Testing Hardware Devices
- Testing Network Quality
- On-Cloud Recording
- Custom Capturing and Rendering
- Custom Audio Capturing and Playback
- Sending and Receiving Messages
- Event Callbacks
- Access Management
- Enable Watermark
- How to push stream to TRTC room with OBS WHIP
- Server APIs
- Console Guide
- Solution
- FAQs
- Legacy Documentation
- Protocols and Policies
- TRTC Policy
- Glossary
- Release Notes and Announcements
- Release Notes
- TRTC Live (TUILiveKit) Product Launch Announcement
- TRTC Conference Official Editions Launched
- The commercial version of Conference is coming soon
- Terms and Conditions Applicable to $9.9 Starter Package
- Rules for the "First Subscription $100 Discount" Promotion
- Announcement on the Start of Beta Testing for Multi-person Audio and Video Conference
- TRTC Call Official Editions Launched
- License Required for Video Playback in New Version of LiteAV SDK
- TRTC to Offer Monthly Packages
- Product Introduction
- Purchase Guide
- User Tutorial
- Free Demo
- Video Calling (Including UI)
- Overview (TUICallKit)
- Activate the Service（TUICallKit）
- Run Demo（TUICallKit）
- Integration (TUICallKit)
- UI Customization (TUICallKit)
- Offline Call Push (TUICallKit)
- AI Noise Reduction (TUICallKit)
- Virtual Background (TUICallKit)
- On-Cloud Recording (TUICallKit)
- Additional Features（TUICallKit）
- Solution (TUICallKit)
- Server APIs (TUICallKit)
- Client APIs (TUICallKit)
- ErrorCode(TUICallKit)
- Release Notes (TUICallKit)
- FAQs(TUICallKit)
- Multi-Participant Conference (with UI)
- Overview（TUIRoomKit）
- Activate the Service (TUIRoomKit)
- Run Demo（TUIRoomKit）
- Integration（TUIRoomKit）
- Schedule a meeting (TUIRoomKit)
- UI Customization（TUIRoomKit）
- Virtual Background (TUIRoomKit)
- Conference Control (TUIRoomKit)
- Cloud Recording (TUIRoomKit)
- AI Noise Reduction (TUIRoomKit)
- In-Conference Chat (TUIRoomKit)
- Robot Streaming (TUIRoomKit)
- Enhanced Features (TUIRoomKit)
- Client APIs (TUIRoomKit)
- Server APIs (TUIRoomKit)
- FAQs (TUIRoomKit)
- Error Code (TUIRoomKit)
- SDK Update Log (TUIRoomKit)
- Live Streaming (Including UI)
- Overview (TUILiveKit)
- Activating the Service (TUILiveKit)
- Run Demo（TUILiveKit）
- Integration (TUILiveKit)
- Customizable Interface (TUILiveKit)
- Room List (TUILiveKit)
- Follow Anchors (TUILiveKit)
- Anchor connection (TUILiveKit)
- Host Competition (TUILiveKit)
- Mic Connect (TUILiveKit)
- Interactive Bullet Comments (TUILiveKit)
- Interactive Gifts (TUILiveKit)
- Gift Effects (TUILiveKit)
- Beauty Effects (TUILiveKit)
- Client APIs (TUICallKit)
- Server APIs (TUILiveKit)
- Error Codes (TUILiveKit)
- Release Notes（TUILiveKit）
- FAQs（TUILiveKit）
- Voice Chat Room (with UI)
- Overview (TUILiveKit)
- Activating the Service (TUILiveKit)
- Run Demo（TUILiveKit）
- Integration (TUILiveKit)
- Room List (TUILiveKit)
- Follow Anchors (TUILiveKit)
- Interactive Bullet Comments (TUILiveKit)
- Interactive Gifts (TUILiveKit)
- Gift Effects (TUILiveKit)
- Client APIs (TUICallKit)
- Server APIs (TUILiveKit)
- Error Codes (TUILiveKit)
- Release Notes（TUILiveKit）
- FAQs（TUILiveKit）
- Integration (No UI)
- SDK Download
- API Examples
- API Usage Guidelines
- API Reference Manual
- Advanced Features
- Relay to CDN
- Enabling Advanced Permission Control
- Push Media Stream into TRTC
- Testing Hardware Devices
- Testing Network Quality
- On-Cloud Recording
- Custom Capturing and Rendering
- Custom Audio Capturing and Playback
- Sending and Receiving Messages
- Event Callbacks
- Access Management
- Enable Watermark
- How to push stream to TRTC room with OBS WHIP
- Server APIs
- Console Guide
- Solution
- FAQs
- Legacy Documentation
- Protocols and Policies
- TRTC Policy
- Glossary
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 | |
| |
| String extensionInfo) |
Receive invitation callback
Param | DESC |
extensionInfo | Extension information. |
invitation | Invitation information. |
roomInfo | Room information. |
onInvitationHandledByOtherDevice
onInvitationHandledByOtherDevice
void onInvitationHandledByOtherDevice | |
| 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 | |
|
Invitation has been cancelled callback
Param | DESC |
invitation | Invitation information. |
roomInfo | Room information. |
onInvitationAccepted
onInvitationAccepted
void onInvitationAccepted | |
|
Invitation has been accepted callback
Param | DESC |
invitation | Invitation information. |
roomInfo | Room information. |
onInvitationRejected
onInvitationRejected
void onInvitationRejected | |
| |
|
Invitation has been rejected callback
Param | DESC |
invitation | Invitation information. |
reason | Reason for rejection. |
roomInfo | Room information. |
onInvitationTimeout
onInvitationTimeout
void onInvitationTimeout | |
|
Invitation timeout callback
Param | DESC |
invitation | Invitation information. |
roomInfo | Room information. |
onInvitationRevokedByAdmin
onInvitationRevokedByAdmin
void onInvitationRevokedByAdmin | |
| |
|
Invitation revoked by admin callback
Param | DESC |
admin | Admin information. |
invitation | Invitation information. |
roomInfo | Room information. |
onInvitationAdded
onInvitationAdded
void onInvitationAdded | (String roomId |
|
Invitation has been added callback
Param | DESC |
invitation | Invitation information. |
roomId | Room ID. |
onInvitationRemoved
onInvitationRemoved
void onInvitationRemoved | (String roomId |
|
Invitation has been removed callback
Param | DESC |
invitation | Invitation information. |
roomId | Room ID. |
onInvitationStatusChanged
onInvitationStatusChanged
void onInvitationStatusChanged | (String roomId |
|
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 |
| |
| 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. |
Yes
No
Was this page helpful?