org.jetlinks.core.message.property

接口 ThingReportPropertyMessage

所有超级接口:

Jsonable, Message, PropertyMessage, Serializable, ThingMessage

所有已知实现类:

DefaultReportPropertyMessage, ReportPropertyMessage

public interface ThingReportPropertyMessage
extends ThingMessage, PropertyMessage

上报设备属性,通常由设备定时上报,方向: 设备->平台

从以下版本开始:

1.0.0

作者:

zhouhao

方法概要

限定符和类型	方法和说明
static ReportPropertyMessage	forDevice(String deviceId)
static DefaultReportPropertyMessage	forThing(ThingType thingType, String deviceId)
default MessageType	getMessageType()
Map<String,Object>	getProperties() 属性值信息,key为物模型中的属性ID,value为物模型对应的类型值.
Map<String,Long>	getPropertySourceTimes() 属性源的时间戳,表示不同属性值产生的时间戳,单位毫秒
Map<String,String>	getPropertyStates() 属性状态信息
ThingReportPropertyMessage	success(List<ThingProperty> properties) 设置成功并设置返回完整属性值
ThingReportPropertyMessage	success(Map<String,Object> properties) 设置成功并设置返回属性值

从接口继承的方法 org.jetlinks.core.message.ThingMessage

copy, getThingId, getThingType, messageId, thingId, thingId, thingId, timestamp

从接口继承的方法 org.jetlinks.core.message.Message

addHeader, addHeader, addHeaderIfAbsent, addHeaderIfAbsent, computeHeader, computeHeader, getHeader, getHeader, getHeaderOrDefault, getHeaderOrElse, getHeaderOrElse, getHeaders, getMessageId, getOrAddHeader, getOrAddHeaderDefault, getTimestamp, removeHeader, validate

从接口继承的方法 org.jetlinks.core.metadata.Jsonable

fromJson, toJson

从接口继承的方法 org.jetlinks.core.message.property.PropertyMessage

getCompleteProperties, getCompleteProperty, getProperty, getPropertySourceTime, getPropertyState, getTimestamp

方法详细资料

getProperties

Map<String,Object> getProperties()

属性值信息,key为物模型中的属性ID,value为物模型对应的类型值.

注意: value如果是结构体(对象类型),请勿传入在协议包中自定义的对象,应该转为Map传入.

指定者:

getProperties 在接口中 PropertyMessage

返回:

属性值Map

另请参阅:

Metadata.getId()

getPropertySourceTimes

Map<String,Long> getPropertySourceTimes()

属性源的时间戳,表示不同属性值产生的时间戳,单位毫秒

指定者:

getPropertySourceTimes 在接口中 PropertyMessage

返回:

属性源时间信息

从以下版本开始:

1.1.7

getPropertyStates

Map<String,String> getPropertyStates()

属性状态信息

指定者:

getPropertyStates 在接口中 PropertyMessage

返回:

属性状态信息

从以下版本开始:

1.1.7

success

ThingReportPropertyMessage success(Map<String,Object> properties)

设置成功并设置返回属性值

参数:

properties - 属性值

返回:

this

success

ThingReportPropertyMessage success(List<ThingProperty> properties)

设置成功并设置返回完整属性值

参数:

properties - 属性值

返回:

this

getMessageType

default MessageType getMessageType()

指定者:

getMessageType 在接口中 Message

forDevice

static ReportPropertyMessage forDevice(String deviceId)

forThing

static DefaultReportPropertyMessage forThing(ThingType thingType,
                                             String deviceId)