Class: MessageProperties

Methods

---

getProperties()

获取消息属性内部的Object

Source:

• client.js, line 281

Returns:

Type

Object

---

messageKey(key)

设置消息KEY

Parameters:

Name	Type	Description
key	string	消息KEY

Source:

• client.js, line 289

---

putProperty(key, value)

设置消息自定义属性

Parameters:

Name	Type	Description
key	string	属性键,非空
value	string	属性值,非空

Source:

• client.js, line 340

---

shardingKey(key)

分区顺序消息中区分不同分区的关键字段，sharding key 于普通消息的 key 是完全不同的概念。
全局顺序消息，该字段可以设置为任意非空字符串。

Parameters:

Name	Type	Description
key	string	分区键值

Source:

• client.js, line 327

---

startDeliverTime(timeMillis)

定时消息，单位毫秒（ms），在指定时间戳（当前时间之后）进行投递。
如果被设置成当前时间戳之前的某个时刻，消息将立刻投递给消费者

Parameters:

Name	Type	Description
timeMillis	Number	定时的绝对时间戳

Source:

• client.js, line 302

---

transCheckImmunityTime(timeSeconds)

在消息属性中添加第一次消息回查的最快时间，单位秒，并且表征这是一条事务消息

Parameters:

Name	Type	Description
timeSeconds	Number	第一次消息回查时间，单位秒

Source:

• client.js, line 314