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

Stranger

@NotStableForInheritance
interface Stranger : User, CoroutineScope

代表一位陌生人.

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

陌生人的来源：当将添加好友设置为 ‘任何人可添加为好友’或‘需要回答对验证问题时’ 且被他人成功添加时此人会成为陌生人

陌生人需要主动添加好友才能构成好友关系 但 Mirai 将不会提供此功能 请手动在其他客户端添加好友

See also

Functions

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

得到此陌生人作为好友的对象.

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

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

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

头像下载链接.

Link copied to clipboard
abstract suspend fun delete()

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

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

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

Link copied to clipboard
open override fun nudge(): StrangerNudge

创建一个 "戳一戳" 消息

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
open suspend override fun sendMessage(message: String): MessageReceipt<Stranger>

发送纯文本消息

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

向这个对象发送消息.

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

发送戳一戳消息.

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

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

Link copied to clipboard
suspend fun Contact.uploadImage(resource: ExternalResource): Image
suspend fun Contact.uploadImage(file: <Error class: unknown class>, formatName: String? = null): Image

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

suspend fun Contact.uploadImage(imageStream: <Error class: unknown class>, formatName: String? = null): Image

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

Link copied to clipboard
abstract suspend fun uploadShortVideo(thumbnail: ExternalResource, video: ExternalResource, fileName: String? = null): ShortVideo

上传 资源 作为短视频发送. 同时需要上传缩略图作为视频消息显示的封面.

Properties

Link copied to clipboard
open val avatarUrl: String

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

Link copied to clipboard
abstract override val bot: Bot

这个联系对象所属 Bot.

Link copied to clipboard
Link copied to clipboard
abstract override val id: Long

QQ 号码

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

获取非空群名片或昵称.

Link copied to clipboard
abstract val nick: String

获取昵称

Link copied to clipboard
abstract val remark: String

备注信息

Link copied to clipboard
val User.remarkOrNick: String

获取非空备注或昵称.