Message class
Объект Message используется для асинхронной передачи сообщений телеметрии (устройства в облако) и асинхронного обмена сообщениями между устройством и службой Центра Интернета вещей. Это не зависит от транспорта, что означает, что он работает так же, как AMQP, MQTT и HTTP.
Конструкторы
Message(Buffer |
Создает новый объект Message |
Свойства
ack | Тип запроса обратной связи (в случае команды cloud-to-device) |
content |
Кодировка содержимого текста сообщения. может быть "utf-8", "utf-16" или "utf-32". |
content |
Свойство типа контента, используемое для маршрутов с текстом сообщения. Должен иметь значение application/json. |
correlation |
Используется в ответах сообщениях и отзывах |
data | |
expiry |
Время истечения срока действия в формате UTC, интерпретированное центром в сообщениях C2D. Игнорируется в других случаях. |
interface |
Это сообщение о безопасности |
lock |
Используется для отказа, отклонения или принятия сообщения |
message |
Используется для сопоставления двусторонней связи. Формат: строка с учетом регистра (до 128 символов длиной) 7-битовых буквенно-цифровых символов ASCII и следующие специальные символы: |
properties | Карта, содержащая строковые ключи и значения для хранения настраиваемых свойств сообщения. |
to | Назначение сообщения. |
user |
Используется для указания сущности, создающего сообщение |
Методы
get |
Возвращает данные, передаваемые конструктору в виде буфера |
get |
Возвращает содержимое (текст) Message. |
is |
Возвращает значение true, если заданный объект имеет тип BufferConvertible. Объекты типа BufferConvertible можно передать в конструктор Message. |
set |
Задает это сообщение в качестве сообщения безопасности |
Сведения о конструкторе
Message(BufferConvertible)
Создает новый объект Message
new Message(data: BufferConvertible)
Параметры
- data
- BufferConvertible
Объект буфера узла или любой объект, который можно передать в конструктор буферабуфера для создания буфера.
Сведения о свойстве
ack
Тип запроса обратной связи (в случае команды cloud-to-device)
ack: string
Значение свойства
string
contentEncoding
Кодировка содержимого текста сообщения. может быть "utf-8", "utf-16" или "utf-32".
contentEncoding: undefined | "utf-8" | "utf-16" | "utf-32"
Значение свойства
undefined | "utf-8" | "utf-16" | "utf-32"
contentType
Свойство типа контента, используемое для маршрутов с текстом сообщения. Должен иметь значение application/json.
contentType: undefined | "application/json"
Значение свойства
undefined | "application/json"
correlationId
Используется в ответах сообщениях и отзывах
correlationId: string
Значение свойства
string
data
data: any
Значение свойства
any
expiryTimeUtc
Время истечения срока действия в формате UTC, интерпретированное центром в сообщениях C2D. Игнорируется в других случаях.
expiryTimeUtc: any
Значение свойства
any
interfaceId
Это сообщение о безопасности
interfaceId: string
Значение свойства
string
lockToken
Используется для отказа, отклонения или принятия сообщения
lockToken: string
Значение свойства
string
messageId
Используется для сопоставления двусторонней связи. Формат: строка с учетом регистра (до 128 символов длиной) 7-битовых буквенно-цифровых символов ASCII и следующие специальные символы:
- : . + % _ # * ? ! ( ) , = @ ; $ '
.
messageId: string
Значение свойства
string
properties
Карта, содержащая строковые ключи и значения для хранения настраиваемых свойств сообщения.
properties: Properties
Значение свойства
Properties
to
Назначение сообщения.
to: string
Значение свойства
string
userId
Используется для указания сущности, создающего сообщение
userId: string
Значение свойства
string
Сведения о методе
getBytes()
Возвращает данные, передаваемые конструктору в виде буфера
function getBytes(): Buffer
Возвращаемое значение
Buffer
getData()
Возвращает содержимое (текст) Message.
function getData(): BufferConvertible
Возвращаемое значение
Содержимое Message.
isBufferConvertible(any)
Возвращает значение true, если заданный объект имеет тип BufferConvertible. Объекты типа BufferConvertible можно передать в конструктор Message.
static function isBufferConvertible(obj: any): boolean
Параметры
- obj
-
any
Экземпляр объекта для проверки
Возвращаемое значение
boolean
Значение true, если объект имеет тип BufferConvertible
setAsSecurityMessage()
Задает это сообщение в качестве сообщения безопасности
function setAsSecurityMessage()