simbot-api/love.forte.simbot.definition/Friend

Friend

interface Friend : Contact, BotContainer, FriendInfo

一个好友。

Functions

open suspend fun send(text: String): MessageReceipt

发送一段纯文本消息。

open suspend fun send(message: MessageContent): MessageReceipt

发送消息，并得到一个回执单。

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

向此联系目标发送消息。

Properties

abstract override val avatar: String

这个账户的头像。这年头了，应该不会有什么聊天平台的用户没有头像信息了吧。

abstract override val bot: Bot

联系人所属的 Bot.

open val category: Category?

此用户（对于bot来讲）的"分组"。通常情况下，FriendInfo 能够支持 "分组" 概念的概率会更大一些，但是无法保证存在分组概念或支持分组的获取。

abstract override val id: ID

当前对象对应的唯一ID。

abstract override val remark: String?

在Bot眼中，一个好友可能存在一个备注。

remarkOrUsername

open val remarkOrUsername: String

优先尝试获取好友的 remark, 如果 remark 为null，则取其 username.

abstract override val username: String

这个账号的用户名。

Extensions

inline operator fun UserInfo.component1(): ID

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

inline operator fun UserInfo.component2(): String

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

inline operator fun UserInfo.component3(): String

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

inline operator fun FriendInfo.component4(): String?

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

infix fun IDContainer.sameIdWith(other: IDContainer): Boolean

比较两个 IDContainer 的 IDContainer.id 是否一致。