Twin class
Device Twin هو مستند يصف حالة الجهاز المخزن بواسطة مركز Azure IoT وهو متوفر حتى إذا كان الجهاز غير متصل. وهو مبني حول 3 أقسام:
- العلامات: أزواج المفاتيح/القيم التي يمكن الوصول إليها فقط من جانب الخدمة
- الخصائص المطلوبة: تم تحديثها بواسطة خدمة وتلقيها من قبل الجهاز
- الخصائص المبلغ عنها: تم تحديثها بواسطة الجهاز وتلقيها بواسطة الخدمة.
لاحظ أنه على الرغم من أنه احتمال، لا يجب أن تتطابق الخصائص المطلوبة والمبلغ عنها وأن المنطق لمزامنة هاتين المجموعتين، إذا لزم الأمر، يترك لمستخدم SDK.
لمزيد من المعلومات، راجع فهم توائم الجهاز.
الطريقة الموصى بها للحصول على Twin لجهاز معين هي استخدام أسلوب getTwin(string, HttpResponseCallback<Twin>).
المنشئون
| Twin(string | Device |
إنشاء مثيل Twinجديد . الطريقة الموصى بها للحصول على كائن Twin جديد هي استخدام أسلوب getTwin(string, HttpResponseCallback<Twin>). |
الخصائص
| device |
المعرف الفريد لهوية الجهاز المقترن بالتوأم، كما هو موجود في سجل هوية الجهاز. |
| etag | العلامة المستخدمة في التزامن المتفائل لتجنب إصدارات متوازية متعددة من الجهاز المزدوج. |
| model |
معرف النموذج لهوية الجهاز المقترنة بالتوأم، كما هو موجود في سجل هوية الجهاز. |
| module |
معرف الوحدة النمطية للوحدة النمطية المقترنة بالتوأم، كما هو موجود في سجل هوية الجهاز. |
| properties | سرد الخصائص المطلوبة والمبلغ عنها (على التوالي في |
| tags | مجموعة من أزواج المفاتيح/القيم المتوفرة فقط على جانب الخدمة ويمكن استخدامها في الاستعلامات للعثور على أجهزة معينة. |
الأساليب
| get() | |
| get(Incoming |
يحصل على أحدث إصدار من هذا الجهاز المزدوج من خدمة IoT Hub. |
| toJSON() | |
| update(any) | |
| update(any, Incoming |
تحديث الجهاز المزدوج مع التصحيح المقدم كوسيطة. |
تفاصيل المنشئ
Twin(string | DeviceIdentity, Registry)
إنشاء مثيل Twinجديد . الطريقة الموصى بها للحصول على كائن Twin جديد هي استخدام أسلوب getTwin(string, HttpResponseCallback<Twin>).
new Twin(device: string | DeviceIdentity, registryClient: Registry)المعلمات
- device
-
string | DeviceIdentity
سلسلة معرف الجهاز أو كائن يصف الجهاز. إذا كان كائنا، يجب أن يحتوي على خاصية deviceId.
- registryClient
- Registry
عميل سجل HTTP المستخدم لتنفيذ استدعاءات واجهة برمجة تطبيقات REST.
تفاصيل الخاصية
deviceId
المعرف الفريد لهوية الجهاز المقترن بالتوأم، كما هو موجود في سجل هوية الجهاز.
deviceId: stringقيمة الخاصية
string
etag
العلامة المستخدمة في التزامن المتفائل لتجنب إصدارات متوازية متعددة من الجهاز المزدوج.
etag: stringقيمة الخاصية
string
modelId
معرف النموذج لهوية الجهاز المقترنة بالتوأم، كما هو موجود في سجل هوية الجهاز.
modelId?: stringقيمة الخاصية
string
moduleId
معرف الوحدة النمطية للوحدة النمطية المقترنة بالتوأم، كما هو موجود في سجل هوية الجهاز.
moduleId?: stringقيمة الخاصية
string
properties
سرد الخصائص المطلوبة والمبلغ عنها (على التوالي في properties.desiredproperties.reported).
properties: { desired: {[key: string]: any}, reported: {[key: string]: any} }قيمة الخاصية
{ desired: {[key: string]: any}, reported: {[key: string]: any} }
tags
مجموعة من أزواج المفاتيح/القيم المتوفرة فقط على جانب الخدمة ويمكن استخدامها في الاستعلامات للعثور على أجهزة معينة.
tags: {[key: string]: string}قيمة الخاصية
{[key: string]: string}
تفاصيل الأسلوب
get()
function get(): Promise<ResultWithIncomingMessage<Twin>>المرتجعات
Promise<ResultWithIncomingMessage<Twin>>
get(IncomingMessageCallback<Twin>)
يحصل على أحدث إصدار من هذا الجهاز المزدوج من خدمة IoT Hub.
function get(done?: IncomingMessageCallback<Twin>)المعلمات
toJSON()
function toJSON(): objectالمرتجعات
object
update(any)
function update(patch: any): Promise<ResultWithIncomingMessage<Twin>>المعلمات
- patch
-
any
المرتجعات
Promise<ResultWithIncomingMessage<Twin>>
update(any, IncomingMessageCallback<Twin>)
تحديث الجهاز المزدوج مع التصحيح المقدم كوسيطة.
function update(patch: any, done?: IncomingMessageCallback<Twin>)المعلمات
- patch
-
any
كائن يحتوي على القيم الجديدة لتطبيقها على هذا الجهاز المزدوج.