TypeableMessage

TypeableMessage

可分类消息。

Constructor

new TypeableMessage()

Extends

Classes

TypeableMessage

Members

attachment :FileAttachment

Overrides:

消息附件。

Type:

CacheDuration

Overrides:

缓存持续时长。

context :JSON

Overrides:

关联的上下文信息。

Type:
  • JSON

expiry :number

Overrides:

有效期。

Type:
  • number

from :number

Overrides:

消息发送方 ID 。

Type:
  • number

id :number

Overrides:

消息 ID 。

Type:
  • number

last :number

Overrides:

上一次更新数据的时间戳。

Type:
  • number

Lifespan

Overrides:

数据生命周期。

localTS :number

Overrides:

本地时间戳。

Type:
  • number

(protected) moduleName :string

Overrides:

模块名称。

Type:
  • string

owner :number

Overrides:

消息持有者 ID 。

Type:
  • number

payload :JSON

Overrides:

消息负载数据。

Type:
  • JSON

receiver :Contact

Overrides:

消息收件人。

Type:

remoteTS :number

Overrides:

服务器端时间戳。

Type:
  • number

sender :Contact

Overrides:

消息发件人。

Type:

source :number

Overrides:

消息的收发源。该属性表示消息在一个广播域里的域标识或者域 ID 。

Type:
  • number

sourecGroup :Group

Overrides:

消息的收发群组。

Type:

state :number

Overrides:
See:

消息状态描述。

Type:
  • number

timestamp :number

Overrides:

数据时间戳。

Type:
  • number

to :number

Overrides:

消息接收方 ID 。

Type:
  • number

Methods

(protected) clone(src)

Overrides:

从指定源复制消息数据。

Parameters:
Name Type Description
src Message

指定复制源。

getAttachment() → {FileAttachment}

Overrides:

获取消息的文件附件。

Returns:

返回消息的文件附件。

Type
FileAttachment

getContext() → {JSON}

Overrides:

获取关联的上下文。

Returns:

返回关联的上下文数据。

Type
JSON

getDomain() → {string}

Overrides:

获取域。

Returns:

返回域。

Type
string

getExpiry() → {number}

Overrides:

获取数据的有效期。

Returns:

返回数据的有效期。

Type
number

getFrom() → {number}

Overrides:

获取消息发送方的 ID 。

Returns:

返回消息发送方的 ID 。

Type
number

getGroupId() → {number}

Overrides:

获取群组 ID 。

Returns:

返回群组 ID 。

Type
number

getId() → {number}

Overrides:

获取实体 ID 。

Returns:

返回实体 ID 。

Type
number

getLast() → {number}

Overrides:

获取最近一次更新数据的时间戳。

Returns:

返回最近一次更新数据的时间戳。

Type
number

getLocalTimestamp() → {number}

Overrides:

获取消息的本地时间戳。

Returns:

返回消息的本地时间戳。

Type
number

getPayload() → {JSON}

Overrides:

获取消息的负载数据。

Returns:

返回消息的负载数据。

Type
JSON

getReceiver() → {Contact}

Overrides:

获取消息的收件人。

Returns:

返回消息的收件人对象实例。

Type
Contact

getRemoteTimestamp() → {number}

Overrides:

获取消息的服务器时间戳。

Returns:

返回消息的服务器时间戳。

Type
number

getSender() → {Contact}

Overrides:

获取消息的发件人。

Returns:

返回消息发件人对象实例。

Type
Contact

getSource() → {number}

Overrides:

获取消息的收发源。该属性表示消息在一个广播域里的域标识或者域 ID 。

Returns:
Type
number

getSourceGroup() → {Group}

Overrides:

获取消息的收发来源群组。

Returns:

返回消息的收发来源的群组对象实例。

Type
Group

getState() → {number}

Overrides:
See:

获取消息的状态。

Returns:

返回消息状态。

Type
number

getSummary() → {string}

Overrides:

获取消息的摘要。

Returns:

返回消息的摘要。

Type
string

getTimestamp() → {number}

Overrides:

获取数据时间戳。

Returns:

返回数据时间戳。

Type
number

getTo() → {number}

Overrides:

获取消息接收方的 ID 。

Returns:

返回消息接收方的 ID 。

Type
number

getType() → {string}

获取消息类型描述。

Returns:

返回消息类型。

Type
string

hasAttachment() → {boolean}

Overrides:

消息是否有附件。

Returns:

如果有附件返回 true ,否则返回 false

Type
boolean

isFromGroup() → {number}

Overrides:

是否来自群组。

Returns:

如果消息来自群组返回 true ,否则返回 false

Type
number

isOverdue() → {boolean}

Overrides:

数据是否已经超期。

Returns:

如果超期返回 true ,否则返回 false

Type
boolean

isRead() → {boolean}

Overrides:

消息是否是已读状态。

Returns:

如果消息是已读状态返回 true

Type
boolean

isValid() → {boolean}

Overrides:

数据是否在有效期内。

Returns:

如果有效返回 true ,否则返回 false

Type
boolean

markOnlyOwner()

Overrides:

标记消息仅作用于发件人的设备。

resetUpdateTime(time)

Overrides:

重置更新时间。

Parameters:
Name Type Description
time number

更新时间。

setAttachment(file)

Overrides:

设置文件附件。

Parameters:
Name Type Description
file File | FileAttachment

指定文件实例。

setContext(context)

Overrides:

设置关联的上下文。

Parameters:
Name Type Description
context JSON

指定上下文数据。

setPayload(payload)

Overrides:

设置消息的负载。

Parameters:
Name Type Description
payload JSON

负载数据。

toCompactJSON()

Inherited From:

toJSON()

Inherited From: