Karin API Docs / MessageBase

抽象 类: MessageBase

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

Description

消息事件基类 FriendMessage

继承

• BaseEvent<"message">

继承于

• FriendMessage
• GroupMessage
• DirectMessage
• GuildMessage
• GroupTempMessage

构造函数

构造函数

new MessageBase(__namedParameters): MessageBase

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

参数

__namedParameters

MessageOptions

返回

MessageBase

重写了

BaseEvent.constructor

属性

alias

alias: string

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

别名

---

elements

elements: Elements[]

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

消息段

---

isAdmin

isAdmin: boolean

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

是否为Bot管理员

继承自

BaseEvent.isAdmin

---

isMaster

isMaster: boolean

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

是否为主人

继承自

BaseEvent.isMaster

---

logFnc

logFnc: string

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

日志函数字符串

继承自

BaseEvent.logFnc

---

logText

logText: string

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

日志用户字符串

继承自

BaseEvent.logText

---

msg

msg: string

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

消息文本

---

rawMessage

rawMessage: string

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

消息日志

---

reply

reply: Reply

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

快速回复

继承自

BaseEvent.reply

---

store

store: Map<any, any>

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

存储器 由开发者自行调用

继承自

BaseEvent.store

访问器

at

Getter 签名

get at(): string[]

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

返回

string[]

---

atAll

Getter 签名

get atAll(): boolean

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

返回

boolean

---

atBot

Getter 签名

get atBot(): boolean

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

返回

boolean

---

bot

Getter 签名

get bot(): AdapterType<any>

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

机器人实例

返回

AdapterType<any>

继承自

BaseEvent.bot

---

contact

Getter 签名

get contact(): Contact

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

事件来源信息

返回

Contact

继承自

BaseEvent.contact

---

event

Getter 签名

get event(): "message"

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

事件父类型

返回

"message"

重写了

BaseEvent.event

---

eventId

Getter 签名

get eventId(): string

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

事件ID

返回

string

继承自

BaseEvent.eventId

---

image

Getter 签名

get image(): string[]

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

返回

string[]

---

isDirect

Getter 签名

get isDirect(): boolean

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

是否为频道私信场景

返回

boolean

继承自

BaseEvent.isDirect

---

isFriend

Getter 签名

get isFriend(): boolean

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

是否为好友场景

返回

boolean

继承自

BaseEvent.isFriend

---

isGroup

Getter 签名

get isGroup(): boolean

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

是否为群聊场景

返回

boolean

继承自

BaseEvent.isGroup

---

isGroupTemp

Getter 签名

get isGroupTemp(): boolean

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

是否为群临时会话场景

返回

boolean

继承自

BaseEvent.isGroupTemp

---

isGuild

Getter 签名

get isGuild(): boolean

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

是否为频道场景

返回

boolean

继承自

BaseEvent.isGuild

---

isPrivate

Getter 签名

get isPrivate(): boolean

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

是否为私聊场景

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

返回

boolean

继承自

BaseEvent.isPrivate

---

message_id

Getter 签名

get message_id(): string

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

Description

消息ID

已被弃用

即将废弃 请使用 messageId

返回

string

---

message_seq

Getter 签名

get message_seq(): number

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

Description

消息序列号

已被弃用

即将废弃 请使用 messageSeq

返回

number

---

messageId

Getter 签名

get messageId(): string

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

返回

string

---

messageSeq

Getter 签名

get messageSeq(): number

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

返回

number

---

raw_message

Getter 签名

get raw_message(): string

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

已被弃用

即将废弃 请使用 rawMessage

返回

string

---

rawEvent

Getter 签名

get rawEvent(): unknown

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

原始事件

返回

unknown

继承自

BaseEvent.rawEvent

---

record

Getter 签名

get record(): string

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

返回

string

---

reply_id

Getter 签名

get reply_id(): string

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

Description

引用回复的消息id

已被弃用

即将废弃 请使用 replyId

返回

string

---

replyId

Getter 签名

get replyId(): string

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

返回

string

---

self_id

Getter 签名

get self_id(): string

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

Description

机器人ID

已被弃用

即将废弃，请使用 selfId

返回

string

继承自

BaseEvent.self_id

---

selfId

Getter 签名

get selfId(): string

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

机器人自身ID

返回

string

继承自

RequestBase.selfId

---

sender

Getter 签名

get sender(): Sender

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

事件发送者信息

返回

Sender

继承自

BaseEvent.sender

---

srcReply

Getter 签名

get srcReply(): SrcReply

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

快速回复源函数

返回

SrcReply

继承自

BaseEvent.srcReply

---

subEvent

Getter 签名

get subEvent(): MessageEventSub

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

事件子类型

返回

MessageEventSub

重写了

BaseEvent.subEvent

---

time

Getter 签名

get time(): number

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

事件触发时间戳

返回

number

继承自

BaseEvent.time

---

user_id

Getter 签名

get user_id(): string

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

Description

用户ID

已被弃用

即将废弃，请使用 userId

返回

string

继承自

BaseEvent.user_id

---

userId

Getter 签名

get userId(): string

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

用户ID

返回

string

继承自

BaseEvent.userId

方法

hasPermission()

hasPermission(role, isUpper): boolean

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

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

参数

role

Permission

目标权限

isUpper

boolean = true

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

返回

boolean

是否拥有该权限

继承自

BaseEvent.hasPermission