Message class

Pacchetto:

azure-iot-device

L'oggetto Message viene usato per la telemetria (da dispositivo a cloud) e per i comandi (da cloud a dispositivo) per la messaggistica asincrona tra il dispositivo e il servizio hub IoT. È indipendente dal trasporto, ovvero funziona allo stesso modo su AMQP, MQTT e HTTP.

Costruttori

Message(BufferConvertible)

Crea un nuovo oggetto Message

Proprietà

ack	Tipo di feedback richiesto (in caso di comando da cloud a dispositivo)
contentEncoding	Codifica del contenuto del corpo del messaggio. può essere 'utf-8', 'utf-16' o 'utf-32'.
contentType	Proprietà del tipo di contenuto utilizzata per instradare con il corpo del messaggio. Deve essere 'application/json'.
correlationId	Usato nelle risposte e nei commenti dei messaggi
data
expiryTimeUtc	Ora di scadenza in formato UTC interpretata dall'hub nei messaggi C2D. Ignorato in altri casi.
interfaceId	Messaggio di sicurezza
lockToken	Utilizzato per abbandonare, rifiutare o accettare il messaggio
messageId	Usato per correlare la comunicazione bidirezionale. Formato: stringa con distinzione tra maiuscole e minuscole (fino a 128 caratteri char) di caratteri alfanumerici ASCII a 7 bit e i simboli speciali seguenti: - : . + % _ # * ? ! ( ) , = @ ; $ '.
properties	Mappa contenente chiavi stringa e valori per l'archiviazione delle proprietà personalizzate del messaggio.
to	Destinazione del messaggio.
userId	Usato per specificare l'entità che crea il messaggio

Metodi

getBytes()	Ottiene i dati passati al costruttore come Buffer
getData()	Ottiene il contenuto (corpo) del Message.
isBufferConvertible(any)	Ritorna vero se l'oggetto dato è di tipo Message.BufferConvertible. Gli oggetti di tipo Message.BufferConvertible possono essere passati al costruttore Message .
setAsSecurityMessage()	Imposta questo messaggio come messaggio di sicurezza

Dettagli costruttore

Message(BufferConvertible)

Crea un nuovo oggetto Message

new Message(data: BufferConvertible)

Parametri

data

BufferConvertible

un oggetto Buffer Node o qualsiasi elemento che può essere passato al costruttore buffer per costruire un buffer da.

Dettagli proprietà

ack

Tipo di feedback richiesto (in caso di comando da cloud a dispositivo)

ack: string

Valore della proprietà

string

contentEncoding

Codifica del contenuto del corpo del messaggio. può essere 'utf-8', 'utf-16' o 'utf-32'.

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

Valore della proprietà

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

contentType

Proprietà del tipo di contenuto utilizzata per instradare con il corpo del messaggio. Deve essere 'application/json'.

contentType: "application/json" | undefined

Valore della proprietà

"application/json" | undefined

correlationId

Usato nelle risposte e nei commenti dei messaggi

correlationId: string

Valore della proprietà

string

data

data: any

Valore della proprietà

any

expiryTimeUtc

Ora di scadenza in formato UTC interpretata dall'hub nei messaggi C2D. Ignorato in altri casi.

expiryTimeUtc: any

Valore della proprietà

any

interfaceId

Messaggio di sicurezza

interfaceId: string

Valore della proprietà

string

lockToken

Utilizzato per abbandonare, rifiutare o accettare il messaggio

lockToken: string

Valore della proprietà

string

messageId

Usato per correlare la comunicazione bidirezionale. Formato: stringa con distinzione tra maiuscole e minuscole (fino a 128 caratteri char) di caratteri alfanumerici ASCII a 7 bit e i simboli speciali seguenti:
- : . + % _ # * ? ! ( ) , = @ ; $ '.

messageId: string

Valore della proprietà

string

properties

Mappa contenente chiavi stringa e valori per l'archiviazione delle proprietà personalizzate del messaggio.

properties: Properties

Valore della proprietà

Properties

to

Destinazione del messaggio.

to: string

Valore della proprietà

string

userId

Usato per specificare l'entità che crea il messaggio

userId: string

Valore della proprietà

string

Dettagli metodo

getBytes()

Ottiene i dati passati al costruttore come Buffer

function getBytes(): Buffer

Valori restituiti

Buffer

getData()

Ottiene il contenuto (corpo) del Message.

function getData(): BufferConvertible

Valori restituiti

BufferConvertible

Contenuto del Message.

isBufferConvertible(any)

Ritorna vero se l'oggetto dato è di tipo Message.BufferConvertible. Gli oggetti di tipo Message.BufferConvertible possono essere passati al costruttore Message .

static function isBufferConvertible(obj: any): boolean

Parametri

obj

any

Istanza dell'oggetto da controllare

Valori restituiti

boolean

Vero se l'oggetto è di tipo Message.BufferConvertible

setAsSecurityMessage()

Imposta questo messaggio come messaggio di sicurezza

function setAsSecurityMessage()