Freigeben über

Message class

  • Referenz
Paket:
azure-iot-device

Das Message-Objekt wird für Telemetrie (Geräte-zu-Cloud) und Befehle (Cloud-zu-Gerät) asynchrones Messaging zwischen dem Gerät und dem IoT Hub-Dienst verwendet. Es ist transportagnostisch, d. h., es funktioniert auf die gleiche Weise über AMQP, MQTT und HTTP.

Konstruktoren

Message(BufferConvertible)

Erstellt ein neues Message-Objekt.

Eigenschaften

ack

Typ des angeforderten Feedbacks (im Fall eines Cloud-zu-Gerät-Befehls)
contentEncoding

Inhaltscodierung des Nachrichtentexts. kann 'utf-8', 'utf-16' oder 'utf-32' sein.
contentType

Inhaltstypeigenschaft, die zum Weiterleiten des Nachrichtentexts verwendet wird. Sollte "application/json" sein.
correlationId

Wird in Nachrichtenantworten und Feedback verwendet
data
expiryTimeUtc

Ablaufzeit in UTC, die von Hub für C2D-Nachrichten interpretiert wird. Wird in anderen Fällen ignoriert.
interfaceId

Ist diese Nachricht eine Sicherheitsnachricht
lockToken

Wird verwendet, um die Nachricht aufzugeben, abzulehnen oder zu akzeptieren
messageId

Wird verwendet, um die bidirektionale Kommunikation zu korrelieren. Format: Eine Zeichenfolge mit Groß-/Kleinschreibung (bis zu 128 Zeichen) mit ASCII-7-Bit-alphanumerischen Zeichen und den folgenden Sondersymbolen:
- : . + % _ # * ? ! ( ) , = @ ; $ '.
properties

Eine Zuordnung mit Zeichenfolgenschlüsseln und Werten zum Speichern benutzerdefinierter Nachrichteneigenschaften.
to

Ziel der Nachricht.
userId

Wird verwendet, um die Entität anzugeben, die die Nachricht erstellt.

Methoden

getBytes()

Ruft die an den Konstruktor übergebenen Daten als Buffer
getData()

Ruft den Inhalt (Textkörper) des Messageab.
isBufferConvertible(any)

Gibt true zurück, wenn das angegebene Objekt vom Typ BufferConvertibleist. Objekte vom Typ BufferConvertible können an den Message-Konstruktor übergeben werden.
setAsSecurityMessage()

Legt diese Nachricht als Sicherheitsnachricht fest

Details zum Konstruktor

Message(BufferConvertible)

Erstellt ein neues Message-Objekt.

new Message(data: BufferConvertible)

Parameter

data
BufferConvertible

ein Node Buffer-Objekt oder alles, das an den Buffer-Konstruktor übergeben werden kann, um ein Buffer- zu erstellen.

Details zur Eigenschaft

ack

Typ des angeforderten Feedbacks (im Fall eines Cloud-zu-Gerät-Befehls)

ack: string

Eigenschaftswert

string

contentEncoding

Inhaltscodierung des Nachrichtentexts. kann 'utf-8', 'utf-16' oder 'utf-32' sein.

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

Eigenschaftswert

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

contentType

Inhaltstypeigenschaft, die zum Weiterleiten des Nachrichtentexts verwendet wird. Sollte "application/json" sein.

contentType: undefined | "application/json"

Eigenschaftswert

undefined | "application/json"

correlationId

Wird in Nachrichtenantworten und Feedback verwendet

correlationId: string

Eigenschaftswert

string

data 

data: any

Eigenschaftswert

any

expiryTimeUtc

Ablaufzeit in UTC, die von Hub für C2D-Nachrichten interpretiert wird. Wird in anderen Fällen ignoriert.

expiryTimeUtc: any

Eigenschaftswert

any

interfaceId

Ist diese Nachricht eine Sicherheitsnachricht

interfaceId: string

Eigenschaftswert

string

lockToken

Wird verwendet, um die Nachricht aufzugeben, abzulehnen oder zu akzeptieren

lockToken: string

Eigenschaftswert

string

messageId

Wird verwendet, um die bidirektionale Kommunikation zu korrelieren. Format: Eine Zeichenfolge mit Groß-/Kleinschreibung (bis zu 128 Zeichen) mit ASCII-7-Bit-alphanumerischen Zeichen und den folgenden Sondersymbolen:
- : . + % _ # * ? ! ( ) , = @ ; $ '.

messageId: string

Eigenschaftswert

string

properties

Eine Zuordnung mit Zeichenfolgenschlüsseln und Werten zum Speichern benutzerdefinierter Nachrichteneigenschaften.

properties: Properties

Eigenschaftswert

Properties

to

Ziel der Nachricht.

to: string

Eigenschaftswert

string

userId

Wird verwendet, um die Entität anzugeben, die die Nachricht erstellt.

userId: string

Eigenschaftswert

string

Details zur Methode

getBytes()

Ruft die an den Konstruktor übergebenen Daten als Buffer

function getBytes(): Buffer

Gibt zurück

Buffer

getData()

Ruft den Inhalt (Textkörper) des Messageab.

function getData(): BufferConvertible

Gibt zurück

BufferConvertible

Der Inhalt der Message.

isBufferConvertible(any)

Gibt true zurück, wenn das angegebene Objekt vom Typ BufferConvertibleist. Objekte vom Typ BufferConvertible können an den Message-Konstruktor übergeben werden.

static function isBufferConvertible(obj: any): boolean

Parameter

obj

any

zu überprüfende Objektinstanz

Gibt zurück

boolean

True, wenn das Objekt vom Typ BufferConvertible

setAsSecurityMessage()

Legt diese Nachricht als Sicherheitsnachricht fest

function setAsSecurityMessage()