Partilhar via

Message class

  • Referência
Pacote:
azure-iot-common

O objeto Message é usado para telemetria (dispositivo para nuvem) e comandos (nuvem para dispositivo) mensagens assíncronas entre o dispositivo e o serviço Hub IoT. É independente do transporte, o que significa que funciona da mesma forma sobre AMQP, MQTT e HTTP.

Construtores

Message(BufferConvertible)

Cria um novo objeto Message

Propriedades

ack

Tipo de feedback solicitado (no caso do comando cloud-to-device)
contentEncoding

Codificação de conteúdo do corpo da mensagem. Pode ser 'UTF-8', 'UTF-16' ou 'UTF-32'.
contentType

Propriedade de tipo de conteúdo usada para rotear com o corpo da mensagem. Deve ser 'application/json'.
correlationId

Usado em respostas de mensagens e comentários
data
expiryTimeUtc

Tempo de expiração em UTC interpretado por hub em mensagens C2D. Ignorado em outros casos.
interfaceId

Esta mensagem é uma mensagem de segurança
lockToken

Usado para abandonar, rejeitar ou aceitar a mensagem
messageId

Usado para correlacionar a comunicação bidirecional. Formato: Uma cadeia de caracteres que diferencia maiúsculas de minúsculas (até 128 caracteres de comprimento) de caracteres alfanuméricos ASCII de 7 bits e os seguintes símbolos especiais:
- : . + % _ # * ? ! ( ) , = @ ; $ '.
properties

Um mapa contendo chaves de cadeia de caracteres e valores para armazenar propriedades de mensagens personalizadas.
to

Destino da mensagem.
userId

Usado para especificar a entidade que cria a mensagem

Métodos

getBytes()

Obtém os dados passados para o construtor como um Buffer
getData()

Obtém o conteúdo (corpo) do Message.
isBufferConvertible(any)

Retorna true se o objeto fornecido for do tipo BufferConvertible. Objetos do tipo BufferConvertible podem ser passados para o Message construtor.
setAsSecurityMessage()

Define esta mensagem como uma mensagem de segurança

Detalhes do Construtor

Message(BufferConvertible)

Cria um novo objeto Message

new Message(data: BufferConvertible)

Parâmetros

data
BufferConvertible

um objeto Node Buffer ou qualquer coisa que possa ser passada para o construtor Buffer para construir um Buffer de.

Detalhes de Propriedade

ack

Tipo de feedback solicitado (no caso do comando cloud-to-device)

ack: string

Valor de Propriedade

string

contentEncoding

Codificação de conteúdo do corpo da mensagem. Pode ser 'UTF-8', 'UTF-16' ou 'UTF-32'.

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

Valor de Propriedade

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

contentType

Propriedade de tipo de conteúdo usada para rotear com o corpo da mensagem. Deve ser 'application/json'.

contentType: undefined | "application/json"

Valor de Propriedade

undefined | "application/json"

correlationId

Usado em respostas de mensagens e comentários

correlationId: string

Valor de Propriedade

string

data 

data: any

Valor de Propriedade

any

expiryTimeUtc

Tempo de expiração em UTC interpretado por hub em mensagens C2D. Ignorado em outros casos.

expiryTimeUtc: any

Valor de Propriedade

any

interfaceId

Esta mensagem é uma mensagem de segurança

interfaceId: string

Valor de Propriedade

string

lockToken

Usado para abandonar, rejeitar ou aceitar a mensagem

lockToken: string

Valor de Propriedade

string

messageId

Usado para correlacionar a comunicação bidirecional. Formato: Uma cadeia de caracteres que diferencia maiúsculas de minúsculas (até 128 caracteres de comprimento) de caracteres alfanuméricos ASCII de 7 bits e os seguintes símbolos especiais:
- : . + % _ # * ? ! ( ) , = @ ; $ '.

messageId: string

Valor de Propriedade

string

properties

Um mapa contendo chaves de cadeia de caracteres e valores para armazenar propriedades de mensagens personalizadas.

properties: Properties

Valor de Propriedade

Properties

to

Destino da mensagem.

to: string

Valor de Propriedade

string

userId

Usado para especificar a entidade que cria a mensagem

userId: string

Valor de Propriedade

string

Detalhes de Método

getBytes()

Obtém os dados passados para o construtor como um Buffer

function getBytes(): Buffer

Devoluções

Buffer

getData()

Obtém o conteúdo (corpo) do Message.

function getData(): BufferConvertible

Devoluções

BufferConvertible

O conteúdo do Message.

isBufferConvertible(any)

Retorna true se o objeto fornecido for do tipo BufferConvertible. Objetos do tipo BufferConvertible podem ser passados para o Message construtor.

static function isBufferConvertible(obj: any): boolean

Parâmetros

obj

any

Instância do objeto a ser verificada

Devoluções

boolean

True se o objeto for do tipo BufferConvertible

setAsSecurityMessage()

Define esta mensagem como uma mensagem de segurança

function setAsSecurityMessage()