MessageChain

MessageChain 类型代表一条完整的消息,由多个 SingleMessage 组成。

Constructor

new MessageChain()

Properties
NameTypeDescription
#messagesArray

构成该消息链的所有元素。接收的类型应为 SingleMessage

Methods

append(value) → {MessageChain}

将一个消息元素添加至该消息链中。

Parameters:
NameTypeDescription
valueSingleMessage

要添加的消息元素。

Returns:

该消息链。

Type: 
MessageChain

contentToString() → {String}

将该消息链转化为与qq原生显示一致的字符串形式。

例如:

Image 将会被视为 "[图片]"。

Audio 将会被视为 "[语音]"。

但由于 At 类型不包括群信息,目前 At 只会被视为 "@qq号" 的形式。

Returns:

转化后的字符串。

Type: 
String

get(index) → {SingleMessage}

获取该消息链中指定位置的消息元素。

Parameters:
NameTypeDescription
indexNumber

要获取的消息元素的位置。

Returns:

获取到的消息元素。

Type: 
SingleMessage

pop() → {MessageChain}

移除该消息链中最后一个消息元素。

Returns:

该消息链。

Type: 
MessageChain

remove(index) → {MessageChain}

移除该消息链中指定位置的消息元素。

Parameters:
NameTypeDescription
indexNumber

要移除的消息元素的位置。

Returns:

该消息链。

Type: 
MessageChain

(async) toElements() → {Native}

构造并返回该消息链所对应的 elements 对象。

Returns:

该消息链所对应的 elements 对象。

Type: 
Native

(static) fromNative(elements) → {MessageChain}

从原生消息链构造出一个 MessageChain 对象。

Parameters:
NameTypeDescription
elementsNative

原生消息链。

Returns:

原生消息链所对应的 MessageChain 对象。

Type: 
MessageChain