Karin API Docs / FriendMessage

类: FriendMessage

定义于: packages/core/src/event/message.ts:153

Description

好友消息事件类 FriendMessage

继承

• MessageBase

构造函数

构造函数

new FriendMessage(options): FriendMessage

定义于: packages/core/src/event/message.ts:158

参数

options

FriendMessageOptions

返回

FriendMessage

重写了

MessageBase.constructor

属性

alias

alias: string

定义于: packages/core/src/event/message.ts:29

别名

继承自

MessageBase.alias

---

elements

elements: Elements[]

定义于: packages/core/src/event/message.ts:25

消息段

继承自

MessageBase.elements

---

isAdmin

isAdmin: boolean

定义于: packages/core/src/event/base.ts:42

是否为Bot管理员

继承自

MessageBase.isAdmin

---

isMaster

isMaster: boolean

定义于: packages/core/src/event/base.ts:40

是否为主人

继承自

MessageBase.isMaster

---

logFnc

logFnc: string

定义于: packages/core/src/event/base.ts:36

日志函数字符串

继承自

MessageBase.logFnc

---

logText

logText: string

定义于: packages/core/src/event/base.ts:38

日志用户字符串

继承自

MessageBase.logText

---

msg

msg: string

定义于: packages/core/src/event/message.ts:27

消息文本

继承自

MessageBase.msg

---

rawMessage

rawMessage: string

定义于: packages/core/src/event/message.ts:31

消息日志

继承自

MessageBase.rawMessage

---

reply

reply: Reply

定义于: packages/core/src/event/base.ts:32

快速回复

继承自

MessageBase.reply

---

store

store: Map<any, any>

定义于: packages/core/src/event/base.ts:34

存储器 由开发者自行调用

继承自

MessageBase.store

访问器

at

Getter 签名

get at(): string[]

定义于: packages/core/src/event/message.ts:108

返回

string[]

继承自

MessageBase.at

---

atAll

Getter 签名

get atAll(): boolean

定义于: packages/core/src/event/message.ts:119

返回

boolean

继承自

MessageBase.atAll

---

atBot

Getter 签名

get atBot(): boolean

定义于: packages/core/src/event/message.ts:115

返回

boolean

继承自

MessageBase.atBot

---

bot

Getter 签名

get bot(): AdapterType<any>

定义于: packages/core/src/event/base.ts:202

机器人实例

返回

AdapterType<any>

继承自

MessageBase.bot

---

contact

Getter 签名

get contact(): FriendContact

定义于: packages/core/src/event/message.ts:165

事件来源信息

返回

FriendContact

重写了

MessageBase.contact

---

event

Getter 签名

get event(): "message"

定义于: packages/core/src/event/message.ts:92

事件父类型

返回

"message"

继承自

MessageBase.event

---

eventId

Getter 签名

get eventId(): string

定义于: packages/core/src/event/base.ts:172

事件ID

返回

string

继承自

MessageBase.eventId

---

image

Getter 签名

get image(): string[]

定义于: packages/core/src/event/message.ts:123

返回

string[]

继承自

MessageBase.image

---

isDirect

Getter 签名

get isDirect(): false

定义于: packages/core/src/event/message.ts:193

是否为频道私信场景

返回

false

重写了

MessageBase.isDirect

---

isFriend

Getter 签名

get isFriend(): true

定义于: packages/core/src/event/message.ts:181

是否为好友场景

返回

true

重写了

MessageBase.isFriend

---

isGroup

Getter 签名

get isGroup(): false

定义于: packages/core/src/event/message.ts:185

是否为群聊场景

返回

false

重写了

MessageBase.isGroup

---

isGroupTemp

Getter 签名

get isGroupTemp(): false

定义于: packages/core/src/event/message.ts:197

是否为群临时会话场景

返回

false

重写了

MessageBase.isGroupTemp

---

isGuild

Getter 签名

get isGuild(): false

定义于: packages/core/src/event/message.ts:189

是否为频道场景

返回

false

重写了

MessageBase.isGuild

---

isPrivate

Getter 签名

get isPrivate(): true

定义于: packages/core/src/event/message.ts:177

是否为私聊场景

• 在好友场景下为 true
• 在频道私信场景下为 true

返回

true

重写了

MessageBase.isPrivate

---

message_id

Getter 签名

get message_id(): string

定义于: packages/core/src/event/message.ts:80

Description

消息ID

已被弃用

即将废弃 请使用 messageId

返回

string

继承自

MessageBase.message_id

---

message_seq

Getter 签名

get message_seq(): number

定义于: packages/core/src/event/message.ts:88

Description

消息序列号

已被弃用

即将废弃 请使用 messageSeq

返回

number

继承自

MessageBase.message_seq

---

messageId

Getter 签名

get messageId(): string

定义于: packages/core/src/event/message.ts:100

返回

string

继承自

MessageBase.messageId

---

messageSeq

Getter 签名

get messageSeq(): number

定义于: packages/core/src/event/message.ts:104

返回

number

继承自

MessageBase.messageSeq

---

raw_message

Getter 签名

get raw_message(): string

定义于: packages/core/src/event/message.ts:72

已被弃用

即将废弃 请使用 rawMessage

返回

string

继承自

MessageBase.raw_message

---

rawEvent

Getter 签名

get rawEvent(): unknown

定义于: packages/core/src/event/base.ts:177

原始事件

返回

unknown

继承自

MessageBase.rawEvent

---

record

Getter 签名

get record(): string

定义于: packages/core/src/event/message.ts:130

返回

string

继承自

MessageBase.record

---

reply_id

Getter 签名

get reply_id(): string

定义于: packages/core/src/event/message.ts:144

Description

引用回复的消息id

已被弃用

即将废弃 请使用 replyId

返回

string

继承自

MessageBase.reply_id

---

replyId

Getter 签名

get replyId(): string

定义于: packages/core/src/event/message.ts:135

返回

string

继承自

MessageBase.replyId

---

self_id

Getter 签名

get self_id(): string

定义于: packages/core/src/event/base.ts:139

Description

机器人ID

已被弃用

即将废弃，请使用 selfId

返回

string

继承自

MessageBase.self_id

---

selfId

Getter 签名

get selfId(): string

定义于: packages/core/src/event/base.ts:152

机器人自身ID

返回

string

继承自

MessageBase.selfId

---

sender

Getter 签名

get sender(): SenderBase

定义于: packages/core/src/event/message.ts:169

事件发送者信息

返回

SenderBase

重写了

MessageBase.sender

---

srcReply

Getter 签名

get srcReply(): SrcReply

定义于: packages/core/src/event/base.ts:197

快速回复源函数

返回

SrcReply

继承自

MessageBase.srcReply

---

subEvent

Getter 签名

get subEvent(): "friend"

定义于: packages/core/src/event/message.ts:173

事件子类型

返回

"friend"

重写了

MessageBase.subEvent

---

time

Getter 签名

get time(): number

定义于: packages/core/src/event/base.ts:182

事件触发时间戳

返回

number

继承自

MessageBase.time

---

user_id

Getter 签名

get user_id(): string

定义于: packages/core/src/event/base.ts:147

Description

用户ID

已被弃用

即将废弃，请使用 userId

返回

string

继承自

MessageBase.user_id

---

userId

Getter 签名

get userId(): string

定义于: packages/core/src/event/base.ts:157

用户ID

返回

string

继承自

MessageBase.userId

方法

hasPermission()

hasPermission(role, isUpper): boolean

定义于: packages/core/src/event/base.ts:246

传入目标权限，返回当前事件触发者是否拥有该权限

参数

role

Permission

目标权限

isUpper

boolean = true

是否向上检查 例如group:admin向上检查到master 默认true

返回

boolean

是否拥有该权限

继承自

MessageBase.hasPermission