Share via

Message class

  • Referenz
Paket:
azure-iot-device

Das Message -Objekt wird für asynchrones Messaging zwischen dem Gerät und dem IoT Hub-Dienst für Telemetriedaten (Gerät zu Cloud) und Befehlen (Cloud-zu-Gerät) verwendet. Es ist transportagnostisch, d. h. es funktioniert genauso wie AMQP, MQTT und HTTP.

Konstruktoren

Message(BufferConvertible)

Erstellt ein neues Message -Objekt.

Eigenschaften

ack

Art des angeforderten Feedbacks (bei Einem Cloud-zu-Gerät-Befehl)
contentEncoding

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

Inhaltstypeigenschaft, die für Routen mit dem Nachrichtentext verwendet wird. Sollte "application/json" sein.
correlationId

Wird in Nachrichtenantworten und Feedback verwendet
data
expiryTimeUtc

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

Ist diese Nachricht eine Sicherheitsmeldung?
lockToken

Wird verwendet, um die Nachricht aufzugeben, abzulehnen oder anzunehmen
messageId

Wird verwendet, um die bidirektionale Kommunikation zu korrelieren. Format: Eine Zeichenfolge(bis zu 128 Zeichen lang) mit alphanumerischen ASCII-Zeichen mit 7-Bit-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 Daten ab, die als Puffer an den Konstruktor übergeben werden.
getData()

Ruft den Inhalt (Text) von ab Message.
isBufferConvertible(any)

Gibt true zurück, wenn das angegebene Objekt vom Typ BufferConvertible ist. 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 ein beliebiges Objekt, das an den Buffer-Konstruktor übergeben werden kann, aus dem ein Buffer erstellt werden kann.

Details zur Eigenschaft

ack

Art des angeforderten Feedbacks (bei Einem Cloud-zu-Gerät-Befehl)

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 für Routen mit dem Nachrichtentext 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 vom Hub für C2D-Nachrichten interpretiert wird. Wird in anderen Fällen ignoriert.

expiryTimeUtc: any

Eigenschaftswert

any

interfaceId

Ist diese Nachricht eine Sicherheitsmeldung?

interfaceId: string

Eigenschaftswert

string

lockToken

Wird verwendet, um die Nachricht aufzugeben, abzulehnen oder anzunehmen

lockToken: string

Eigenschaftswert

string

messageId

Wird verwendet, um die bidirektionale Kommunikation zu korrelieren. Format: Eine Zeichenfolge(bis zu 128 Zeichen lang) mit alphanumerischen ASCII-Zeichen mit 7-Bit-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 Daten ab, die als Puffer an den Konstruktor übergeben werden.

function getBytes(): Buffer

Gibt zurück

Buffer

getData()

Ruft den Inhalt (Text) von ab Message.

function getData(): BufferConvertible

Gibt zurück

BufferConvertible

Der Inhalt von Message.

isBufferConvertible(any)

Gibt true zurück, wenn das angegebene Objekt vom Typ BufferConvertible ist. 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 ist

setAsSecurityMessage()

Legt diese Nachricht als Sicherheitsnachricht fest.

function setAsSecurityMessage()