Copyright (c) 2024 Tencent. All rights reserved.
Module: TUIConferenceInvitationManager @ TUIKitEngine
TUIConferenceInvitationManager
TUIConferenceInvitationObserver
函数列表 | 描述 |
收到邀请回调 | |
邀请已在其他设备被处理回调 | |
邀请被取消回调 | |
邀请被接受回调 | |
邀请被拒绝回调 | |
邀请超时回调 | |
邀请被管理员/房主撤销回调 | |
新增邀请回调 | |
邀请被移除回调 | |
邀请状态变更回调 |
TUIConferenceInvitationManager
结构体类型
函数列表 | 描述 |
邀请信息结构体 |
枚举类型
枚举类型 | 描述 |
邀请状态 | |
邀请错误码枚举 | |
邀请拒绝原因枚举 |
onReceiveInvitation:invitation:extensionInfo:
onReceiveInvitation:invitation:extensionInfo:
- (void)onReceiveInvitation: | |
invitation: | |
extensionInfo: | (NSString *)extensionInfo |
收到邀请回调
参数 | 描述 |
extensionInfo | 扩展信息。 |
invitation | 邀请信息。 |
roomInfo | 房间信息。 |
onInvitationHandledByOtherDevice:accepted:
onInvitationHandledByOtherDevice:accepted:
- (void)onInvitationHandledByOtherDevice: | |
accepted: | (BOOL)accepted |
邀请已在其他设备被处理回调
参数 | 描述 |
accepted | 邀请是否被接受。 |
roomInfo | 房间信息。 |
onInvitationCancelled:invitation:
onInvitationCancelled:invitation:
- (void)onInvitationCancelled: | |
invitation: |
邀请被取消回调
参数 | 描述 |
invitation | 邀请信息。 |
roomInfo | 房间信息。 |
onInvitationAccepted:invitation:
onInvitationAccepted:invitation:
- (void)onInvitationAccepted: | |
invitation: |
邀请被接受回调
参数 | 描述 |
invitation | 邀请信息。 |
roomInfo | 房间信息。 |
onInvitationRejected:invitation:reason:
onInvitationRejected:invitation:reason:
- (void)onInvitationRejected: | |
invitation: | |
reason: |
邀请被拒绝回调
参数 | 描述 |
invitation | 邀请信息。 |
reason | 拒绝原因。 |
roomInfo | 房间信息。 |
onInvitationTimeout:invitation:
onInvitationTimeout:invitation:
- (void)onInvitationTimeout: | |
invitation: |
邀请超时回调
参数 | 描述 |
invitation | 邀请信息。 |
roomInfo | 房间信息。 |
onInvitationRevokedByAdmin:invitation:admin:
onInvitationRevokedByAdmin:invitation:admin:
- (void)onInvitationRevokedByAdmin: | |
invitation: | |
admin: |
邀请被管理员/房主撤销回调
参数 | 描述 |
admin | 管理员/房主信息。 |
invitation | 邀请信息。 |
roomInfo | 房间信息。 |
onInvitationAdded:invitation:
onInvitationAdded:invitation:
- (void)onInvitationAdded: | (NSString *)roomId |
invitation: |
新增邀请回调
参数 | 描述 |
invitation | 邀请信息。 |
roomId | 房间Id。 |
onInvitationRemoved:invitation:
onInvitationRemoved:invitation:
- (void)onInvitationRemoved: | (NSString *)roomId |
invitation: |
邀请被移除回调
参数 | 描述 |
invitation | 邀请信息。 |
roomId | 房间Id。 |
onInvitationStatusChanged:invitation:
onInvitationStatusChanged:invitation:
- (void)onInvitationStatusChanged: | (NSString *)roomId |
invitation: |
邀请状态变更回调
参数 | 描述 |
invitation | 邀请信息。 |
roomId | 房间Id。 |
addObserver:
addObserver:
- (void)addObserver: |
添加事件回调
参数 | 描述 |
observer | 监听的实例。 |
removeObserver:
removeObserver:
- (void)removeObserver: |
移除事件回调
参数 | 描述 |
observer | 监听的实例。 |
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 |
邀请成员
参数 | 描述 |
extensionInfo | 扩展信息。 |
roomId | 房间Id。 |
timeout | 超时时间。 |
userIdList | 成员userId列表。 |
cancelInvitation:userIdList:onSuccess:onError:
cancelInvitation:userIdList:onSuccess:onError:
- (void)cancelInvitation: | (NSString *)roomId |
userIdList: | (NSArray<NSString *> *)userIdList |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
取消邀请
参数 | 描述 |
roomId | 房间Id。 |
userIdList | 成员userId列表。 |
accept:onSuccess:onError:
accept:onSuccess:onError:
- (void)accept: | (NSString *)roomId |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
接受邀请
参数 | 描述 |
roomId | 房间Id。 |
reject:reason:onSuccess:onError:
reject:reason:onSuccess:onError:
- (void)reject: | (NSString *)roomId |
reason: | |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
拒绝邀请
参数 | 描述 |
reason | 拒绝原因。 |
roomId | 房间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 |
拉取邀请列表
参数 | 描述 |
count | 本次拉取数量。 |
cursor | 分页获取索引,第一次拉取填 "",回调成功 如果callback返回的数据中 cursor 不为"",表示需要分页,请以返回的cursor作为参数再次调用接口拉取,直至返回的cursor为"",表示数据已经全部拉取。 |
roomId | 房间Id。 |
TUIInvitationStatus
TUIInvitationStatus
邀请状态
枚举 | 取值 | 描述 |
TUIInvitationStatusNone | 0 | 未知状态。 |
TUIInvitationStatusPending | 1 | 待处理状态。 |
TUIInvitationStatusTimeout | 2 | 超时状态。 |
TUIInvitationStatusAccepted | 3 | 已接受状态。 |
TUIInvitationStatusRejected | 4 | 被拒绝状态。 |
TUIInvitationCode
TUIInvitationCode
邀请错误码枚举
枚举 | 取值 | 描述 |
TUIInvitationCodeSuccess | 0 | 邀请成功。 |
TUIInvitationCodeAlreadyInInvitationList | 1 | 当前用户已在邀请列表。 |
TUIInvitationCodeAlreadyInConference | 2 | 当前用户已在房间内。 |
TUIInvitationRejectedReason
TUIInvitationRejectedReason
邀请拒绝原因枚举
枚举 | 取值 | 描述 |
TUIInvitationRejectedReasonRejectToEnter | 0 | 拒绝进入。 |
TUIInvitationRejectedReasonInOtherConference | 1 | 在其他会议中。 |
TUIInvitation
TUIInvitation
邀请信息结构体
枚举类型 | 描述 |
invitee | 被邀请者信息。 |
inviter | 邀请者信息。 |
status | 邀请状态。 |