Dela via

Message class

  • Referens
Paket:
azure-iot-device

Objektet Message används för telemetri (enhet till moln) och kommandon (moln-till-enhet) asynkrona meddelanden mellan enheten och IoT Hub-tjänsten. Det är transportagnostiskt, vilket innebär att det fungerar på samma sätt över AMQP, MQTT och HTTP.

Konstruktorer

Message(BufferConvertible)

Skapar ett nytt Message objekt

Egenskaper

ack

Typ av feedback som begärs (vid moln-till-enhet-kommando)
contentEncoding

Innehållskodning av meddelandetexten. kan vara "utf-8", "utf-16" eller "utf-32".
contentType

Innehållstypegenskap som används för vägar med meddelandetexten. Ska vara "application/json".
correlationId

Används i meddelandesvar och feedback
data
expiryTimeUtc

Förfallotid i UTC tolkas av hubben på C2D-meddelanden. Ignoreras i andra fall.
interfaceId

Är det här meddelandet ett säkerhetsmeddelande?
lockToken

Används för att överge, avvisa eller acceptera meddelandet
messageId

Används för att korrelera dubbelriktad kommunikation. Format: En skiftlägeskänslig sträng (upp till 128 tecken lång) av 7-bitars ASCII-alfanumeriska tecken och följande specialsymboler:
- : . + % _ # * ? ! ( ) , = @ ; $ '.
properties

En karta som innehåller strängnycklar och värden för lagring av anpassade meddelandeegenskaper.
to

Meddelandets mål.
userId

Används för att ange entiteten som skapar meddelandet

Metoder

getBytes()

Hämtar data som skickas till konstruktorn som en buffert
getData()

Hämtar innehållet (brödtexten) för Message.
isBufferConvertible(any)

Returnerar true om det angivna objektet är av typen BufferConvertible. Objekt av typen BufferConvertible kan skickas till meddelandekonstruktorn.
setAsSecurityMessage()

Anger det här meddelandet som ett säkerhetsmeddelande

Konstruktorinformation

Message(BufferConvertible)

Skapar ett nytt Message objekt

new Message(data: BufferConvertible)

Parametrar

data
BufferConvertible

ett Node Buffer-objekt eller något som kan skickas till buffertkonstruktorn för att konstruera en buffert från.

Egenskapsinformation

ack

Typ av feedback som begärs (vid moln-till-enhet-kommando)

ack: string

Egenskapsvärde

string

contentEncoding

Innehållskodning av meddelandetexten. kan vara "utf-8", "utf-16" eller "utf-32".

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

Egenskapsvärde

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

contentType

Innehållstypegenskap som används för vägar med meddelandetexten. Ska vara "application/json".

contentType: undefined | "application/json"

Egenskapsvärde

undefined | "application/json"

correlationId

Används i meddelandesvar och feedback

correlationId: string

Egenskapsvärde

string

data 

data: any

Egenskapsvärde

any

expiryTimeUtc

Förfallotid i UTC tolkas av hubben på C2D-meddelanden. Ignoreras i andra fall.

expiryTimeUtc: any

Egenskapsvärde

any

interfaceId

Är det här meddelandet ett säkerhetsmeddelande?

interfaceId: string

Egenskapsvärde

string

lockToken

Används för att överge, avvisa eller acceptera meddelandet

lockToken: string

Egenskapsvärde

string

messageId

Används för att korrelera dubbelriktad kommunikation. Format: En skiftlägeskänslig sträng (upp till 128 tecken lång) av 7-bitars ASCII-alfanumeriska tecken och följande specialsymboler:
- : . + % _ # * ? ! ( ) , = @ ; $ '.

messageId: string

Egenskapsvärde

string

properties

En karta som innehåller strängnycklar och värden för lagring av anpassade meddelandeegenskaper.

properties: Properties

Egenskapsvärde

Properties

to

Meddelandets mål.

to: string

Egenskapsvärde

string

userId

Används för att ange entiteten som skapar meddelandet

userId: string

Egenskapsvärde

string

Metodinformation

getBytes()

Hämtar data som skickas till konstruktorn som en buffert

function getBytes(): Buffer

Returer

Buffer

getData()

Hämtar innehållet (brödtexten) för Message.

function getData(): BufferConvertible

Returer

BufferConvertible

Innehållet i Message.

isBufferConvertible(any)

Returnerar true om det angivna objektet är av typen BufferConvertible. Objekt av typen BufferConvertible kan skickas till meddelandekonstruktorn.

static function isBufferConvertible(obj: any): boolean

Parametrar

obj

any

objektinstans att kontrollera

Returer

boolean

Sant om objektet är av typen BufferConvertible

setAsSecurityMessage()

Anger det här meddelandet som ett säkerhetsmeddelande

function setAsSecurityMessage()