Class ChatMessage

消息类，用于定义一条要发送或接收的消息。

例如，构造一条文本消息：

  let msg = ChatMessage.createTextMessage(
        'asteriskhx2',
        Date.now().toString(),
        ChatMessageChatType.PeerChat
      );

Constructors

constructor

new ChatMessage(
    params: {
        attributes?: any;
        body: any;
        chatType?: number;
        conversationId?: string;
        deliverOnlineOnly?: boolean;
        direction?: string;
        from?: string;
        groupReadReceiptCount?: number;
        hasDeliverAck?: boolean;
        isBroadcast?: boolean;
        isChatThread?: boolean;
        isContentReplaced?: boolean;
        isNeedReadReceipt?: boolean;
        isOnline?: boolean;
        isPeerRead?: boolean;
        isRead?: boolean;
        localMsgId?: string;
        localTime?: number;
        msgId?: string;
        receiverList?: string[];
        senderInfo?: ChatMessageSenderInfo;
        serverTime?: number;
        status?: number;
        streamChunk?: ChatStreamChunk;
        to?: string;
        webhookEnv?: string;
    },
): ChatMessage
构造消息。
Parameters
- params: {
      attributes?: any;
      body: any;
      chatType?: number;
      conversationId?: string;
      deliverOnlineOnly?: boolean;
      direction?: string;
      from?: string;
      groupReadReceiptCount?: number;
      hasDeliverAck?: boolean;
      isBroadcast?: boolean;
      isChatThread?: boolean;
      isContentReplaced?: boolean;
      isNeedReadReceipt?: boolean;
      isOnline?: boolean;
      isPeerRead?: boolean;
      isRead?: boolean;
      localMsgId?: string;
      localTime?: number;
      msgId?: string;
      receiverList?: string[];
      senderInfo?: ChatMessageSenderInfo;
      serverTime?: number;
      status?: number;
      streamChunk?: ChatStreamChunk;
      to?: string;
      webhookEnv?: string;
  }
Returns ChatMessage

Properties

attributes

attributes: Record<string, any>

消息的扩展属性。

body

body: ChatMessageBody

消息体实例，详见 ChatMessageBody。

chatType

chatType: ChatMessageChatType

消息的聊天类型，详见 ChatMessageChatType。

conversationId

conversationId: string = ''

会话 ID。

deliverOnlineOnly

deliverOnlineOnly: boolean

消息是否只投递给在线用户：

true：只有消息接收方在线时才能投递成功。若接收方离线，则消息会被丢弃。
（默认）false：如果用户在线，则直接投递；如果用户离线，消息会在用户上线时投递。

direction

direction: ChatMessageDirection

消息方向，详见 ChatMessageDirection。

from

from: string = ''

消息发送者的用户 ID。

`Readonly`groupReadReceiptCount

groupReadReceiptCount: number = 0

群聊时，已阅读消息的群成员数量。群成员阅读消息后，会调用 ChatManager.sendMessageReadReceipts 发送已读回执。若要为群消息启用已读回执功能，需要在发送消息时将 isNeedReadReceipt 设置为 true。

hasDeliverAck

hasDeliverAck: boolean = false

单聊时，发送的消息是否送达至接收方。要使该参数生效，初始化时需接收方设置 ChatOptions.requireDeliveryAck 为 true。群消息不支持送达回执。

true：是。
（默认）false：否。

isBroadcast

isBroadcast: boolean

是否是广播消息。

isChatThread

isChatThread: boolean

消息是否为子区消息：

true：是。你需将消息接收方的用户 ID 设置为子区 ID。详见 to。
false：否。

注意

该参数仅对群聊有效。

isContentReplaced

isContentReplaced: boolean

消息内容是否被替换过。

该属性仅在 ChatOptions.useReplacedMessageContents 开启时有效。

isNeedReadReceipt

isNeedReadReceipt: boolean = false

群聊时，是否需要消息已读回执。

true：是。
（默认）false：否。

isOnline

isOnline: boolean

消息是否为在线时收到的消息。

true: 是。这种情况下，如果应用在后台运行可以弹出消息提示框。
false: 否，离线时收到的消息。

`Readonly`isPeerRead

isPeerRead: boolean = false

单聊时，发送方是否收到了接收方的消息已读回执。接收方阅读消息后，会调用 ChatManager.sendMessageReadReceipts 向发送方发送已读回执。

true：是。
（默认）false：否。

`Readonly`isRead

isRead: boolean = false

单聊或群聊时，接收方是否已读消息。该参数的值与会话的未读消息数相关。接收方可以调用 ChatManager.clearConversationUnreadMessageCount 清除会话的未读消息数。

true：是。
（默认）false：否。

localMsgId

localMsgId: string = ''

本地消息 ID。

localTime

localTime: number = ...

消息创建的本地 Unix 时间戳。单位为毫秒。

msgId

msgId: string = ...

服务器生成的消息 ID。

`Optional`receiverList

receiverList?: string[]

消息接收对象列表。

默认为 undefined，表示群组或聊天室中的所有成员均能收到该消息。

该属性只在群组或者聊天室中使用。

`Optional`senderInfo

senderInfo?: ChatMessageSenderInfo

消息发送者的展示信息。详见 ChatMessageSenderInfo。

serverTime

serverTime: number = ...

服务器收到该消息的 Unix 时间戳。单位为毫秒。

status

status: ChatMessageStatus = ChatMessageStatus.CREATE

消息状态，详见 ChatMessageStatus。

`Optional`streamChunk

streamChunk?: ChatStreamChunk

消息流分片信息。

to

to: string = ''

消息接收方的用户 ID：

单聊：消息接收方的用户 ID；
群聊：群组 ID；
聊天室：聊天室 ID；
子区：子区 ID。

`Optional`webhookEnv

webhookEnv?: string

消息回调 webhook 的路由环境标识。

如果未设置该参数，消息回调 webhook 将路由到默认环境。

空字符串会被视为未匹配的路由。

`Static`TAG

TAG: string = 'ChatMessage'

Accessors

getPinInfo

get getPinInfo(): Promise<ChatMessagePinInfo | undefined>

获取消息的置顶信息。

Returns Promise<ChatMessagePinInfo | undefined>

messagePriority

set messagePriority(p: ChatRoomMessagePriority): void
设置消息优先级。仅仅聊天室生效。
Parameters
- p: ChatRoomMessagePriority
Returns void

reactionList

get reactionList(): Promise<ChatMessageReaction[]>

获取 Reaction 列表。

Returns Promise<ChatMessageReaction[]>

threadInfo

get threadInfo(): Promise<ChatMessageThread | undefined>

获取指定子区的详情。

Returns Promise<ChatMessageThread | undefined>

Methods

`Static`createCmdMessage

createCmdMessage(
    targetId: string,
    action: string,
    chatType?: ChatMessageChatType,
    opt?: {
        deliverOnlineOnly?: boolean;
        isChatThread?: boolean;
        isOnline?: boolean;
        receiverList?: string[];
    },
): ChatMessage
创建一条待发送的命令消息。
Parameters
- targetId: string
  消息接收方的用户 ID。
  
  单聊：接收方的用户 ID。
  
  群聊：群组 ID。
  
  聊天室：聊天室 ID。
- action: string
  命令内容。
- chatType: ChatMessageChatType = ChatMessageChatType.PeerChat
  会话类型。
- Optionalopt: {
      deliverOnlineOnly?: boolean;
      isChatThread?: boolean;
      isOnline?: boolean;
      receiverList?: string[];
  }
Returns ChatMessage
消息实例。
Params
opt 消息扩展参数。
- isChatThread: 是否是子区消息。默认不是子区消息。
- isOnline: 是否为在线时收到的消息。
- deliverOnlineOnly: 消息是否只投递给在线用户。
- receiverList: 消息接收人列表。

`Static`createCombineMessage

createCombineMessage(
    targetId: string,
    messageIdList: string[],
    chatType?: ChatMessageChatType,
    opt?: {
        compatibleText?: string;
        deliverOnlineOnly?: boolean;
        isChatThread?: boolean;
        isOnline?: boolean;
        receiverList?: string[];
        summary?: string;
        title?: string;
    },
): ChatMessage
创建合并类型消息体。
Parameters
- targetId: string
  消息接收方。
  
  单聊时是接收方的用户 ID。
  
  群聊时是群组 ID。
  
  聊天室则是聊天室 ID。
- messageIdList: string[]
  合并的消息列表 ID。
- chatType: ChatMessageChatType = ChatMessageChatType.PeerChat
  会话类型。详见 ChatMessageChatType。
- Optionalopt: {
      compatibleText?: string;
      deliverOnlineOnly?: boolean;
      isChatThread?: boolean;
      isOnline?: boolean;
      receiverList?: string[];
      summary?: string;
      title?: string;
  }
Returns ChatMessage
消息实例。
Params
opt 消息扩展参数。
- isChatThread: 是否是子区消息。
  
  true：是；
  
  （默认）false：否。
- isOnline: 是否为在线时收到的消息。
  
  true：是；
  
  false：否。
- deliverOnlineOnly: 消息是否只投递给在线用户。
  
  true：是。只有消息接收方在线时才能投递成功。若接收方离线，则消息会被丢弃。
  
  （默认）false：否。如果用户在线，则直接投递；如果用户离线，消息会在用户上线时投递。
- title: 合并消息的标题。
- summary: 合并消息的概要。
- compatibleText: 合并消息的兼容信息。该字段用于需要兼容不支持合并转发消息的版本。
- receiverList: 消息接收人列表。

`Static`createCustomMessage

createCustomMessage(
    targetId: string,
    event: string,
    chatType?: ChatMessageChatType,
    opt?: {
        deliverOnlineOnly?: boolean;
        isChatThread?: boolean;
        isOnline?: boolean;
        params: Record<string, string>;
        receiverList?: string[];
    },
): ChatMessage
创建一条待发送的自定义类型消息。
Parameters
- targetId: string
  消息接收方的用户 ID。
  
  单聊：接收方的用户 ID。
  
  群聊：群组 ID。
  
  聊天室：聊天室 ID。
- event: string
  消息触发的自定义事件。
- chatType: ChatMessageChatType = ChatMessageChatType.PeerChat
  会话类型。
- Optionalopt: {
      deliverOnlineOnly?: boolean;
      isChatThread?: boolean;
      isOnline?: boolean;
      params: Record<string, string>;
      receiverList?: string[];
  }
Returns ChatMessage
消息实例。
Params
opt 消息扩展参数。
- isChatThread: 是否是子区消息。默认不是子区消息。
- isOnline: 是否为在线时收到的消息。
- deliverOnlineOnly: 消息是否只投递给在线用户。
- params: 自定义参数。key-value格式。
- receiverList: 消息接收人列表。

`Static`createFileMessage

createFileMessage(
    targetId: string,
    filePath: string,
    chatType?: ChatMessageChatType,
    opt?: {
        deliverOnlineOnly?: boolean;
        displayName?: string;
        fileSize?: number;
        isChatThread?: boolean;
        isOnline?: boolean;
        receiverList?: string[];
    },
): ChatMessage
创建一条待发送的文件类型消息。
Parameters
- targetId: string
  消息接收方的用户 ID。
  
  单聊时为接收方的用户 ID。
  
  群聊时为群组 ID。
  
  聊天室则为聊天室 ID。
- filePath: string
  文件路径。
- chatType: ChatMessageChatType = ChatMessageChatType.PeerChat
  会话类型。详见 ChatMessageChatType。
- Optionalopt: {
      deliverOnlineOnly?: boolean;
      displayName?: string;
      fileSize?: number;
      isChatThread?: boolean;
      isOnline?: boolean;
      receiverList?: string[];
  }
Returns ChatMessage
消息实例。
Params
opt 消息扩展参数。
- displayName: 文件名称。
- isChatThread: 是否是子区消息。默认不是子区消息。
- isOnline: 是否为在线时收到的消息。
- deliverOnlineOnly: 消息是否只投递给在线用户。
- fileSize: 文件大小。
- receiverList: 定向消息的接收方列表。

`Static`createImageMessage

createImageMessage(
    targetId: string,
    filePath: string,
    chatType?: ChatMessageChatType,
    opt?: {
        deliverOnlineOnly?: boolean;
        displayName?: string;
        fileSize?: number;
        height?: number;
        isChatThread?: boolean;
        isGif?: boolean;
        isOnline?: boolean;
        receiverList?: string[];
        sendOriginalImage?: boolean;
        thumbnailLocalPath?: string;
        width?: number;
    },
): ChatMessage
创建一条待发送的图片消息。
Parameters
- targetId: string
  消息接收方的用户 ID。
  
  单聊：接收方的用户 ID。
  
  群聊：群组 ID。
  
  聊天室：聊天室 ID。
- filePath: string
  图片路径。
- chatType: ChatMessageChatType = ChatMessageChatType.PeerChat
  会话类型。
- Optionalopt: {
      deliverOnlineOnly?: boolean;
      displayName?: string;
      fileSize?: number;
      height?: number;
      isChatThread?: boolean;
      isGif?: boolean;
      isOnline?: boolean;
      receiverList?: string[];
      sendOriginalImage?: boolean;
      thumbnailLocalPath?: string;
      width?: number;
  }
Returns ChatMessage
消息实例。
Params
opt 消息扩展参数。
- isChatThread: 是否是子区消息。默认不是子区消息。
- isOnline: 是否为在线时收到的消息。
- deliverOnlineOnly: 消息是否只投递给在线用户。
- displayName: 图片名称。
- thumbnailLocalPath: 缩略图本地地址。
- sendOriginalImage: 是否发送原图。
- width: 图片宽度。
- height: 图片高度。
- fileSize: 图片大小。
- receiverList: 消息接收人列表。

`Static`createLocationMessage

createLocationMessage(
    targetId: string,
    latitude: string,
    longitude: string,
    chatType?: ChatMessageChatType,
    opt?: {
        address?: string;
        deliverOnlineOnly?: boolean;
        isChatThread?: boolean;
        isOnline?: boolean;
        receiverList?: string[];
    },
): ChatMessage
创建一条待发送的位置消息。
Parameters
- targetId: string
  消息接收方的用户 ID。
  
  单聊：接收方的用户 ID。
  
  群聊：群组 ID。
  
  聊天室：聊天室 ID。
- latitude: string
  纬度。
- longitude: string
  经度。
- chatType: ChatMessageChatType = ChatMessageChatType.PeerChat
  会话类型。
- Optionalopt: {
      address?: string;
      deliverOnlineOnly?: boolean;
      isChatThread?: boolean;
      isOnline?: boolean;
      receiverList?: string[];
  }
Returns ChatMessage
消息实例。
Params
opt 消息扩展参数。
- address: 地址信息。
- isChatThread: 是否是子区消息。默认不是子区消息。
- isOnline: 是否为在线时收到的消息。
- deliverOnlineOnly: 消息是否只投递给在线用户。
- address: 地址信息。
- receiverList: 消息接收人列表。

`Static`createReceiveMessage

createReceiveMessage(params: any): ChatMessage
创建一条接收消息。
Parameters
- params: any
  接收的消息。
Returns ChatMessage
消息对象。

`Static`createSendMessage

createSendMessage(
    params: {
        body: ChatMessageBody;
        chatType: ChatMessageChatType;
        deliverOnlineOnly?: boolean;
        isChatThread?: boolean;
        isOnline?: boolean;
        receiverList?: string[];
        targetId: string;
    },
): ChatMessage
Parameters
- params: {
      body: ChatMessageBody;
      chatType: ChatMessageChatType;
      deliverOnlineOnly?: boolean;
      isChatThread?: boolean;
      isOnline?: boolean;
      receiverList?: string[];
      targetId: string;
  }
Returns ChatMessage

`Static`createTextMessage

createTextMessage(
    targetId: string,
    content: string,
    chatType?: ChatMessageChatType,
    opt?: {
        deliverOnlineOnly?: boolean;
        isChatThread?: boolean;
        isOnline?: boolean;
        receiverList?: string[];
        targetLanguageCodes?: string[];
    },
): ChatMessage
创建一条待发送的文本消息。
Parameters
- targetId: string
  消息接收方的用户 ID。
  
  单聊时是接收方的用户 ID。
  
  群聊时是群组 ID。
  
  聊天室则是聊天室 ID。
- content: string
  文本消息内容。
- chatType: ChatMessageChatType = ChatMessageChatType.PeerChat
  会话类型。详见 ChatMessageChatType。
- Optionalopt: {
      deliverOnlineOnly?: boolean;
      isChatThread?: boolean;
      isOnline?: boolean;
      receiverList?: string[];
      targetLanguageCodes?: string[];
  }
Returns ChatMessage
消息实例。
Params
opt 消息扩展参数。
- isChatThread: 是否是子区消息。默认不是子区消息。
- isOnline: 是否为在线时收到的消息。
- deliverOnlineOnly: 消息是否只投递给在线用户。

`Static`createVideoMessage

createVideoMessage(
    targetId: string,
    filePath: string,
    chatType?: ChatMessageChatType,
    opt?: {
        deliverOnlineOnly?: boolean;
        displayName?: string;
        duration?: number;
        fileSize?: number;
        height?: number;
        isChatThread?: boolean;
        isOnline?: boolean;
        receiverList?: string[];
        thumbnailLocalPath?: string;
        width?: number;
    },
): ChatMessage
创建一条待发送的视频消息。
Parameters
- targetId: string
  消息接收方的用户 ID。
  
  单聊时是接收方的用户 ID。
  
  群聊时是群组 ID。
  
  聊天室则是聊天室 ID。
- filePath: string
  视频文件路径。
- chatType: ChatMessageChatType = ChatMessageChatType.PeerChat
  会话类型。
- Optionalopt: {
      deliverOnlineOnly?: boolean;
      displayName?: string;
      duration?: number;
      fileSize?: number;
      height?: number;
      isChatThread?: boolean;
      isOnline?: boolean;
      receiverList?: string[];
      thumbnailLocalPath?: string;
      width?: number;
  }
Returns ChatMessage
消息实例。
Params
opt 消息扩展参数。
- isChatThread: 是否是子区消息。默认不是子区消息。
- isOnline: 是否为在线时收到的消息。
- deliverOnlineOnly: 消息是否只投递给在线用户。
- displayName: 文件名称。
- thumbnailLocalPath: 缩略图本地地址。
- duration: 视频时长。
- width: 视频宽度。
- height: 视频高度。
- fileSize: 文件大小。
- receiverList: 消息接收人列表。

`Static`createVoiceMessage

createVoiceMessage(
    targetId: string,
    filePath: string,
    chatType?: ChatMessageChatType,
    opt?: {
        deliverOnlineOnly?: boolean;
        displayName?: string;
        duration?: number;
        fileSize?: number;
        isChatThread?: boolean;
        isOnline?: boolean;
        receiverList?: string[];
    },
): ChatMessage
创建一条待发送的语音消息。
Parameters
- targetId: string
  消息接收方 ID。
  
  单聊时是接收方的用户 ID。
  
  群聊时是群组 ID。
  
  聊天室则是聊天室 ID。
- filePath: string
  语音文件路径。
- chatType: ChatMessageChatType = ChatMessageChatType.PeerChat
  会话类型。
- Optionalopt: {
      deliverOnlineOnly?: boolean;
      displayName?: string;
      duration?: number;
      fileSize?: number;
      isChatThread?: boolean;
      isOnline?: boolean;
      receiverList?: string[];
  }
Returns ChatMessage
消息实例。
Params
opt 消息扩展参数。
- isChatThread: 是否是子区消息。默认不是子区消息。
- isOnline: 是否为在线时收到的消息。
- deliverOnlineOnly: 消息是否只投递给在线用户。
- displayName: 文件名称。
- thumbnailLocalPath: 缩略图本地地址。
- duration: 语音时长。
- fileSize: 文件大小。
- receiverList: 消息接收人列表。

`Static`getBody

getBody(params: any): ChatMessageBody
Parameters
- params: any
Returns ChatMessageBody

Class ChatMessage

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ChatMessage

Properties

attributes

body

chatType

conversationId

deliverOnlineOnly

direction

from

ReadonlygroupReadReceiptCount

hasDeliverAck

isBroadcast

isChatThread

isContentReplaced

isNeedReadReceipt

isOnline

ReadonlyisPeerRead

ReadonlyisRead

localMsgId

localTime

msgId

OptionalreceiverList

OptionalsenderInfo

serverTime

status

OptionalstreamChunk

to

OptionalwebhookEnv

StaticTAG

Accessors

getPinInfo

Returns Promise<ChatMessagePinInfo | undefined>

messagePriority

Parameters

Returns void

reactionList

Returns Promise<ChatMessageReaction[]>

threadInfo

Returns Promise<ChatMessageThread | undefined>

Methods

StaticcreateCmdMessage

Parameters

Returns ChatMessage

Params

StaticcreateCombineMessage

Parameters

Returns ChatMessage

Params

StaticcreateCustomMessage

Parameters

Returns ChatMessage

Params

StaticcreateFileMessage

Parameters

Returns ChatMessage

Params

StaticcreateImageMessage

Parameters

Returns ChatMessage

Params

StaticcreateLocationMessage

Parameters

Returns ChatMessage

Params

StaticcreateReceiveMessage

Parameters

Returns ChatMessage

StaticcreateSendMessage

Parameters

Returns ChatMessage

StaticcreateTextMessage

`Readonly`groupReadReceiptCount

`Readonly`isPeerRead

`Readonly`isRead

`Optional`receiverList

`Optional`senderInfo

`Optional`streamChunk

`Optional`webhookEnv

`Static`TAG

`Static`createCmdMessage

`Static`createCombineMessage

`Static`createCustomMessage

`Static`createFileMessage

`Static`createImageMessage

`Static`createLocationMessage

`Static`createReceiveMessage

`Static`createSendMessage

`Static`createTextMessage

`Static`createVideoMessage

`Static`createVoiceMessage

`Static`getBody