Aracılığıyla paylaş

Message class

  • Başvuru
Paket:
azure-iot-common

Message nesnesi, cihaz ile IoT Hub hizmeti arasındaki telemetri (cihazdan buluta) ve komutlar (buluttan cihaza) zaman uyumsuz mesajlaşma için kullanılır. Taşımadan bağımsızdır, yani AMQP, MQTT ve HTTP üzerinde aynı şekilde çalışır.

Oluşturucular

Message(BufferConvertible)

Yeni bir Message nesnesi oluşturur

Özellikler

ack

İstenen geri bildirim türü (buluttan cihaza komut olması durumunda)
contentEncoding

İleti gövdesinin içerik kodlaması. 'utf-8', 'utf-16' veya 'utf-32' olabilir.
contentType

İleti gövdesiyle yönlendirmek için kullanılan içerik türü özelliği. 'application/json' olmalıdır.
correlationId

İleti yanıtlarında ve geri bildirimde kullanılır
data
expiryTimeUtc

UTC'de süre sonu süresi, C2D iletilerinde hub tarafından yorumlanır. Diğer durumlarda yoksayılır.
interfaceId

Bu ileti bir güvenlik iletisi mi?
lockToken

İletiyi Bırakmak, Reddetmek veya Kabul Etmek için Kullanılır
messageId

İki yönlü iletişimi ilişkilendirmek için kullanılır. Biçim: ASCII 7 bit alfasayısal karakterlerden oluşan büyük/küçük harfe duyarlı dize (en fazla 128 karakter uzunluğunda) ve aşağıdaki özel simgeler:
- : . + % _ # * ? ! ( ) , = @ ; $ '.
properties

Özel ileti özelliklerini depolamaya yönelik dize anahtarlarını ve değerlerini içeren bir eşleme.
to

İletinin hedefi.
userId

İletiyi oluşturan varlığı belirtmek için kullanılır

Yöntemler

getBytes()

Oluşturucuya Arabellek olarak geçirilen verileri alır
getData()

Messageiçeriğini (gövdesini) alır.
isBufferConvertible(any)

Verilen nesne BufferConvertibletüründeyse true döndürür. BufferConvertible türündeki nesneler İleti oluşturucusuna geçirilebilir.
setAsSecurityMessage()

Bu iletiyi güvenlik iletisi olarak ayarlar

Oluşturucu Ayrıntıları

Message(BufferConvertible)

Yeni bir Message nesnesi oluşturur

new Message(data: BufferConvertible)

Parametreler

data
BufferConvertible

Node Buffer nesnesi veya Arabellek oluşturmak için Arabellek oluşturucusna geçirilebilen herhangi bir şey.

Özellik Ayrıntıları

ack

İstenen geri bildirim türü (buluttan cihaza komut olması durumunda)

ack: string

Özellik Değeri

string

contentEncoding

İleti gövdesinin içerik kodlaması. 'utf-8', 'utf-16' veya 'utf-32' olabilir.

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

Özellik Değeri

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

contentType

İleti gövdesiyle yönlendirmek için kullanılan içerik türü özelliği. 'application/json' olmalıdır.

contentType: undefined | "application/json"

Özellik Değeri

undefined | "application/json"

correlationId

İleti yanıtlarında ve geri bildirimde kullanılır

correlationId: string

Özellik Değeri

string

data 

data: any

Özellik Değeri

any

expiryTimeUtc

UTC'de süre sonu süresi, C2D iletilerinde hub tarafından yorumlanır. Diğer durumlarda yoksayılır.

expiryTimeUtc: any

Özellik Değeri

any

interfaceId

Bu ileti bir güvenlik iletisi mi?

interfaceId: string

Özellik Değeri

string

lockToken

İletiyi Bırakmak, Reddetmek veya Kabul Etmek için Kullanılır

lockToken: string

Özellik Değeri

string

messageId

İki yönlü iletişimi ilişkilendirmek için kullanılır. Biçim: ASCII 7 bit alfasayısal karakterlerden oluşan büyük/küçük harfe duyarlı dize (en fazla 128 karakter uzunluğunda) ve aşağıdaki özel simgeler:
- : . + % _ # * ? ! ( ) , = @ ; $ '.

messageId: string

Özellik Değeri

string

properties

Özel ileti özelliklerini depolamaya yönelik dize anahtarlarını ve değerlerini içeren bir eşleme.

properties: Properties

Özellik Değeri

Properties

to

İletinin hedefi.

to: string

Özellik Değeri

string

userId

İletiyi oluşturan varlığı belirtmek için kullanılır

userId: string

Özellik Değeri

string

Yöntem Ayrıntıları

getBytes()

Oluşturucuya Arabellek olarak geçirilen verileri alır

function getBytes(): Buffer

Döndürülenler

Buffer

getData()

Messageiçeriğini (gövdesini) alır.

function getData(): BufferConvertible

Döndürülenler

BufferConvertible

Messageiçeriği.

isBufferConvertible(any)

Verilen nesne BufferConvertibletüründeyse true döndürür. BufferConvertible türündeki nesneler İleti oluşturucusuna geçirilebilir.

static function isBufferConvertible(obj: any): boolean

Parametreler

obj

any

denetlenecek nesne örneği

Döndürülenler

boolean

Nesne BufferConvertible türündeyse True

setAsSecurityMessage()

Bu iletiyi güvenlik iletisi olarak ayarlar

function setAsSecurityMessage()