Message class

الحزمة:

azure-iot-common

يتم استخدام الكائن Message لبيانات تتبع الاستخدام (من جهاز إلى سحابة) والأوامر (من السحابة إلى الجهاز) المراسلة غير المتزامنة بين الجهاز وخدمة IoT Hub. وهو غير محدد النقل، ما يعني أنه يعمل بنفس الطريقة عبر AMQP وMQTT وHTTP.

المنشئون

Message(BufferConvertible)

إنشاء كائن Message جديد

الخصائص

ack	نوع الملاحظات المطلوبة (في حالة الأمر من السحابة إلى الجهاز)
contentEncoding	ترميز المحتوى لنص الرسالة. يمكن أن يكون 'utf-8' أو 'utf-16' أو 'utf-32'.
contentType	خاصية نوع المحتوى المستخدمة في التوجيهات مع نص الرسالة. يجب أن يكون 'application/json'.
correlationId	يستخدم في استجابات الرسائل والملاحظات
data
expiryTimeUtc	يتم تفسير وقت انتهاء الصلاحية بالتوقيت العالمي المتفق عليه حسب المركز على رسائل C2D. تم تجاهله في حالات أخرى.
interfaceId	هل هذه الرسالة هي رسالة أمان
lockToken	يستخدم للتخلي عن الرسالة أو رفضها أو قبولها
messageId	يستخدم لربط الاتصال ثنائي الاتجاه. التنسيق: سلسلة حساسة لحالة الأحرف (يصل طولها إلى 128 حرفا) من الأحرف الأبجدية الرقمية من ASCII 7 بت والرموز الخاصة التالية: - : . + % _ # * ? ! ( ) , = @ ; $ '.
properties	خريطة تحتوي على مفاتيح سلسلة وقيم لتخزين خصائص الرسالة المخصصة.
to	وجهة الرسالة.
userId	يستخدم لتحديد الكيان الذي يقوم بإنشاء الرسالة

الأساليب

getBytes()	يحصل على البيانات التي تم تمريرها إلى الدالة الإنشائية كمخزن مؤقت
getData()	يحصل على محتوى (نص) Message.
isBufferConvertible(any)	إرجاع true إذا كان الكائن المحدد من النوع BufferConvertible. يمكن تمرير الكائنات من النوع BufferConvertible إلى منشئ Message.
setAsSecurityMessage()	تعيين هذه الرسالة كرسالة أمان

تفاصيل المنشئ

Message(BufferConvertible)

إنشاء كائن Message جديد

new Message(data: BufferConvertible)

المعلمات

data

BufferConvertible

كائن المخزن المؤقت العقدة أو أي شيء يمكن تمريره إلى منشئ المخزن المؤقت لإنشاء مخزن مؤقت منه.

تفاصيل الخاصية

ack

نوع الملاحظات المطلوبة (في حالة الأمر من السحابة إلى الجهاز)

ack: string

قيمة الخاصية

string

contentEncoding

ترميز المحتوى لنص الرسالة. يمكن أن يكون 'utf-8' أو 'utf-16' أو 'utf-32'.

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

قيمة الخاصية

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

contentType

خاصية نوع المحتوى المستخدمة في التوجيهات مع نص الرسالة. يجب أن يكون 'application/json'.

contentType: undefined | "application/json"

قيمة الخاصية

undefined | "application/json"

correlationId

يستخدم في استجابات الرسائل والملاحظات

correlationId: string

قيمة الخاصية

string

data

data: any

قيمة الخاصية

any

expiryTimeUtc

يتم تفسير وقت انتهاء الصلاحية بالتوقيت العالمي المتفق عليه حسب المركز على رسائل C2D. تم تجاهله في حالات أخرى.

expiryTimeUtc: any

قيمة الخاصية

any

interfaceId

هل هذه الرسالة هي رسالة أمان

interfaceId: string

قيمة الخاصية

string

lockToken

يستخدم للتخلي عن الرسالة أو رفضها أو قبولها

lockToken: string

قيمة الخاصية

string

messageId

يستخدم لربط الاتصال ثنائي الاتجاه. التنسيق: سلسلة حساسة لحالة الأحرف (يصل طولها إلى 128 حرفا) من الأحرف الأبجدية الرقمية من ASCII 7 بت والرموز الخاصة التالية:
- : . + % _ # * ? ! ( ) , = @ ; $ '.

messageId: string

قيمة الخاصية

string

properties

خريطة تحتوي على مفاتيح سلسلة وقيم لتخزين خصائص الرسالة المخصصة.

properties: Properties

قيمة الخاصية

Properties

to

وجهة الرسالة.

to: string

قيمة الخاصية

string

userId

يستخدم لتحديد الكيان الذي يقوم بإنشاء الرسالة

userId: string

قيمة الخاصية

string

تفاصيل الأسلوب

getBytes()

يحصل على البيانات التي تم تمريرها إلى الدالة الإنشائية كمخزن مؤقت

function getBytes(): Buffer

المرتجعات

Buffer

getData()

يحصل على محتوى (نص) Message.

function getData(): BufferConvertible

المرتجعات

BufferConvertible

محتوى Message.

isBufferConvertible(any)

إرجاع true إذا كان الكائن المحدد من النوع BufferConvertible. يمكن تمرير الكائنات من النوع BufferConvertible إلى منشئ Message.

static function isBufferConvertible(obj: any): boolean

المعلمات

obj

any

مثيل الكائن للتحقق

المرتجعات

boolean

صحيح إذا كان الكائن من النوع BufferConvertible

setAsSecurityMessage()

تعيين هذه الرسالة كرسالة أمان

function setAsSecurityMessage()