请求事件
与请求相关的系列事件。
RequestEvent
api.request UserInfoContainer
请求事件 的基础父类接口。
属性 | 类型 | 描述 |
---|---|---|
message | String? | 一个申请事件可能会存在附加的文本消息 。 |
requester | UserInfo | 此申请事件的申请人 。 对于一个申请者不能保证可以作为完全的 User 使用,因此类型仅保留为 UserInfo ,即仅提供此用户的基础信息获取能力。在一些申请人为 Bot 自身的情况时(比如bot被邀请)此属性值可能与 bot 属性相同或类似。 |
user | 同上 | 同上 |
type | RequestEvent.Type | 申请类型 |
API | 返回值 | 描述 |
---|---|---|
accept() | Boolean | 同意/接受 此请求 。 |
reject() | Boolean | 拒绝此请求 。 |
提示
在api中,所有的api在Java中的表现都会在名称后追加 "Blocking"
后缀。例如 accept()
在Java中表现为 acceptBlocking()
。
RequestEvent.Type
枚举类型,代表当前请求事件的类型。
元素 | 描述 |
---|---|
APPLICATION | 主动的申请。 |
INVITATION | 被动的申请(例如被邀请)。 |
- Kotlin
- Java
val message: String = event.message
val requester: UserInfo = event.requester()
val user: UserInfo = event.user()
val type: RequestEvent.Type = event.type
//
val isAccpeted: Boolean = event.accept()
val isRejected: Boolean = event.reject()
String message = event.getMessage();
UserInfo requester = event.getRequester();
UserInfo user = event.getUser();
RequestEvent.Type type = event.getType();
//
boolean isAccpeted = event.acceptBlocking();
boolean isRejected = event.rejectBlocking();
JoinRequestEvent
api.join_request RequestEvent
RequestEvent
的子类型,泛指一个可以表示为 加入/添加申请 的请求事件。常见于入群申请、好友添加申请等场景。
属性 | 类型 | 描述 |
---|---|---|
inviter | UserInfo? | 本次添加申请人的邀请人。只有在组件支持识别邀请人并且实际存在邀请人的时候才会存在,否则为null。 |
GuildRequestEvent
api.guild_request RequestEvent GuildInfoContainer
与 频道服务器 相关的请求事件。
GuildJoinRequestEvent
api.guild_join_request JoinRequestEvent GuildRequestEvent
与 加入频道服务器 相关的请求事件。
GroupRequestEvent
api.group_request RequestEvent GroupInfoContainer
与 群 相关的请求事件。
GroupJoinRequestEvent
api.group_join_request GroupRequestEvent JoinRequestEvent
与 加入群 相关的请求事件。
ChannelRequestEvent
api.channel_request RequestEvent ChannelInfoContainer
与 子频道 相关的请求事件。
UserRequestEvent
api.user_request RequestEvent UserInfoContainer
与 用户 相关的请求事件。
FriendRequestEvent
api.friend_request UserRequestEvent FriendInfoContainer
与 好友 相关的请求事件。此事件中涉及到的 requester
或其他属性可能并非 Firend
对象。
FriendAddRequestEvent
api.friend_add_request JoinRequestEvent FriendRequestEvent
与 好友添加 相关的请求事件。此事件代表其他人想要申请成为当前bot的好友, 因此此用户此时并非好友。