TUIConferenceInvitationManager 简介
会中邀请相关接口,此页面中的函数仅支持会议房间类型。
TUIConferenceInvitationManager
函数列表 | 描述 |
收到邀请回调 | |
邀请已在其他设备被处理回调 | |
邀请被取消回调 | |
邀请被接受回调 | |
邀请被拒绝回调 | |
邀请超时回调 | |
邀请被管理员/房主撤销回调 | |
新增邀请回调 | |
邀请被移除回调 | |
邀请状态变更回调 | |
邀请成员 | |
取消邀请 | |
接受邀请 | |
拒绝邀请 | |
拉取邀请列表 |
结构体类型
函数列表 | 描述 |
邀请信息结构体 |
枚举类型
枚举类型 | 描述 |
邀请状态 | |
邀请错误码枚举 | |
邀请拒绝原因枚举 |
onReceiveInvitation
收到邀请回调
const roomEngine = new TUIRoomEngine();const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onReceiveInvitation, (data: {roomInfo: TUIRoomInfo;invitation: TUIInvitation;extensionInfo: string;}) => {console.log('conferenceInvitationManager.onReceiveInvitation', data);})
参数 | 描述 |
roomInfo | 房间信息。 |
邀请信息。 | |
extensionInfo | 扩展信息。 |
onInvitationHandledByOtherDevice
邀请已在其他设备被处理回调
const roomEngine = new TUIRoomEngine();const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationHandledByOtherDevice, (data: {roomInfo: TUIRoomInfo;accepted: boolean;}) => {console.log('conferenceInvitationManager.onInvitationHandledByOtherDevice', data);})
参数 | 描述 |
roomInfo | 房间信息。 |
accepted | 邀请是否被接受。 |
onInvitationCancelled
邀请被取消回调
const roomEngine = new TUIRoomEngine();const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationCancelled, (data: {roomInfo: TUIRoomInfo;invitation: TUIInvitation;}) => {console.log('conferenceInvitationManager.onInvitationCancelled', data);})
参数 | 描述 |
roomInfo | 房间信息。 |
邀请信息。 |
onInvitationAccepted
邀请被接受回调
const roomEngine = new TUIRoomEngine();const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationAccepted, (data: {roomInfo: TUIRoomInfo;invitation: TUIInvitation;}) => {console.log('conferenceInvitationManager.onInvitationAccepted', data);})
参数 | 描述 |
roomInfo | 房间信息。 |
邀请信息。 |
onInvitationRejected
邀请被拒绝回调
const roomEngine = new TUIRoomEngine();const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRejected, (data: {roomInfo: TUIRoomInfo;invitation: TUIInvitation;reason: TUIInvitationRejectedReason;}) => {console.log('conferenceInvitationManager.onInvitationAccepted', data);})
参数 | 描述 |
roomInfo | 房间信息。 |
邀请信息。 | |
拒绝原因。 |
onInvitationTimeout
邀请超时回调
const roomEngine = new TUIRoomEngine();const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationTimeout, (data: {roomInfo: TUIRoomInfo;invitation: TUIInvitation;}) => {console.log('conferenceInvitationManager.onInvitationTimeout', data);})
参数 | 描述 |
roomInfo | 房间信息。 |
邀请信息。 |
onInvitationRevokedByAdmin
邀请被管理员/房主撤销回调
const roomEngine = new TUIRoomEngine();const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRevokedByAdmin, (data: {roomInfo: TUIRoomInfo;invitation: TUIInvitation;}) => {console.log('conferenceInvitationManager.onInvitationRevokedByAdmin', data);})
参数 | 描述 |
roomInfo | 房间信息。 |
邀请信息。 |
onInvitationAdded
新增邀请回调
const roomEngine = new TUIRoomEngine();const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationAdded, (data: {roomInfo: TUIRoomInfo;invitation: TUIInvitation;}) => {console.log('conferenceInvitationManager.onInvitationAdded', data);})
参数 | 描述 |
roomInfo | 房间信息。 |
邀请信息。 |
onInvitationRemoved
邀请被移除回调
const roomEngine = new TUIRoomEngine();const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRemoved, (data: {roomId: string;invitation: TUIInvitation;}) => {console.log('conferenceInvitationManager.onInvitationRemoved', data);})
参数 | 描述 |
roomId | 房间 ID。 |
邀请信息。 |
onInvitationStatusChanged
邀请状态变更回调
const roomEngine = new TUIRoomEngine();const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationStatusChanged, (data: {roomId: string;invitation: TUIInvitation;}) => {console.log('conferenceInvitationManager.onInvitationStatusChanged', data);})
参数 | 描述 |
roomInfo | 房间信息。 |
邀请信息。 |
inviteUsers
邀请成员
const roomEngine = new TUIRoomEngine();const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();await conferenceInvitationManager.inviteUsers({roomId: '12345',timeout: 60,userIdList,extensionInfo})
参数 | 类型 | 说明 | 默认 | 含义 |
roomId | string | 必填 | - | 房间 ID,roomId 限制长度为64字节,且仅支持以下范围的字符集: 大小写英文字母(a-zA-Z) 数字(0-9) 空格 ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ , |
timeout | number | 非必填 | 0 | 超时时间。 |
userIdList | Array | 必填 | [] | 成员 userId 列表。 |
extensionInfo | string | 非必填 | '' | 扩展信息。 |
cancelInvitation
取消邀请
const roomEngine = new TUIRoomEngine();const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();await conferenceInvitationManager.cancelInvitation({roomId: '12345';userIdList})
参数 | 类型 | 说明 | 默认 | 含义 |
roomId | string | 必填 | - | 房间 ID,roomId 限制长度为64字节,且仅支持以下范围的字符集: 大小写英文字母(a-zA-Z) 数字(0-9) 空格 ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ , |
userIdList | Array | 必填 | [] | 成员 userId 列表。 |
accept
接受邀请
const roomEngine = new TUIRoomEngine();const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();await conferenceInvitationManager.accept({roomId: '12345';})
参数 | 类型 | 说明 | 默认 | 含义 |
roomId | string | 必填 | - | 房间 ID,roomId 限制长度为64字节,且仅支持以下范围的字符集: 大小写英文字母(a-zA-Z) 数字(0-9) 空格 ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ , |
reject
拒绝邀请
const roomEngine = new TUIRoomEngine();const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();await conferenceInvitationManager.reject({roomId: '12345';})
参数 | 类型 | 说明 | 默认 | 含义 |
roomId | string | 必填 | - | 房间 ID,roomId 限制长度为64字节,且仅支持以下范围的字符集: 大小写英文字母(a-zA-Z) 数字(0-9) 空格 ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ , |
getInvitationList
拉取邀请列表
const roomEngine = new TUIRoomEngine();const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();await conferenceInvitationManager.reject({roomId: '12345';cursor: '';count: 10;})
参数 | 类型 | 说明 | 默认 | 含义 |
roomId | string | 必填 | - | 房间 ID,roomId 限制长度为64字节,且仅支持以下范围的字符集: 大小写英文字母(a-zA-Z) 数字(0-9) 空格 ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ , |
cursor | string | 必填 | '' | 分页获取索引,第一次拉取填 "",回调成功 如果callback返回的数据中 cursor 不为"",表示需要分页,请以返回的cursor作为参数再次调用接口拉取,直至返回的cursor为"",表示数据已经全部拉取。 |
count | number | 必填 | 0 | 本次拉取数量。 |
TUIInvitationStatus
邀请状态
枚举 | 取值 | 描述 |
NONE | 0 | 未知状态。 |
PENDING | 1 | 待处理状态。 |
TIMEOUT | 2 | 超时状态。 |
ACCEPTED | 3 | 已接受状态。 |
REJECTED | 4 | 被拒绝状态。 |
TUIInvitationCode
邀请错误码枚举
枚举 | 取值 | 描述 |
SUCCESS | 0 | 邀请成功。 |
ALREADY_IN_INVITATION_LIST | 1 | 当前用户已在邀请列表。 |
ALREADY_IN_CONFERENCE | 2 | 当前用户已在房间内。 |
TUIInvitationRejectedReason
邀请拒绝原因枚举
枚举 | 取值 | 描述 |
REJECT_TO_ENTER | 0 | 拒绝进入。 |
IN_OTHER_CONFERENCE | 1 | 在其他会议中。 |
TUIInvitation
邀请信息结构体
枚举类型 | 描述 |
invitee | 被邀请者信息。 |
inviter | 邀请者信息。 |
status | 邀请状态。 |