Message class
Message nesnesi, cihazla IoT Hub hizmeti arasında telemetri (cihazdan buluta) ve komutlar (buluttan cihaza) zaman uyumsuz mesajlaşma için kullanılır. Aktarımdan bağımsızdır, yani AMQP, MQTT ve HTTP üzerinde aynı şekilde çalışır.
Oluşturucular
Message(Buffer |
Yeni Message bir nesne oluşturur |
Özellikler
ack | İstenen geri bildirim türü (buluttan cihaza komut olması durumunda) |
content |
İleti gövdesinin içerik kodlaması. 'utf-8', 'utf-16' veya 'utf-32' olabilir. |
content |
İleti gövdesiyle yönlendirmek için kullanılan içerik türü özelliği. 'application/json' olmalıdır. |
correlation |
İleti yanıtlarında ve geri bildirimde kullanılır |
data | |
expiry |
C2D iletilerinde merkez tarafından yorumlanan UTC'de süre sonu süresi. Diğer durumlarda yoksayılır. |
interface |
Bu ileti bir güvenlik iletisi mi? |
lock |
İletiyi Bırakmak, Reddetmek veya Kabul Etmek için Kullanılır |
message |
İ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 depolamak için dize anahtarları ve değerleri içeren bir eşleme. |
to | İletinin hedefi. |
user |
İletiyi oluşturan varlığı belirtmek için kullanılır |
Yöntemler
get |
Oluşturucuya Arabellek olarak geçirilen verileri alır |
get |
öğesinin içeriğini (gövdesini Message) alır. |
is |
Verilen nesne BufferConvertible türündeyse true döndürür. BufferConvertible türündeki nesneler İleti oluşturucusuna geçirilebilir. |
set |
Bu iletiyi güvenlik iletisi olarak ayarlar |
Oluşturucu Ayrıntıları
Message(BufferConvertible)
Yeni Message bir nesne oluşturur
new Message(data: BufferConvertible)
Parametreler
- data
- BufferConvertible
Bir Node Buffer nesnesi veya arabellek oluşturmak için Buffer oluşturucusundan 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
C2D iletilerinde merkez tarafından yorumlanan UTC'de süre sonu süresi. 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 depolamak için dize anahtarları ve değerleri 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()
öğesinin içeriğini (gövdesini Message) alır.
function getData(): BufferConvertible
Döndürülenler
öğesinin Messageiçeriği.
isBufferConvertible(any)
Verilen nesne BufferConvertible tü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()