Class Message

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

Version

1.0.0

Constructors

constructor

Properties

conversationType targetId messageId direction senderId receivedStatus sentStatus receivedTime sentTime objectName content messageUid extra pushConfig

Methods

checkForSend checkForSendMedia

Constructors

constructor

  • new Message(conId, content): Message

  • 消息构造方法

    conversationType、targetId、content、objectName 会被赋值

    Parameters

    Returns Message

Properties

conversationType

conversationType: ConversationType = ConversationType.Private

会话类型

See

EngineError

targetId

targetId: string = ""

会话 ID

messageId

messageId: number = 0

消息 ID，本地存储的消息的唯一值（数据库索引唯一值）

direction

direction: MessageDirection = MessageDirection.Send

消息方向

senderId

senderId: string = ""

消息发送者 ID

receivedStatus

receivedStatus: ReceivedStatus = ...

消息接收状态

sentStatus

sentStatus: SentStatus

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

receivedTime

receivedTime: number = 0

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

sentTime

sentTime: number = 0

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

objectName

objectName: string = ""

消息类型

content

content: MessageContent

消息内容

See

MessageContent

messageUid

messageUid: string = ""

服务器消息唯一 ID（在同一个 AppKey 下全局唯一）

extra

extra: string = ""

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

pushConfig

pushConfig: PushConfig

推送配置

发送的时候有效，接收的消息该字段为 null

Methods

checkForSend

  • checkForSend(): EngineError

  • 检查是否可以发送

    Returns EngineError

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

checkForSendMedia

  • checkForSendMedia(): EngineError

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

    Returns EngineError

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

Settings

Member Visibility

On This Page

Constructors
Properties
Methods