Message class
Az Message objektumot telemetria (eszközről felhőre) és parancsok (felhőből eszközre) aszinkron üzenetküldéshez használják az eszköz és a IoT Hub szolgáltatás között. Ez transport-agnostic, ami azt jelenti, hogy ugyanúgy működik amqp, MQTT és HTTP.
Konstruktorok
Message(Buffer |
Új Message objektum létrehozása |
Tulajdonságok
ack | A kért visszajelzés típusa (felhőből eszközre parancs esetén) |
content |
Az üzenettörzs tartalomkódolása. lehet "utf-8", "utf-16" vagy "utf-32". |
content |
Az üzenettörzshöz tartozó útvonalakhoz használt tartalomtípus-tulajdonság. A következőnek kell lennie: "application/json". |
correlation |
Üzenetválaszokban és visszajelzésekben használatos |
data | |
expiry |
A lejárati idő (UTC) a központ által c2D-üzeneteken értelmezve. Más esetekben figyelmen kívül hagyva. |
interface |
Ez az üzenet biztonsági üzenet? |
lock |
Az üzenet elhagyására, elutasítására vagy elfogadására szolgál |
message |
A kétirányú kommunikáció korrelációja. Formátum: Kis- és nagybetűket megkülönböztető sztring (legfeljebb 128 karakter hosszú) ASCII 7 bites alfanumerikus karakterből és az alábbi speciális szimbólumok közül: |
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. |
user |
Az üzenetet létrehozó entitás megadására szolgál |
Metódusok
get |
Lekéri a konstruktornak pufferként átadott adatokat |
get |
Lekéri a tartalmát (törzsét Message). |
is |
Igaz értéket ad vissza, ha a megadott objektum BufferConvertible típusú. A BufferConvertible típusú objektumok átadhatók az üzenetkonstruktornak. |
set |
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
Csomópontpuffer objektum vagy bármi, amely átadható a pufferkonstruktornak a 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 üzenettörzs 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 üzenettörzshöz tartozó útvonalakhoz használt tartalomtípus-tulajdonság. A következőnek kell lennie: "application/json".
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
A lejárati idő (UTC) a központ által c2D-üzeneteken értelmezve. 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: Kis- és nagybetűket megkülönböztető sztring (legfeljebb 128 karakter hosszú) ASCII 7 bites alfanumerikus karakterből és az alábbi speciális szimbólumok közül:- : . + % _ # * ? ! ( ) , = @ ; $ '
.
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()
getData()
Lekéri a tartalmát (törzsét Message).
function getData(): BufferConvertible
Válaszok
A tartalma Message.
isBufferConvertible(any)
Igaz értéket ad vissza, ha a megadott objektum BufferConvertible típusú. A BufferConvertible típusú objektumok átadhatók az üzenetkonstruktornak.
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 típusú
setAsSecurityMessage()
Az üzenet beállítása biztonsági üzenetként
function setAsSecurityMessage()