Message class

  • Ссылка
Пакет:
azure-iot-device

Объект Message используется для асинхронного обмена сообщениями между устройством и службой Центр Интернета вещей телеметрии (с устройства в облако) и команд (из облака в устройство). Он не зависит от транспорта, то есть работает одинаково по amQP, MQTT и HTTP.

Конструкторы

Message(BufferConvertible)

Создает новый Message объект

Свойства

ack

Тип запрошенной обратной связи (в случае команды "из облака на устройство")
contentEncoding

Кодирование содержимого текста сообщения. может быть "utf-8", "utf-16" или "utf-32".
contentType

Свойство типа контента, используемое для маршрутизации с текстом сообщения. Должно иметь значение application/json.
correlationId

Используется в ответах на сообщения и отзывах
data
expiryTimeUtc

Время истечения срока действия в формате UTC интерпретируется концентратором в сообщениях C2D. Игнорируется в других случаях.
interfaceId

Является ли это сообщение сообщением безопасности
lockToken

Используется для отмены, отклонения или принятия сообщения
messageId

Используется для корреляции двусторонней связи. Формат: строка с учетом регистра (до 128 символов) из 7-разрядных буквенно-цифровых символов ASCII и следующие специальные символы:
- : . + % _ # * ? ! ( ) , = @ ; $ '.
properties

Карта, содержащая строковые ключи и значения для хранения пользовательских свойств сообщений.
to

Назначение сообщения.
userId

Используется для указания сущности, создающего сообщение

Методы

getBytes()

Возвращает данные, передаваемые конструктору в качестве буфера.
getData()

Возвращает содержимое (тело) объекта Message.
isBufferConvertible(any)

Возвращает значение true, если данный объект относится к типу BufferConvertible. Объекты типа BufferConvertible можно передать в конструктор Message .
setAsSecurityMessage()

Задает это сообщение в качестве сообщения безопасности

Сведения о конструкторе

Message(BufferConvertible)

Создает новый Message объект

new Message(data: BufferConvertible)

Параметры

data
BufferConvertible

Объект Node Buffer или любой объект, который можно передать в конструктор Buffer для создания буфера .

Сведения о свойстве

ack

Тип запрошенной обратной связи (в случае команды "из облака на устройство")

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

Возвращаемое значение

BufferConvertible

Содержимое Messageобъекта .

isBufferConvertible(any)

Возвращает значение true, если данный объект относится к типу BufferConvertible. Объекты типа BufferConvertible можно передать в конструктор Message .

static function isBufferConvertible(obj: any): boolean

Параметры

obj

any

Проверяемый экземпляр объекта

Возвращаемое значение

boolean

Значение true, если объект относится к типу BufferConvertible

setAsSecurityMessage()

Задает это сообщение в качестве сообщения безопасности

function setAsSecurityMessage()