Message class

  • Referência
Pacote:
azure-iot-common

O Message objeto é utilizado para mensagens assíncronas de telemetria (dispositivo para cloud) e comandos (cloud a dispositivo) entre o dispositivo e o serviço Hub IoT. É transport-agnostic, o que significa que funciona da mesma forma através de AMQP, MQTT e HTTP.

Construtores

Message(BufferConvertible)

Cria um novo Message objeto

Propriedades

ack

Tipo de feedback pedido (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 tipo de conteúdo utilizada para rotas com o corpo da mensagem. Deve ser "application/json".
correlationId

Utilizado em respostas e comentários de mensagens
data
expiryTimeUtc

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

Esta mensagem é uma mensagem de segurança
lockToken

Utilizado para Abandonar, Rejeitar ou Aceitar a mensagem
messageId

Utilizado para correlacionar a comunicação bidirecional. Formato: uma cadeia sensível a maiúsculas e minúsculas (até 128 carateres) de carateres alfanuméricos asCII de 7 bits e os seguintes símbolos especiais:
- : . + % _ # * ? ! ( ) , = @ ; $ '.
properties

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

Destino da mensagem.
userId

Utilizado para especificar a entidade que está a criar a mensagem

Métodos

getBytes()

Obtém os dados transmitidos ao construtor como uma Memória Intermédia
getData()

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

Devolve verdadeiro se o objeto especificado for do tipo BufferConvertible. Os objetos do tipo BufferConvertible podem ser transmitidos para o construtor De mensagens.
setAsSecurityMessage()

Define esta 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 De Memória Intermédia de Nós ou qualquer coisa que possa ser transmitida ao construtor de Memória Intermédia para construir uma Memória Intermédia a partir de.

Detalhes de Propriedade

ack

Tipo de feedback pedido (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 tipo de conteúdo utilizada para rotas com o corpo da mensagem. Deve ser "application/json".

contentType: undefined | "application/json"

Valor de Propriedade

undefined | "application/json"

correlationId

Utilizado em respostas e comentários de mensagens

correlationId: string

Valor de Propriedade

string

data 

data: any

Valor de Propriedade

any

expiryTimeUtc

Tempo de expiração em UTC interpretado pelo hub em mensagens C2D. Ignorado noutros casos.

expiryTimeUtc: any

Valor de Propriedade

any

interfaceId

Esta mensagem é uma mensagem de segurança

interfaceId: string

Valor de Propriedade

string

lockToken

Utilizado para Abandonar, Rejeitar ou Aceitar a mensagem

lockToken: string

Valor de Propriedade

string

messageId

Utilizado para correlacionar a comunicação bidirecional. Formato: uma cadeia sensível a maiúsculas e minúsculas (até 128 carateres) de carateres alfanuméricos asCII de 7 bits e os seguintes símbolos especiais:
- : . + % _ # * ? ! ( ) , = @ ; $ '.

messageId: string

Valor de Propriedade

string

properties

Um mapa que contém chaves de cadeia 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

Utilizado para especificar a entidade que está a criar a mensagem

userId: string

Valor de Propriedade

string

Detalhes de Método

getBytes()

Obtém os dados transmitidos ao construtor como uma Memória Intermédia

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)

Devolve verdadeiro se o objeto especificado for do tipo BufferConvertible. Os objetos do tipo BufferConvertible podem ser transmitidos para o construtor De mensagens.

static function isBufferConvertible(obj: any): boolean

Parâmetros

obj

any

instância do objeto a verificar

Devoluções

boolean

Verdadeiro se o objeto for do tipo BufferConvertible

setAsSecurityMessage()

Define esta mensagem como uma mensagem de segurança

function setAsSecurityMessage()