Compartilhar via

Message class

  • Referência
Pacote:
azure-iot-common

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

Construtores

Message(BufferConvertible)

Cria um novo Message objeto

Propriedades

ack

Tipo de comentário solicitado (no caso do comando da nuvem para o dispositivo)
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 rotas com o corpo da mensagem. Deve ser 'application/json'.
correlationId

Usado em respostas e comentários de mensagens
data
expiryTimeUtc

Hora de expiração em UTC interpretada pelo 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 que contém 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)

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

Define essa mensagem como uma mensagem de segurança

Detalhes do construtor

Message(BufferConvertible)

Cria um novo Message objeto

new Message(data: BufferConvertible)

Parâmetros

data
BufferConvertible

um objeto Buffer de Nó ou qualquer coisa que possa ser passada para o construtor buffer do qual construir um Buffer .

Detalhes da propriedade

ack

Tipo de comentário solicitado (no caso do comando da nuvem para o dispositivo)

ack: string

Valor da 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 da propriedade

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

contentType

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

contentType: undefined | "application/json"

Valor da propriedade

undefined | "application/json"

correlationId

Usado em respostas e comentários de mensagens

correlationId: string

Valor da propriedade

string

data 

data: any

Valor da propriedade

any

expiryTimeUtc

Hora de expiração em UTC interpretada pelo hub em mensagens C2D. Ignorado em outros casos.

expiryTimeUtc: any

Valor da propriedade

any

interfaceId

Esta mensagem é uma mensagem de segurança

interfaceId: string

Valor da propriedade

string

lockToken

Usado para abandonar, rejeitar ou aceitar a mensagem

lockToken: string

Valor da 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 da propriedade

string

properties

Um mapa que contém chaves de cadeia de caracteres e valores para armazenar propriedades de mensagens personalizadas.

properties: Properties

Valor da propriedade

Properties

to

Destino da mensagem.

to: string

Valor da propriedade

string

userId

Usado para especificar a entidade que cria a mensagem

userId: string

Valor da propriedade

string

Detalhes do método

getBytes()

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

function getBytes(): Buffer

Retornos

Buffer

getData()

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

function getData(): BufferConvertible

Retornos

BufferConvertible

O conteúdo do Message.

isBufferConvertible(any)

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

static function isBufferConvertible(obj: any): boolean

Parâmetros

obj

any

instância de objeto a ser verificada

Retornos

boolean

True se o objeto for do tipo BufferConvertible

setAsSecurityMessage()

Define essa mensagem como uma mensagem de segurança

function setAsSecurityMessage()