云消息-cloudmessage
描述
云消息,父对象为ui,无子对象
事件
- receive: 收到消息,事件函数定义:onReceive(topic, payload), topic为消息的名称,payload为消息的内容
- connect: 连接服务器成功,事件函数定义:onConnect()
- disconnect: 与服务器断开,事件函数定义:onDisconnect()
- error: 错误,事件函数定义:onError(event, code, reason), event为事件的名称,code是错误码,reason是错误原因
属性
名称 | 功能说明 | 脚本例子 |
---|---|---|
autoConnect | 自动连接,默认为使能 | 无 |
cloudId | 云标识,登录云系统创建 | ui.form-name.cloudmessage-name.cloudId='ae3ba84e23554aea8beef8034770851a' |
topic | 订阅主题,多个主题时使用逗号分隔 | ui.form-name.cloudmessage-name.topic='test1,test2' |
echoEnabled | 启用回显,启用后可以自己订阅主题并自已发布和接收。默认值为不启用 | ui.form-name.cloudmessage-name.echoEnabled=true 启用回显 |
方法
名称 | 功能说明 | 脚本例子 |
---|---|---|
isConnected() | 是否已连接服务器 | var connected = ui.form-name.cloudmessage-name.isConnected() |
publish(topic, payload) | 发布消息,topic为主题,payload为内容 | ui.form-name.cloudmessage-name.publish('test1', 'hello') |
publishRetained(topic, payload) | 发布保留消息,topic为主题,payload为内容。保留消息会一直保存在云服务器的缓存中,订阅者订阅后立即就会收到之前的保留消息 | ui.form-name.cloudmessage-name.publishRetained('test', 'hello') |
setWillTopic(topic, payload) | 设置遗愿消息,topic为主题,payload为内容。必须在connect()之前调用此方法。设备意外掉线后,订阅者会收到该消息 | ui.form-name.cloudmessage-name.setWillTopic('status', 'offline') |
connect() | 连接云消息服务器 | ui.form-name.cloudmessage-name.connect() |