Message class

  • Referensi
Paket:
azure-iot-common

Objek Message digunakan untuk telemetri (perangkat-ke-cloud) dan perintah (cloud-ke-perangkat) pesan asinkron antara perangkat dan layanan IoT Hub. Ini adalah transport-agnostic, yang berarti bekerja dengan cara yang sama melalui AMQP, MQTT dan HTTP.

Konstruktor

Message(BufferConvertible)

Membuat objek baru Message

Properti

ack

Jenis umpan balik yang diminta (dalam kasus perintah cloud-ke-perangkat)
contentEncoding

Pengodean konten isi pesan. dapat berupa 'utf-8', 'utf-16' atau 'utf-32'.
contentType

Properti jenis konten yang digunakan untuk merutekan dengan isi pesan. Harus 'application/json'.
correlationId

Digunakan dalam respons dan umpan balik pesan
data
expiryTimeUtc

Waktu kedaluwarsa dalam UTC ditafsirkan oleh hub pada pesan C2D. Diabaikan dalam kasus lain.
interfaceId

Apakah pesan ini pesan keamanan
lockToken

Digunakan untuk Mengabaikan, Menolak, atau Menerima pesan
messageId

Digunakan untuk menghubungkan komunikasi dua arah. Format: String peka huruf besar/kecil (panjang hingga 128 karakter) karakter alfanumerik ASCII 7-bit dan simbol khusus berikut:
- : . + % _ # * ? ! ( ) , = @ ; $ '.
properties

Peta yang berisi kunci string dan nilai untuk menyimpan properti pesan kustom.
to

Tujuan pesan.
userId

Digunakan untuk menentukan entitas yang membuat pesan

Metode

getBytes()

Mendapatkan data yang diteruskan ke konstruktor sebagai Buffer
getData()

Mendapatkan konten (isi) dari Message.
isBufferConvertible(any)

Mengembalikan true jika objek yang diberikan berjenis BufferConvertible. Objek jenis BufferConvertible dapat diteruskan ke konstruktor Pesan .
setAsSecurityMessage()

Menyetel pesan ini sebagai pesan keamanan

Detail Konstruktor

Message(BufferConvertible)

Membuat objek baru Message

new Message(data: BufferConvertible)

Parameter

data
BufferConvertible

objek Buffer Simpul atau apa pun yang dapat diteruskan ke konstruktor Buffer untuk membuat Buffer dari.

Detail Properti

ack

Jenis umpan balik yang diminta (dalam kasus perintah cloud-ke-perangkat)

ack: string

Nilai Properti

string

contentEncoding

Pengodean konten isi pesan. dapat berupa 'utf-8', 'utf-16' atau 'utf-32'.

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

Nilai Properti

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

contentType

Properti jenis konten yang digunakan untuk merutekan dengan isi pesan. Harus 'application/json'.

contentType: undefined | "application/json"

Nilai Properti

undefined | "application/json"

correlationId

Digunakan dalam respons dan umpan balik pesan

correlationId: string

Nilai Properti

string

data 

data: any

Nilai Properti

any

expiryTimeUtc

Waktu kedaluwarsa dalam UTC ditafsirkan oleh hub pada pesan C2D. Diabaikan dalam kasus lain.

expiryTimeUtc: any

Nilai Properti

any

interfaceId

Apakah pesan ini pesan keamanan

interfaceId: string

Nilai Properti

string

lockToken

Digunakan untuk Mengabaikan, Menolak, atau Menerima pesan

lockToken: string

Nilai Properti

string

messageId

Digunakan untuk menghubungkan komunikasi dua arah. Format: String peka huruf besar/kecil (panjang hingga 128 karakter) karakter alfanumerik ASCII 7-bit dan simbol khusus berikut:
- : . + % _ # * ? ! ( ) , = @ ; $ '.

messageId: string

Nilai Properti

string

properties

Peta yang berisi kunci string dan nilai untuk menyimpan properti pesan kustom.

properties: Properties

Nilai Properti

Properties

to

Tujuan pesan.

to: string

Nilai Properti

string

userId

Digunakan untuk menentukan entitas yang membuat pesan

userId: string

Nilai Properti

string

Detail Metode

getBytes()

Mendapatkan data yang diteruskan ke konstruktor sebagai Buffer

function getBytes(): Buffer

Mengembalikan

Buffer

getData()

Mendapatkan konten (isi) dari Message.

function getData(): BufferConvertible

Mengembalikan

BufferConvertible

Konten .Message

isBufferConvertible(any)

Mengembalikan true jika objek yang diberikan berjenis BufferConvertible. Objek jenis BufferConvertible dapat diteruskan ke konstruktor Pesan .

static function isBufferConvertible(obj: any): boolean

Parameter

obj

any

instans objek untuk diperiksa

Mengembalikan

boolean

True jika objek berjenis BufferConvertible

setAsSecurityMessage()

Menyetel pesan ini sebagai pesan keamanan

function setAsSecurityMessage()