Karin API Docs / BaseEvent

抽象 类: BaseEvent\<T\>

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

事件实现基类

继承于

• NoticeBase
• MessageBase
• RequestBase

类型参数

T

T extends EventParent

构造函数

构造函数

new BaseEvent<T>(__namedParameters): BaseEvent<T>

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

参数

__namedParameters

BaseEventOptions<T>

返回

BaseEvent<T>

属性

isAdmin

isAdmin: boolean

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

是否为Bot管理员

---

isMaster

isMaster: boolean

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

是否为主人

---

logFnc

logFnc: string

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

日志函数字符串

---

logText

logText: string

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

日志用户字符串

---

reply

reply: Reply

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

快速回复

---

store

store: Map<any, any>

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

存储器 由开发者自行调用

访问器

bot

Getter 签名

get bot(): AdapterType<any>

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

机器人实例

返回

AdapterType<any>

---

contact

Getter 签名

get contact(): Contact

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

事件来源信息

返回

Contact

---

event

Getter 签名

get event(): T

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

事件父类型

返回

T

---

eventId

Getter 签名

get eventId(): string

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

事件ID

返回

string

---

isDirect

Getter 签名

get isDirect(): boolean

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

是否为频道私信场景

返回

boolean

---

isFriend

Getter 签名

get isFriend(): boolean

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

是否为好友场景

返回

boolean

---

isGroup

Getter 签名

get isGroup(): boolean

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

是否为群聊场景

返回

boolean

---

isGroupTemp

Getter 签名

get isGroupTemp(): boolean

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

是否为群临时会话场景

返回

boolean

---

isGuild

Getter 签名

get isGuild(): boolean

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

是否为频道场景

返回

boolean

---

isPrivate

Getter 签名

get isPrivate(): boolean

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

是否为私聊场景

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

返回

boolean

---

rawEvent

Getter 签名

get rawEvent(): unknown

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

原始事件

返回

unknown

---

self_id

Getter 签名

get self_id(): string

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

Description

机器人ID

已被弃用

即将废弃，请使用 selfId

返回

string

---

selfId

Getter 签名

get selfId(): string

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

机器人自身ID

返回

string

---

sender

Getter 签名

get sender(): Sender

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

事件发送者信息

返回

Sender

---

srcReply

Getter 签名

get srcReply(): SrcReply

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

快速回复源函数

返回

SrcReply

---

subEvent

Getter 签名

get subEvent(): EventToSubEvent[T]

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

事件子类型

返回

EventToSubEvent[T]

---

time

Getter 签名

get time(): number

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

事件触发时间戳

返回

number

---

user_id

Getter 签名

get user_id(): string

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

Description

用户ID

已被弃用

即将废弃，请使用 userId

返回

string

---

userId

Getter 签名

get userId(): string

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

用户ID

返回

string

方法

hasPermission()

hasPermission(role, isUpper): boolean

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

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

参数

role

Permission

目标权限

isUpper

boolean = true

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

返回

boolean

是否拥有该权限