mirai-core-api/net.mamoe.mirai.contact/Group

Group

@NotStableForInheritance

interface Group : Contact, CoroutineScope, FileSupported, AudioSupported

群.

群员操作

获取群成员

使用 Group.members 可获取除 Bot 自身外的所有群成员 (包括管理员和群主) 列表. Bot 自身在群内的对象可通过 botAsMember 获取.

get 可以按 QQ 号码获取一个群成员对象, 在不存在时返回 null. getOrFail 则在不存在时抛出 NoSuchElementException.

判断管理员权限

首先获取到目标群成员对象, 然后使用 NormalMember.permission 获取其权限.

Bot 在群内的权限可通过 Group.botPermission 或其 Member 对象的 NormalMember.permission 获取.

其他动作

设置管理员权限: NormalMember.modifyAdmin
禁言: NormalMember.mute
戳一戳: NormalMember.nudge

群公告

可通过 Group.announcements 获取公告支持. 可在 Announcements 查看详细文档.

Types

Companion

object Companion

Functions

contains

abstract operator fun contains(id: Long): Boolean

当本群存在 Member.id 为 id 的群员时返回 true.

open operator fun contains(member: NormalMember): Boolean

当 member 是本群成员时返回 true. 将同时成员所属群. 同一个用户在不同群内的 Member 对象不相等.

get

abstract operator fun get(id: Long): NormalMember?

获取群成员实例. 不存在时返回 null.

getOrFail

open fun getOrFail(id: Long): NormalMember

获取群成员实例. 不存在时抛出 kotlin.NoSuchElementException.

quit

abstract suspend fun quit(): Boolean

让机器人退出这个群.

sendMessage

open suspend override fun sendMessage(message: String): MessageReceipt<Group>

发送纯文本消息

abstract suspend override fun sendMessage(message: Message): MessageReceipt<Group>

向这个对象发送消息.

setEssenceMessage

abstract suspend fun setEssenceMessage(source: MessageSource): Boolean

将一条消息设置为群精华消息, 需要管理员或群主权限. 操作成功返回 true.

uploadAudio

abstract suspend fun uploadAudio(resource: ExternalResource): OfflineAudio

上传一个语音文件以备发送. resource 需要调用方ExternalResource.close.

uploadImage

abstract suspend fun uploadImage(resource: ExternalResource): Image

上传一个资源作为图片以备发送.

uploadVoice

~~abstract~~ ~~suspend~~ ~~fun~~ ~~uploadVoice~~(~~resource~~: ExternalResource): Voice

上传一个语音消息以备发送. 该方法已弃用且将在未来版本删除, 请使用 uploadAudio.

Properties

announcements

abstract val announcements: Announcements

获取群公告相关功能接口

avatarUrl

open override val avatarUrl: String

群头像下载链接.

bot

abstract override val bot: Bot

这个联系对象所属 Bot.

botAsMember

abstract val botAsMember: NormalMember

Bot 在群内的 Member 实例

botMuteRemaining

open val botMuteRemaining: Int

机器人被禁言还剩余多少秒

botPermission

open val botPermission: MemberPermission

机器人在这个群里的权限

coroutineContext

abstract val coroutineContext: CoroutineContext

files

abstract val files: RemoteFiles

获取远程文件列表 (管理器).

filesRoot

~~abstract~~ ~~val~~ ~~filesRoot~~: RemoteFile

文件根目录. 可通过 net.mamoe.mirai.utils.RemoteFile.listFiles 获取目录下文件列表.

abstract override val id: Long

同为 groupCode, 用户看到的群号码.

members

abstract val members: ContactList<NormalMember>

群成员列表, 不含机器人自己, 含群主.

name

abstract var name: String

群名称.

owner

abstract val owner: NormalMember

群主.

settings

abstract val settings: GroupSettings

群设置

Extensions

checkBotPermission

inline fun Group.checkBotPermission(required: MemberPermission, crossinline lazyMessage: () -> String = { "Permission denied: required $required, got actual $botPermission for $bot in group $id" })

要求 Bot 在这个群里的权限至少为 required, 否则抛出异常 PermissionDeniedException

getMember

inline fun Group.getMember(id: Long): NormalMember?

同 get. 在一些不适合使用 get 的情境下使用 getMember.

getMemberOrFail

inline fun Group.getMemberOrFail(id: Long): NormalMember

同 getMemberOrFail. 在一些不适合使用 getOrFail 的情境下使用 getMemberOrFail.

isBotMuted

val Group.isBotMuted: Boolean

返回机器人是否正在被禁言

publishAnnouncement

suspend fun Group.publishAnnouncement(content: String, parameters: AnnouncementParameters = AnnouncementParameters.DEFAULT): OnlineAnnouncement

inline suspend fun Group.publishAnnouncement(content: String, parameters: AnnouncementParametersBuilder.() -> Unit): OnlineAnnouncement

在该群发布群公告并获得 OnlineAnnouncement, 需要管理员权限. 发布公告后群内将会出现 "有新公告" 系统提示.

setEssenceMessage

suspend fun Group.setEssenceMessage(chain: MessageChain): Boolean

将一条消息设置为群精华消息, 需要管理员或群主权限. 操作成功返回 true.