Udostępnij za pośrednictwem

Message class

  • Odwołanie
Pakiet:
azure-iot-common

Obiekt Message jest używany do telemetrii (urządzenie-chmura) i poleceń (chmura-urządzenie) asynchronicznych komunikatów między urządzeniem a usługą IoT Hub. Jest ona niezależna od transportu, co oznacza, że działa tak samo w przypadku protokołu AMQP, MQTT i HTTP.

Konstruktory

Message(BufferConvertible)

Tworzy nowy obiekt Message

Właściwości

ack

Typ żądanej opinii (w przypadku polecenia chmura-urządzenie)
contentEncoding

Kodowanie zawartości treści wiadomości. może mieć wartość "utf-8", "utf-16" lub "utf-32".
contentType

Właściwość typu zawartości używana do kierowania treści komunikatu. Powinien mieć wartość "application/json".
correlationId

Używane w odpowiedziach komunikatów i opiniach
data
expiryTimeUtc

Czas wygaśnięcia w formacie UTC interpretowany przez centrum w komunikatach C2D. Ignorowane w innych przypadkach.
interfaceId

Czy ten komunikat jest komunikatem zabezpieczeń
lockToken

Służy do porzucenia, odrzucenia lub zaakceptowania wiadomości
messageId

Służy do korelowania komunikacji dwukierunkowej. Format: Ciąg uwzględniający wielkość liter (do 128 znaków długości) znaków alfanumerycznych ASCII 7-bitowych i następujące symbole specjalne:
- : . + % _ # * ? ! ( ) , = @ ; $ '.
properties

Mapa zawierająca klucze ciągów i wartości do przechowywania niestandardowych właściwości komunikatów.
to

Miejsce docelowe wiadomości.
userId

Służy do określania jednostki tworzącej komunikat

Metody

getBytes()

Pobiera dane przekazywane do konstruktora jako buforu
getData()

Pobiera zawartość (treść) Message.
isBufferConvertible(any)

Zwraca wartość true, jeśli dany obiekt ma typ BufferConvertible. Obiekty typu BufferConvertible można przekazać do konstruktora Message.
setAsSecurityMessage()

Ustawia ten komunikat jako komunikat zabezpieczeń

Szczegóły konstruktora

Message(BufferConvertible)

Tworzy nowy obiekt Message

new Message(data: BufferConvertible)

Parametry

data
BufferConvertible

Obiekt Bufor węzła lub dowolny obiekt, który można przekazać do konstruktora buforu w celu utworzenia buforu.

Szczegóły właściwości

ack

Typ żądanej opinii (w przypadku polecenia chmura-urządzenie)

ack: string

Wartość właściwości

string

contentEncoding

Kodowanie zawartości treści wiadomości. może mieć wartość "utf-8", "utf-16" lub "utf-32".

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

Wartość właściwości

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

contentType

Właściwość typu zawartości używana do kierowania treści komunikatu. Powinien mieć wartość "application/json".

contentType: undefined | "application/json"

Wartość właściwości

undefined | "application/json"

correlationId

Używane w odpowiedziach komunikatów i opiniach

correlationId: string

Wartość właściwości

string

data 

data: any

Wartość właściwości

any

expiryTimeUtc

Czas wygaśnięcia w formacie UTC interpretowany przez centrum w komunikatach C2D. Ignorowane w innych przypadkach.

expiryTimeUtc: any

Wartość właściwości

any

interfaceId

Czy ten komunikat jest komunikatem zabezpieczeń

interfaceId: string

Wartość właściwości

string

lockToken

Służy do porzucenia, odrzucenia lub zaakceptowania wiadomości

lockToken: string

Wartość właściwości

string

messageId

Służy do korelowania komunikacji dwukierunkowej. Format: Ciąg uwzględniający wielkość liter (do 128 znaków długości) znaków alfanumerycznych ASCII 7-bitowych i następujące symbole specjalne:
- : . + % _ # * ? ! ( ) , = @ ; $ '.

messageId: string

Wartość właściwości

string

properties

Mapa zawierająca klucze ciągów i wartości do przechowywania niestandardowych właściwości komunikatów.

properties: Properties

Wartość właściwości

Properties

to

Miejsce docelowe wiadomości.

to: string

Wartość właściwości

string

userId

Służy do określania jednostki tworzącej komunikat

userId: string

Wartość właściwości

string

Szczegóły metody

getBytes()

Pobiera dane przekazywane do konstruktora jako buforu

function getBytes(): Buffer

Zwraca

Buffer

getData()

Pobiera zawartość (treść) Message.

function getData(): BufferConvertible

Zwraca

BufferConvertible

Zawartość Message.

isBufferConvertible(any)

Zwraca wartość true, jeśli dany obiekt ma typ BufferConvertible. Obiekty typu BufferConvertible można przekazać do konstruktora Message.

static function isBufferConvertible(obj: any): boolean

Parametry

obj

any

wystąpienie obiektu do sprawdzenia

Zwraca

boolean

Prawda, jeśli obiekt jest typu BufferConvertible

setAsSecurityMessage()

Ustawia ten komunikat jako komunikat zabezpieczeń

function setAsSecurityMessage()