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

Friend

@NotStableForInheritance
interface Friend : User, CoroutineScope, AudioSupported, RoamingSupported
Content copied to clipboard

代表一位好友.

一个 Friend 实例并不是独立的, 它属于一个 Bot. 对于同一个 Bot, 任何一个人的 Friend 实例都是单一的. Friend 无法通过任何方式直接构造. 任何时候都应从 Bot.getFriend 或事件中获取.

See also

Functions

delete
Link copied to clipboard
abstract suspend fun delete()
Content copied to clipboard

删除并屏蔽该好友, 屏蔽后对方将无法发送临时会话消息

nudge
Link copied to clipboard
open override fun nudge(): FriendNudge
Content copied to clipboard

创建一个 "戳一戳" 消息

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

查询用户信息

sendMessage
Link copied to clipboard
open suspend override fun sendMessage(message: String): MessageReceipt<Friend>
Content copied to clipboard

发送纯文本消息

abstract suspend override fun sendMessage(message: Message): MessageReceipt<Friend>
Content copied to clipboard

向这个对象发送消息.

uploadAudio
Link copied to clipboard
abstract suspend fun uploadAudio(resource: ExternalResource): OfflineAudio
Content copied to clipboard

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

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

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

Properties

avatarUrl
Link copied to clipboard
open val avatarUrl: String
Content copied to clipboard

头像下载链接

bot
Link copied to clipboard
abstract override val bot: Bot
Content copied to clipboard

这个联系对象所属 Bot.

coroutineContext
Link copied to clipboard
abstract val coroutineContext: CoroutineContext
Content copied to clipboard
id
Link copied to clipboard
abstract override val id: Long
Content copied to clipboard

QQ 号码

nick
Link copied to clipboard
abstract val nick: String
Content copied to clipboard

获取昵称

remark
Link copied to clipboard
abstract val remark: String
Content copied to clipboard

备注信息

roamingMessages
Link copied to clipboard
abstract val roamingMessages: RoamingMessages
Content copied to clipboard

获取漫游消息记录管理器.