simbot-component-onebot-v11-core/love.forte.simbot.component.onebot.v11.core.actor/OneBotGroup

OneBotGroup

@OneBotInternalImplementationsOnly

interface OneBotGroup : ChatGroup, DeleteSupport(source)

OneBot中的 group 的 ChatGroup 实现。

群通常的来源：

来自事件
来自 Bot relation API (OneBotBot.groupRelation)

DeleteSupport

OneBotGroup 实现 DeleteSupport， delete 代表使Bot退出此群或解散群聊。

Author

ForteScarlet

Properties

coroutineContext

abstract override val coroutineContext: CoroutineContext

协程上下文。源自 OneBotBot, 但是不含 Job。

abstract override val id: ID

群号

maxMemberCount

abstract val maxMemberCount: Int

最大成员数（群容量）。

memberCount

abstract val memberCount: Int

成员数。

members

abstract override val members: Collectable<OneBotMember>

获取群内所有成员集合。

name

abstract override val name: String

群名称。

roles

open override val roles: Collectable<OneBotMemberRole>

群内的全部角色权限。即 OneBotMemberRole 的枚举元素。

Inherited properties

ownerId

abstract val ownerId: ID?

Functions

ban

abstract suspend fun ban(enable: Boolean)

设置全群禁言。

botAsMember

abstract suspend override fun botAsMember(): OneBotMember

将当前所属Bot作为一个 OneBotMember 获取。

delete

abstract suspend override fun delete(vararg options: DeleteOption)

让当前bot退出/离开此群。

getAllHonorInfo

open suspend fun getAllHonorInfo(): GetGroupHonorInfoResult

通过 GetGroupHonorInfoApi 获取本群的所有荣誉信息 (即 type="all")。

getHonorInfo

abstract suspend fun getHonorInfo(type: String): GetGroupHonorInfoResult

通过 GetGroupHonorInfoApi 获取本群的荣誉信息。

member

abstract suspend override fun member(id: ID): OneBotMember?

根据ID寻找指定的成员。

send

abstract suspend override fun send(text: String): OneBotMessageReceipt

abstract suspend override fun send(message: Message): OneBotMessageReceipt

abstract suspend override fun send(messageContent: MessageContent): OneBotMessageReceipt

向此群内发送消息。

setAdmin

abstract suspend fun setAdmin(memberId: ID, enable: Boolean)

设置指定的群成员为管理员/撤销其管理员。

setAnonymous

abstract suspend fun setAnonymous(enable: Boolean)

使用 SetGroupAnonymousApi 设置群组匿名(的开关)。

setBotGroupNick

abstract suspend fun setBotGroupNick(newNick: String?)

设置 bot 在此群内的群备注。

setName

abstract suspend fun setName(newName: String)

设置群名。

Inherited functions

ban

suspend fun OneBotGroup.ban()

开启全群禁言。

unban

suspend fun OneBotGroup.unban()

取消全群禁言。