API Documentation

Class

InboundMessage

InboundMessage

入站消息

View Source src/objects/InboundMessage.ts, line 8

Classes

InboundMessage

Members

获取消息头
Since:
  • 0.0.1

View Source src/objects/InboundMessage.ts, line 25

# id

获取发送方 ID
Since:
  • 0.0.1

View Source src/objects/InboundMessage.ts, line 33

# sender

获取发送方
Since:
  • 0.0.1

View Source src/objects/InboundMessage.ts, line 42

Methods

# extractText(joiner)

提取消息中的文字。
当消息中包含多个内容时，文字将会被滤出并用连接符连接。
Parameters:
Name Type Default Description
joiner string 连接符，默认为换行
Since:
  • 0.1.3

View Source src/objects/InboundMessage.ts, line 162

# getFirstPieceOfMessageContent() → {MessageContent}

获取消息中第一个由发送者产生的内容。这会跳过消息头和引用部分（如果有）。 如果发送者没有生产任何内容，则返回 undefined.
Since:
  • 0.0.1
See:

View Source src/objects/InboundMessage.ts, line 145

消息中第一个由发送者产生的内容
MessageContent

# getPlainText()

获取消息中的文字。
Since:
  • 0.0.1
Deprecated:

View Source src/objects/InboundMessage.ts, line 175

# isImageMessage()

这条消息是否为图片消息。
Since:
  • 0.0.1

View Source src/objects/InboundMessage.ts, line 122

# isMentioned()

这条消息是否提到了机器人。
Since:
  • 0.1.3

View Source src/objects/InboundMessage.ts, line 131

# isPlainTextMessage()

这条消息是否为纯文字消息。
Since:
  • 0.0.1

View Source src/objects/InboundMessage.ts, line 113

# reply(chain, useAt)

回复这条消息。
该函数会自动添加引用回复（自从 0.1.1 版本）。
对于特殊类型的消息（如 XML, JSON, 语音消息等）将不会生成引用回复部分或 at 部分（自从 0.1.8 版本）。
Parameters:
Name Type Default Description
chain OutboundMessageChain 消息链
useAt boolean false 回复时提到该消息的发送人。对于非群消息则该参数被忽略。默认为否。（自从 0.1.4 版本添加）
Since:
  • 0.0.1
See:

View Source src/objects/InboundMessage.ts, line 74

# revoke()

撤销这条消息。 当该消息为好友消息或临时消息时，尝试撤销会导致 Promise 被立刻拒绝。 如果机器人没有权限撤销成员消息，那么返回的 {BasicResponse} 的 `code` 为非 0 值，具体见 StatusCode
Since:
  • 0.0.1

View Source src/objects/InboundMessage.ts, line 54

# toMiraiCode(discardHeader)

将消息转为 Mirai 码。不可被转换的部分（未在规范中指明的部分）会被替换为 `[mirai:not-specified:${type}]`. 特殊的，回复引用部分将被丢弃。
由于上游文档的不一致性，部分在文档中的内容也会被替换为 `[mirai:not-specified:...]`. 这些内容包括 `PokeMessage` (InteractMessage) 和 `VipFace` (未在 `mirai-api-http` 中实现).
对于可以推测的内容，将转换为可能的形式，如 Voice 会被转换为 `[mirai:voice:${voiceId}]` 的形式。 消息头则按照 `mirai-console` 内的实现转换为 `[mirai:source:${id}]`. 如果不希望保留消息头，则传入 `true`.
Parameters:
Name Type Default Description
discardHeader boolean false 是否去除消息头，默认为否
Since:
  • 0.1.4
See:

View Source src/objects/InboundMessage.ts, line 196