消息实体,包含消息的所有属性

1.0.0

Constructors

  • 消息构造方法

    conversationType、targetId、content、objectName 会被赋值

    Parameters

    Returns Message

Properties

conversationType: ConversationType = ConversationType.Private

会话类型

EngineError

targetId: string = ""

会话 ID

messageId: number = 0

消息 ID,本地存储的消息的唯一值(数据库索引唯一值)

direction: MessageDirection = MessageDirection.Send

消息方向

senderId: string = ""

消息发送者 ID

receivedStatus: ReceivedStatus = ...

消息接收状态

sentStatus: SentStatus

消息的发送状态(针对发送的消息生效)

receivedTime: number = 0

消息的接收毫秒时间戳,本地入库的时间,不能用做消息排序。消息排序用 sentTime

sentTime: number = 0

消息的发送毫秒时间戳,服务端的发送时间,用作消息排序

objectName: string = ""

消息类型

消息内容,所有消息体的基类,需要根据 objectName 将 content 转为具体的消息类型

    // Message 必须为有效的消息,此处进行简写
let message : Message;
if (TextMessageObjectName === message.objectName) {
// 转成文本消息
let txtMsg = message.content as TextMessage;
} else if (ImageMessageObjectName === message.objectName) {
// 转成图片消息
let imgMsg= message.content as ImageMessage;
}

MessageContent

messageUid: string = ""

服务器消息唯一 ID(在同一个 AppKey 下全局唯一)

固定格式的字符串,例如 : CH2C-A072-OGM5-E3HL

extra: string = ""

消息的附加字段,只保存在本地数据库,区别于 MessageContent.extra

pushConfig: PushConfig

推送配置

Methods

  • 检查是否可以发送

    Returns EngineError

    是否可以发送,EngineError.Success 代表可以发送;否则代表消息数据有问题无法发送出去

  • 检查媒体消息是否可以发送

    Returns EngineError

    是否可以发送,EngineError.Success 代表可以发送;否则代表消息数据有问题无法发送出去