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

Member

@NotStableForInheritance
interface Member : User

代表一位群成员.

群成员分为 普通成员 和 匿名成员

一个群成员可能也是机器人的好友, 但他们在对象类型上不同 (Member != Friend). 可以通过 Member.asFriend 得到相关好友对象.

相关的操作

Inheritors

Functions

Link copied to clipboard
fun Member.asFriend(): Friend

得到此成员作为好友的对象.

Link copied to clipboard
fun Member.asFriendOrNull(): Friend?

得到此成员作为好友的对象, 当此成员不是好友时返回 null

Link copied to clipboard
fun Member.asStranger(): Stranger

得到此成员作为陌生人的对象.

Link copied to clipboard
fun Member.asStrangerOrNull(): Stranger?

得到此成员作为陌生人的对象, 当此成员不是陌生人时返回 null

Link copied to clipboard
inline fun Member.at(): At

At 这个成员

Link copied to clipboard
@JvmName(name = "getAvatarUrl")
open fun avatarUrl(spec: AvatarSpec): String

头像下载链接.

Link copied to clipboard
fun CoroutineScope.globalEventChannel(coroutineContext: CoroutineContext = EmptyCoroutineContext): EventChannel<Event>

在此 CoroutineScope 下创建一个监听所有事件的 EventChannel. 相当于 GlobalEventChannel.parentScope(this).context(coroutineContext).

Link copied to clipboard
inline fun Member.isAdministrator(): Boolean

判断权限是否为管理员

Link copied to clipboard
inline fun Member.isOperator(): Boolean

判断权限是否为管理员或群主

Link copied to clipboard
inline fun Member.isOwner(): Boolean

判断权限是否为群主

Link copied to clipboard
abstract suspend fun mute(durationSeconds: Int)

禁言这个群成员 durationSeconds 秒, 在机器人无权限操作时抛出 PermissionDeniedException.

Link copied to clipboard
abstract override fun nudge(): MemberNudge

创建一个 "戳一戳" 消息

Link copied to clipboard
open suspend fun queryProfile(): UserProfile

查询用户信息.

Link copied to clipboard
inline suspend fun Contact.recallMessage(source: MessageChain)
inline suspend fun Contact.recallMessage(source: MessageSource)
Link copied to clipboard
abstract suspend override fun sendMessage(message: String): MessageReceipt<Member>

发送纯文本消息

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

向群成员发送消息. 若群成员同时是好友, 则会发送好友消息. 否则发送临时会话消息.

Link copied to clipboard
@JvmStatic
suspend fun Contact.sendNudge(nudge: Nudge): Boolean

发送戳一戳消息.

Link copied to clipboard
expect abstract suspend fun uploadImage(resource: ExternalResource): Image

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

Link copied to clipboard
@JvmStatic
expect suspend fun Contact.uploadImage(resource: ExternalResource): Image

将文件作为图片上传, 但不发送

@JvmStatic
actual suspend fun Contact.uploadImage(resource: ExternalResource): Image
@JvmStatic
@JvmOverloads
suspend fun Contact.uploadImage(file: File, formatName: String? = null): Image

将文件作为图片上传, 但不发送

@JvmStatic
@JvmOverloads
suspend fun Contact.uploadImage(imageStream: InputStream, formatName: String? = null): Image

读取 InputStream 到临时文件并将其作为图片上传, 但不发送

actual suspend fun Contact.uploadImage(resource: ExternalResource): Image

将文件作为图片上传, 但不发送

Properties

Link copied to clipboard
abstract val active: MemberActive

群活跃度相关属性.

Link copied to clipboard
open val avatarUrl: String

头像下载链接, 规格默认为 AvatarSpec.LARGEST

Link copied to clipboard
expect abstract override val bot: Bot

这个联系对象所属 Bot.

Link copied to clipboard
Link copied to clipboard
abstract val group: Group

所在的群.

Link copied to clipboard
abstract override val id: Long

QQ 号码

Link copied to clipboard
val Member.isFriend: Boolean

当此成员同时是 Bot 的好友时返回 true

Link copied to clipboard
val Member.isStranger: Boolean

当此成员同时是 Bot 的陌生人时返回 true

Link copied to clipboard
abstract val nameCard: String

群名片. 可能为空.

Link copied to clipboard
val Member.nameCardOrNick: String
val User.nameCardOrNick: String
val UserOrBot.nameCardOrNick: String

获取非空群名片或昵称.

Link copied to clipboard
abstract val nick: String

获取昵称

Link copied to clipboard
abstract val permission: MemberPermission

成员的权限, 将会随服务器通知动态更新.

Link copied to clipboard
open val rankTitle: String

群等级头衔 (PC 端显示)

Link copied to clipboard
abstract val remark: String

备注信息

Link copied to clipboard
val Member.remarkOrNameCard: String

获取非空备注或群名片.

Link copied to clipboard
val Member.remarkOrNameCardOrNick: String

获取非空备注或群名片或昵称.

Link copied to clipboard
val User.remarkOrNick: String

获取非空备注或昵称.

Link copied to clipboard
abstract val specialTitle: String

群特殊头衔.

Link copied to clipboard
open val temperatureTitle: String

群活跃头衔 (手机端显示)