Message class

Paquete:

azure-iot-common

El objeto Message se usa para la telemetría (dispositivo a nube) y la mensajería asincrónica (de nube a dispositivo) entre el dispositivo y el servicio IoT Hub. Es independiente del transporte, lo que significa que funciona de la misma manera a través de AMQP, MQTT y HTTP.

Constructores

Message(BufferConvertible)

Crea un nuevo Message objeto

Propiedades

ack	Tipo de comentarios solicitados (en caso de comando de nube a dispositivo)
contentEncoding	Codificación de contenido del cuerpo del mensaje. Puede ser 'UTF-8', 'UTF-16' o 'UTF-32'.
contentType	Propiedad de tipo de contenido utilizada para enrutar con el cuerpo del mensaje. Debería ser 'application/json'.
correlationId	Se utiliza en respuestas a mensajes y comentarios
data
expiryTimeUtc	Tiempo de expiración en UTC interpretado por el concentrador en mensajes C2D. Ignorado en otros casos.
interfaceId	¿Es este mensaje un mensaje de seguridad?
lockToken	Se utiliza para abandonar, rechazar o aceptar el mensaje
messageId	Se utiliza para correlacionar la comunicación bidireccional. Formato: una cadena que distingue entre mayúsculas y minúsculas (hasta 128 caracteres de longitud) de caracteres alfanuméricos ASCII de 7 bits y los siguientes símbolos especiales: - : . + % _ # * ? ! ( ) , = @ ; $ '.
properties	Mapa que contiene claves de cadena y valores para almacenar propiedades de mensajes personalizados.
to	Destino del mensaje.
userId	Se utiliza para especificar la entidad que crea el mensaje

Métodos

getBytes()	Obtiene los datos pasados al constructor como un búfer
getData()	Obtiene el contenido (cuerpo) del Messagearchivo .
isBufferConvertible(any)	Devuelve true si el objeto especificado es de tipo BufferConvertible. Los objetos de tipo BufferConvertible se pueden pasar al constructor Message .
setAsSecurityMessage()	Establece este mensaje como un mensaje de seguridad

Detalles del constructor

Message(BufferConvertible)

Crea un nuevo Message objeto

new Message(data: BufferConvertible)

Parámetros

data

BufferConvertible

un objeto Node Buffer o cualquier cosa que se pueda pasar al constructor Buffer para construir un Buffer .

Detalles de las propiedades

ack

Tipo de comentarios solicitados (en caso de comando de nube a dispositivo)

ack: string

Valor de propiedad

string

contentEncoding

Codificación de contenido del cuerpo del mensaje. Puede ser 'UTF-8', 'UTF-16' o 'UTF-32'.

contentEncoding: undefined | "utf-8" | "utf-16" | "utf-32"

Valor de propiedad

undefined | "utf-8" | "utf-16" | "utf-32"

contentType

Propiedad de tipo de contenido utilizada para enrutar con el cuerpo del mensaje. Debería ser 'application/json'.

contentType: undefined | "application/json"

Valor de propiedad

undefined | "application/json"

correlationId

Se utiliza en respuestas a mensajes y comentarios

correlationId: string

Valor de propiedad

string

data

data: any

Valor de propiedad

any

expiryTimeUtc

Tiempo de expiración en UTC interpretado por el concentrador en mensajes C2D. Ignorado en otros casos.

expiryTimeUtc: any

Valor de propiedad

any

interfaceId

¿Es este mensaje un mensaje de seguridad?

interfaceId: string

Valor de propiedad

string

lockToken

Se utiliza para abandonar, rechazar o aceptar el mensaje

lockToken: string

Valor de propiedad

string

messageId

Se utiliza para correlacionar la comunicación bidireccional. Formato: una cadena que distingue entre mayúsculas y minúsculas (hasta 128 caracteres de longitud) de caracteres alfanuméricos ASCII de 7 bits y los siguientes símbolos especiales:
- : . + % _ # * ? ! ( ) , = @ ; $ '.

messageId: string

Valor de propiedad

string

properties

Mapa que contiene claves de cadena y valores para almacenar propiedades de mensajes personalizados.

properties: Properties

Valor de propiedad

Properties

to

Destino del mensaje.

to: string

Valor de propiedad

string

userId

Se utiliza para especificar la entidad que crea el mensaje

userId: string

Valor de propiedad

string

Detalles del método

getBytes()

Obtiene los datos pasados al constructor como un búfer

function getBytes(): Buffer

Devoluciones

Buffer

getData()

Obtiene el contenido (cuerpo) del Messagearchivo .

function getData(): BufferConvertible

Devoluciones

BufferConvertible

El contenido del Messagearchivo .

isBufferConvertible(any)

Devuelve true si el objeto especificado es de tipo BufferConvertible. Los objetos de tipo BufferConvertible se pueden pasar al constructor Message .

static function isBufferConvertible(obj: any): boolean

Parámetros

obj

any

Instancia de objeto para comprobar

Devoluciones

boolean

True si el objeto es de tipo BufferConvertible

setAsSecurityMessage()

Establece este mensaje como un mensaje de seguridad

function setAsSecurityMessage()