TUIConferenceInvitationManager
Copyright (c) 2024 Tencent. All rights reserved.
Module: TUIConferenceInvitationManager @ TUIKitEngine
Function: Conference invitation APIS.
TUIConferenceInvitationManager
TUIConferenceInvitationObserver
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 |
TUIConferenceInvitationManager
FuncList | DESC |
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:invitation:extensionInfo:
onReceiveInvitation:invitation:extensionInfo:
- (void)onReceiveInvitation: | |
invitation: | |
extensionInfo: | (NSString *)extensionInfo |
Receive invitation callback
Param | DESC |
extensionInfo | Extension information. |
invitation | Invitation information. |
roomInfo | Room information. |
onInvitationHandledByOtherDevice:accepted:
onInvitationHandledByOtherDevice:accepted:
- (void)onInvitationHandledByOtherDevice: | |
accepted: | (BOOL)accepted |
Invitation has been handled on another device callback
Param | DESC |
accepted | Whether the invitation has been accepted. |
roomInfo | Room information. |
onInvitationCancelled:invitation:
onInvitationCancelled:invitation:
- (void)onInvitationCancelled: | |
invitation: |
Invitation has been cancelled callback
Param | DESC |
invitation | Invitation information. |
roomInfo | Room information. |
onInvitationAccepted:invitation:
onInvitationAccepted:invitation:
- (void)onInvitationAccepted: | |
invitation: |
Invitation has been accepted callback
Param | DESC |
invitation | Invitation information. |
roomInfo | Room information. |
onInvitationRejected:invitation:reason:
onInvitationRejected:invitation:reason:
- (void)onInvitationRejected: | |
invitation: | |
reason: |
Invitation has been rejected callback
Param | DESC |
invitation | Invitation information. |
reason | Reason for rejection. |
roomInfo | Room information. |
onInvitationTimeout:invitation:
onInvitationTimeout:invitation:
- (void)onInvitationTimeout: | |
invitation: |
Invitation timeout callback
Param | DESC |
invitation | Invitation information. |
roomInfo | Room information. |
onInvitationRevokedByAdmin:invitation:admin:
onInvitationRevokedByAdmin:invitation:admin:
- (void)onInvitationRevokedByAdmin: | |
invitation: | |
admin: |
Invitation revoked by admin callback
Param | DESC |
admin | Admin information. |
invitation | Invitation information. |
roomInfo | Room information. |
onInvitationAdded:invitation:
onInvitationAdded:invitation:
- (void)onInvitationAdded: | (NSString *)roomId |
invitation: |
Invitation has been added callback
Param | DESC |
invitation | Invitation information. |
roomId | Room ID. |
onInvitationRemoved:invitation:
onInvitationRemoved:invitation:
- (void)onInvitationRemoved: | (NSString *)roomId |
invitation: |
Invitation has been removed callback
Param | DESC |
invitation | Invitation information. |
roomId | Room ID. |
onInvitationStatusChanged:invitation:
onInvitationStatusChanged:invitation:
- (void)onInvitationStatusChanged: | (NSString *)roomId |
invitation: |
Invitation status change callback
Param | DESC |
invitation | Invitation information. |
roomId | Room ID. |
addObserver:
addObserver:
- (void)addObserver: |
Add event observer
Param | DESC |
observer | Instance being observed to. |
removeObserver:
removeObserver:
- (void)removeObserver: |
Remove event observer
Param | DESC |
observer | Instance being observed to. |
inviteUsers:userIdList:timeout:extensionInfo:onSuccess:onError:
inviteUsers:userIdList:timeout:extensionInfo:onSuccess:onError:
- (void)inviteUsers: | (NSString *)roomId |
userIdList: | (NSArray<NSString *> *)userIdList |
timeout: | (NSTimeInterval)timeout |
extensionInfo: | (NSString*)extensionInfo |
onSuccess: | (TUIInviteUsersResponseBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Invite users
Param | DESC |
extensionInfo | Extension information. |
roomId | Room ID. |
timeout | Timeout duration. |
userIdList | List of user IDs. |
cancelInvitation:userIdList:onSuccess:onError:
cancelInvitation:userIdList:onSuccess:onError:
- (void)cancelInvitation: | (NSString *)roomId |
userIdList: | (NSArray<NSString *> *)userIdList |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Cancel invitation
Param | DESC |
roomId | Room ID. |
userIdList | List of user IDs. |
accept:onSuccess:onError:
accept:onSuccess:onError:
- (void)accept: | (NSString *)roomId |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Accept invitation
Param | DESC |
roomId | Room ID. |
reject:reason:onSuccess:onError:
reject:reason:onSuccess:onError:
- (void)reject: | (NSString *)roomId |
reason: | |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Reject invitation
Param | DESC |
reason | Reason for rejection. |
roomId | Room ID. |
getInvitationList:cursor:count:onSuccess:onError:
getInvitationList:cursor:count:onSuccess:onError:
- (void)getInvitationList: | (NSString *)roomId |
cursor: | (NSString *)cursor |
count: | (NSInteger)count |
onSuccess: | (TUIInvitationListResponseBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
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 |
TUIInvitationStatusNone | 0 | None status. |
TUIInvitationStatusPending | 1 | Pending status. |
TUIInvitationStatusTimeout | 2 | Timeout status. |
TUIInvitationStatusAccepted | 3 | Accepted status. |
TUIInvitationStatusRejected | 4 | Rejected status. |
TUIInvitationCode
TUIInvitationCode
Invitation error code enumeration
Enum | Value | DESC |
TUIInvitationCodeSuccess | 0 | Invitation successful. |
TUIInvitationCodeAlreadyInInvitationList | 1 | The current user is already in the invitation list. |
TUIInvitationCodeAlreadyInConference | 2 | The current user is already in the conference. |
TUIInvitationRejectedReason
TUIInvitationRejectedReason
Invitation rejected reason enumeration
Enum | Value | DESC |
TUIInvitationRejectedReasonRejectToEnter | 0 | Reject to enter. |
TUIInvitationRejectedReasonInOtherConference | 1 | In other conference. |
TUIInvitation
TUIInvitation
Invitation information structure
EnumType | DESC |
invitee | Information of the invitee. |
inviter | Information of the inviter. |
status | Invitation status. |
- TUIConferenceInvitationObserver
- TUIConferenceInvitationManager
- StructType
- EnumType
- onReceiveInvitation:invitation:extensionInfo:
- onInvitationHandledByOtherDevice:accepted:
- onInvitationCancelled:invitation:
- onInvitationAccepted:invitation:
- onInvitationRejected:invitation:reason:
- onInvitationTimeout:invitation:
- onInvitationRevokedByAdmin:invitation:admin:
- onInvitationAdded:invitation:
- onInvitationRemoved:invitation:
- onInvitationStatusChanged:invitation:
- addObserver:
- removeObserver:
- inviteUsers:userIdList:timeout:extensionInfo:onSuccess:onError:
- cancelInvitation:userIdList:onSuccess:onError:
- accept:onSuccess:onError:
- reject:reason:onSuccess:onError:
- getInvitationList:cursor:count:onSuccess:onError:
- TUIInvitationStatus
- TUIInvitationCode
- TUIInvitationRejectedReason
- TUIInvitation