Compartir a través de

Message class

  • Referencia
Paquete:
azure-iot-common

El Message objeto se usa para la mensajería asincrónica de telemetría (dispositivo a nube) y comandos (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 el caso del 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 usada para las rutas con el cuerpo del mensaje. Debe ser "application/json".
correlationId

Se usa en las respuestas y comentarios de los mensajes
data
expiryTimeUtc

Hora de expiración en UTC interpretada por concentrador en mensajes C2D. Se omite en otros casos.
interfaceId

¿Es este mensaje un mensaje de seguridad?
lockToken

Se usa para abandonar, rechazar o aceptar el mensaje
messageId

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

Mapa que contiene claves de cadena y valores para almacenar propiedades de mensaje personalizadas.
to

Destino del mensaje.
userId

Se usa 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) de Message.
isBufferConvertible(any)

Devuelve true si el objeto especificado es del 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 De búfer de nodo o cualquier cosa que se pueda pasar al constructor buffer para construir un búfer a partir de .

Detalles de las propiedades

ack

Tipo de comentarios solicitados (en el caso del 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 usada para las rutas con el cuerpo del mensaje. Debe ser "application/json".

contentType: undefined | "application/json"

Valor de propiedad

undefined | "application/json"

correlationId

Se usa en las respuestas y comentarios de los mensajes

correlationId: string

Valor de propiedad

string

data 

data: any

Valor de propiedad

any

expiryTimeUtc

Hora de expiración en UTC interpretada por concentrador en mensajes C2D. Se omite 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 usa para abandonar, rechazar o aceptar el mensaje

lockToken: string

Valor de propiedad

string

messageId

Se usa para correlacionar la comunicación bidireccional. Formato: cadena con distinción entre mayúsculas y minúsculas (hasta 128 caracteres de longitud) de caracteres alfanuméricos de 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 mensaje personalizadas.

properties: Properties

Valor de propiedad

Properties

to

Destino del mensaje.

to: string

Valor de propiedad

string

userId

Se usa 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) de Message.

function getData(): BufferConvertible

Devoluciones

BufferConvertible

Contenido de Message.

isBufferConvertible(any)

Devuelve true si el objeto especificado es del 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 que se va a comprobar

Devoluciones

boolean

True si el objeto es de tipo BufferConvertible

setAsSecurityMessage()

Establece este mensaje como un mensaje de seguridad

function setAsSecurityMessage()