Package-level declarations

Types

Link copied to clipboard

一个 Bot容器. 一般代表可以得到 Bot 的对象,例如非 BotUser,比如 Friend,一个Bot所提供的事件,或者一个BOT所在的组织集会。

Link copied to clipboard
interface Category : IDContainer

一个 类别 。 常表现为"类别"、"分类"、"分组"等含义,默认应用于 UserInfoOrganizationInfo 中。

Link copied to clipboard

一个频道。

Link copied to clipboard

一个频道的信息。

Link copied to clipboard
Link copied to clipboard

一个 聊天室。 聊天室是 组织 的子类型,代表其是一个存在多人且允许相互交流“发送消息”的组织。

Link copied to clipboard

一个联系目标。联系人是除 Bot 以外的可以进行信息交流的 User, 例如 好友, 或者一个群成员

Link copied to clipboard

提供获取 Contact 的容器。

Link copied to clipboard
interface Container

定义一个 容器

Link copied to clipboard

一个 好友

Link copied to clipboard
interface FriendInfo : UserInfo

一个好友基本信息。

Link copied to clipboard
Link copied to clipboard

提供获取 Friend 的容器。

Link copied to clipboard
interface Group : ChatRoom, GroupInfo

一个群。

Link copied to clipboard

一个 Bot 在一个 中所扮演的对象。

Link copied to clipboard

群组信息。

Link copied to clipboard
Link copied to clipboard
interface GroupMember : Member
Link copied to clipboard

提供获取 Group 的容器。

Link copied to clipboard

一个频道服务器,或者说一个集会。

Link copied to clipboard

一个 Bot 在一个 频道服务器 中所扮演的对象。

Link copied to clipboard

频道服务器信息。

Link copied to clipboard
Link copied to clipboard
interface GuildMember : Member

一个频道服务器下的成员。

Link copied to clipboard

提供获取 Guild 的容器。

Link copied to clipboard

一个存在唯一标识的容器。

Link copied to clipboard

一个存在字符串类型唯一标识的容器。

Link copied to clipboard

一个组织下的成员。

Link copied to clipboard
interface MemberInfo : UserInfo

一个成员信息。

Link copied to clipboard
Link copied to clipboard

Objective 是对与 Bot 相关联的对象 (一个组织或一个具体的用户) 的统称。

Link copied to clipboard
interface OrganizationBot : Bot

一个 Bot 在一个 组织 中所扮演的对象。

Link copied to clipboard

一个组织的部分最基础的信息。

Link copied to clipboard
Link copied to clipboard
interface Role : IDContainer

一个组织中的成员"角色"(或称“权限组”、“职责”等等)。

Link copied to clipboard

Category 的最低限度基础实现。

Link copied to clipboard
Link copied to clipboard
interface Stranger : User

陌生人。 一个并非好友或群成员的人。

Link copied to clipboard

标记这是一个可能同时存在 suspend property 和 普通api 的容器。

Link copied to clipboard
interface User : Objective, UserInfo

一个 用户

Link copied to clipboard
interface UserInfo : IDContainer

一个用户的 信息

Link copied to clipboard

Functions

Link copied to clipboard
inline operator fun Category.component1(): ID

提供 Category 的解构扩展。第1个参数,代表 Category.id

inline operator fun OrganizationInfo.component1(): ID

OrganizationInfo 解构扩展。第1个参数,相当于 OrganizationInfo.id

inline operator fun UserInfo.component1(): ID

UserInfo 的结构解构, 第1个值。相当于 UserInfo.id

Link copied to clipboard
inline operator fun Category.component2(): String

提供 Category 的解构扩展。第2个参数,代表 Category.name

inline operator fun OrganizationInfo.component2(): String

OrganizationInfo 解构扩展。第2个参数,相当于 OrganizationInfo.name

inline operator fun UserInfo.component2(): String

UserInfo 的结构解构, 第2个值。相当于 UserInfo.username

Link copied to clipboard
inline operator fun OrganizationInfo.component3(): String

OrganizationInfo 解构扩展。第3个参数,相当于 OrganizationInfo.icon

inline operator fun UserInfo.component3(): String

UserInfo 的结构解构, 第3个值。相当于 UserInfo.avatar

Link copied to clipboard
inline operator fun FriendInfo.component4(): String?

FriendInfo 的解构扩展第4个属性,相当于 FriendInfo.remark

inline operator fun MemberInfo.component4(): String

MemberInfo 属性解构扩展,第4个属性,相当于 MemberInfo.nickname

Link copied to clipboard
inline suspend fun <R> ChannelInfoContainer.inChannelInfo(block: ChannelInfo.() -> R): R

ChannelInfoContainer 中的 channel 作为 block 中的接收者使用。

Link copied to clipboard
inline suspend fun <R> FriendInfoContainer.inFriendInfo(block: FriendInfo.() -> R): R

FriendInfoContainer 中的 friend 作为 block 中的接收者使用。

Link copied to clipboard
inline suspend fun <R> GroupInfoContainer.inGroupInfo(block: GroupInfo.() -> R): R

GroupInfoContainer 中的 group 作为 block 中的接收者使用。

Link copied to clipboard
inline suspend fun <R> GuildInfoContainer.inGuildInfo(block: GuildInfo.() -> R): R

GuildInfoContainer 中的 guild 作为 block 中的接收者使用。

Link copied to clipboard
inline suspend fun <R> MemberInfoContainer.inMemberInfo(block: MemberInfo.() -> R): R

MemberInfoContainer 中的 member 作为 block 中的接收者使用。

Link copied to clipboard
inline suspend fun <R> UserInfoContainer.inUserInfo(block: UserInfo.() -> R): R

UserInfoContainer 中的 user 作为 block 中的接收者使用。

Link copied to clipboard

比较两个 IDContainerIDContainer.id 是否一致。

比较两个 IdValueContainerIdValueContainer.id 是否一致。

Link copied to clipboard
inline suspend fun <R> ChannelInfoContainer.useChannelInfo(block: (ChannelInfo) -> R): R

ChannelInfoContainer 中的 channel 作为 block 中的参数使用。

Link copied to clipboard
inline suspend fun <R> FriendInfoContainer.useFriendInfo(block: (FriendInfo) -> R): R

FriendInfoContainer 中的 friend 作为 block 中的参数使用。

Link copied to clipboard
inline suspend fun <R> GroupInfoContainer.useGroupInfo(block: (GroupInfo) -> R): R

GroupInfoContainer 中的 group 作为 block 中的参数使用。

Link copied to clipboard
inline suspend fun <R> GuildInfoContainer.useGuildInfo(block: (GuildInfo) -> R): R

GuildInfoContainer 中的 guild 作为 block 中的参数使用。

Link copied to clipboard
inline suspend fun <R> MemberInfoContainer.useMemberInfo(block: (MemberInfo) -> R): R

MemberInfoContainer 中的 member 作为 block 中的参数使用。

Link copied to clipboard
inline suspend fun <R> ResourceContainer.useResource(block: (Resource) -> R): R

使用 ResourceContainer 中的 ResourceContainer.resource, 并在 block 结束后关闭它。

Link copied to clipboard
inline suspend fun <R> UserInfoContainer.useUserInfo(block: (UserInfo) -> R): R

UserInfoContainer 中的 user 作为 block 中的参数使用。

Properties

Link copied to clipboard

尝试获取 MemberInfo 中不为全空白字符串的有效名称。 如果最终的结果依旧仅为空白字符串,得到null。

Link copied to clipboard

尝试通过 MemberInfo.nickOrUsername 获取当前用户的有效名称(不为空的)。 如果最终结果依旧为空,得到null。