Megosztás a következőn keresztül:

Message class

  • Referencia
Csomag:
azure-iot-device

A Message objektum telemetriára (eszközről felhőre) és parancsokra (felhőről eszközre) használható aszinkron üzenetküldésre az eszköz és az IoT Hub szolgáltatás között. Ez transport-agnostic, vagyis ugyanúgy működik az AMQP, az MQTT és a HTTP felett.

Konstruktorok

Message(BufferConvertible)

Új Message objektum létrehozása

Tulajdonságok

ack

A kért visszajelzés típusa (felhőből eszközre parancs esetén)
contentEncoding

Az üzenet törzsének tartalomkódolása. lehet "utf-8", "utf-16" vagy "utf-32".
contentType

Az üzenet törzsével való átirányításhoz használt tartalomtípus-tulajdonság. Az "application/json" karakternek kell lennie.
correlationId

Üzenetválaszokban és visszajelzésekben használatos
data
expiryTimeUtc

Lejárati idő UTC-ben, amelyet a központ értelmez a C2D-üzeneteken. Más esetekben figyelmen kívül hagyva.
interfaceId

Ez az üzenet biztonsági üzenet
lockToken

Az üzenet elhagyására, elutasítására vagy elfogadására szolgál
messageId

A kétirányú kommunikáció korrelációja. Formátum: A kis- és nagybetűk megkülönböztetése (legfeljebb 128 karakter hosszú) ASCII 7 bites alfanumerikus karakterekkel és a következő speciális szimbólumokkal:
- : . + % _ # * ? ! ( ) , = @ ; $ '.
properties

Az egyéni üzenettulajdonságok tárolására szolgáló sztringkulcsokat és értékeket tartalmazó térkép.
to

Az üzenet célja.
userId

Az üzenetet létrehozó entitás megadására szolgál

Metódusok

getBytes()

Lekéri a konstruktornak átadott adatokat pufferként
getData()

Lekéri a Messagetartalmát (törzsét).
isBufferConvertible(any)

Igaz értéket ad vissza, ha az adott objektum BufferConvertibletípusú. A BufferConvertible típusú objektumok továbbíthatók a Üzenet konstruktorba.
setAsSecurityMessage()

Az üzenet beállítása biztonsági üzenetként

Konstruktor adatai

Message(BufferConvertible)

Új Message objektum létrehozása

new Message(data: BufferConvertible)

Paraméterek

data
BufferConvertible

egy csomópont puffer objektumot, vagy bármit, amely átadható a Puffer konstruktornak egy puffer létrehozásához.

Tulajdonság adatai

ack

A kért visszajelzés típusa (felhőből eszközre parancs esetén)

ack: string

Tulajdonság értéke

string

contentEncoding

Az üzenet törzsének tartalomkódolása. lehet "utf-8", "utf-16" vagy "utf-32".

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

Tulajdonság értéke

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

contentType

Az üzenet törzsével való átirányításhoz használt tartalomtípus-tulajdonság. Az "application/json" karakternek kell lennie.

contentType: undefined | "application/json"

Tulajdonság értéke

undefined | "application/json"

correlationId

Üzenetválaszokban és visszajelzésekben használatos

correlationId: string

Tulajdonság értéke

string

data 

data: any

Tulajdonság értéke

any

expiryTimeUtc

Lejárati idő UTC-ben, amelyet a központ értelmez a C2D-üzeneteken. Más esetekben figyelmen kívül hagyva.

expiryTimeUtc: any

Tulajdonság értéke

any

interfaceId

Ez az üzenet biztonsági üzenet

interfaceId: string

Tulajdonság értéke

string

lockToken

Az üzenet elhagyására, elutasítására vagy elfogadására szolgál

lockToken: string

Tulajdonság értéke

string

messageId

A kétirányú kommunikáció korrelációja. Formátum: A kis- és nagybetűk megkülönböztetése (legfeljebb 128 karakter hosszú) ASCII 7 bites alfanumerikus karakterekkel és a következő speciális szimbólumokkal:
- : . + % _ # * ? ! ( ) , = @ ; $ '.

messageId: string

Tulajdonság értéke

string

properties

Az egyéni üzenettulajdonságok tárolására szolgáló sztringkulcsokat és értékeket tartalmazó térkép.

properties: Properties

Tulajdonság értéke

Properties

to

Az üzenet célja.

to: string

Tulajdonság értéke

string

userId

Az üzenetet létrehozó entitás megadására szolgál

userId: string

Tulajdonság értéke

string

Metódus adatai

getBytes()

Lekéri a konstruktornak átadott adatokat pufferként

function getBytes(): Buffer

Válaszok

Buffer

getData()

Lekéri a Messagetartalmát (törzsét).

function getData(): BufferConvertible

Válaszok

BufferConvertible

A Messagetartalma.

isBufferConvertible(any)

Igaz értéket ad vissza, ha az adott objektum BufferConvertibletípusú. A BufferConvertible típusú objektumok továbbíthatók a Üzenet konstruktorba.

static function isBufferConvertible(obj: any): boolean

Paraméterek

obj

any

ellenőrizni kívánt objektumpéldány

Válaszok

boolean

Igaz, ha az objektum BufferConvertible

setAsSecurityMessage()

Az üzenet beállítása biztonsági üzenetként

function setAsSecurityMessage()