Bagikan melalui

Twin class

Paket:
azure-iothub

Device Twin adalah dokumen yang menjelaskan status perangkat yang disimpan oleh hub Azure IoT dan tersedia bahkan jika perangkat offline. Ini dibangun sekitar 3 bagian:

  • Tag: pasangan kunci/nilai hanya dapat diakses dari sisi layanan
  • Properti yang Diinginkan: diperbarui oleh layanan dan diterima oleh perangkat
  • Properti yang Dilaporkan: diperbarui oleh perangkat dan diterima oleh layanan.

Perhatikan bahwa meskipun itu adalah kemungkinan, properti yang diinginkan dan dilaporkan tidak harus cocok dan bahwa logika untuk menyinkronkan kedua koleksi ini, jika perlu, diserahkan kepada pengguna SDK.

Untuk informasi selengkapnya, lihat Memahami Perangkat Kembar.

Cara yang disarankan untuk mendapatkan Twin untuk perangkat tertentu adalah dengan menggunakan metode getTwin(string, HttpResponseCallback<Twin>).

Konstruktor

Twin(string | DeviceIdentity, Registry)

Membuat instans Twinbaru . Cara yang disarankan untuk mendapatkan objek Twin baru adalah dengan menggunakan metode getTwin(string, HttpResponseCallback<Twin>).

Properti

deviceId

Pengidentifikasi unik identitas perangkat yang terkait dengan kembar, karena ada di registri identitas perangkat.
etag

Tag yang digunakan dalam konkurensi optimis untuk menghindari beberapa edisi paralel perangkat kembar.
modelId

Id Model identitas perangkat yang terkait dengan kembar, karena ada di registri identitas perangkat.
moduleId

Pengidentifikasi modul untuk modul yang terkait dengan kembar, karena ada di registri identitas perangkat.
properties

Kamus properti yang diinginkan dan dilaporkan (masing-masing dalam properties.desired dan properties.reported).
tags

Kumpulan pasangan kunci/nilai yang hanya tersedia di sisi layanan dan dapat digunakan dalam kueri untuk menemukan perangkat tertentu.

Metode

get()
get(IncomingMessageCallback<Twin>)

Mendapatkan versi terbaru perangkat kembar ini dari layanan IoT Hub.
toJSON()
update(any)
update(any, IncomingMessageCallback<Twin>)

Perbarui perangkat kembar dengan patch yang disediakan sebagai argumen.

Detail Konstruktor

Twin(string | DeviceIdentity, Registry)

Membuat instans Twinbaru . Cara yang disarankan untuk mendapatkan objek Twin baru adalah dengan menggunakan metode getTwin(string, HttpResponseCallback<Twin>).

new Twin(device: string | DeviceIdentity, registryClient: Registry)

Parameter

device

string | DeviceIdentity

String pengidentifikasi perangkat atau objek yang menjelaskan perangkat. Jika Objek, objek harus berisi properti deviceId.

registryClient
Registry

Klien registri HTTP yang digunakan untuk menjalankan panggilan REST API.

Detail Properti

deviceId

Pengidentifikasi unik identitas perangkat yang terkait dengan kembar, karena ada di registri identitas perangkat.

deviceId: string

Nilai Properti

string

etag

Tag yang digunakan dalam konkurensi optimis untuk menghindari beberapa edisi paralel perangkat kembar.

etag: string

Nilai Properti

string

modelId

Id Model identitas perangkat yang terkait dengan kembar, karena ada di registri identitas perangkat.

modelId?: string

Nilai Properti

string

moduleId

Pengidentifikasi modul untuk modul yang terkait dengan kembar, karena ada di registri identitas perangkat.

moduleId?: string

Nilai Properti

string

properties

Kamus properti yang diinginkan dan dilaporkan (masing-masing dalam properties.desired dan properties.reported).

properties: { desired: {[key: string]: any}, reported: {[key: string]: any} }

Nilai Properti

{ desired: {[key: string]: any}, reported: {[key: string]: any} }

tags

Kumpulan pasangan kunci/nilai yang hanya tersedia di sisi layanan dan dapat digunakan dalam kueri untuk menemukan perangkat tertentu.

tags: {[key: string]: string}

Nilai Properti

{[key: string]: string}

Detail Metode

get() 

function get(): Promise<ResultWithIncomingMessage<Twin>>

Mengembalikan

Promise<ResultWithIncomingMessage<Twin>>

get(IncomingMessageCallback<Twin>)

Mendapatkan versi terbaru perangkat kembar ini dari layanan IoT Hub.

function get(done?: IncomingMessageCallback<Twin>)

Parameter

done

IncomingMessageCallback<Twin>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (dapat null), objek Twin yang mewakili identitas perangkat yang dibuat, dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.

toJSON() 

function toJSON(): object

Mengembalikan

object

update(any) 

function update(patch: any): Promise<ResultWithIncomingMessage<Twin>>

Parameter

patch

any

Mengembalikan

Promise<ResultWithIncomingMessage<Twin>>

update(any, IncomingMessageCallback<Twin>)

Perbarui perangkat kembar dengan patch yang disediakan sebagai argumen.

function update(patch: any, done?: IncomingMessageCallback<Twin>)

Parameter

patch

any

Objek yang berisi nilai baru untuk diterapkan ke perangkat kembar ini.

done

IncomingMessageCallback<Twin>

Fungsi opsional untuk dipanggil saat operasi selesai. done akan dipanggil dengan tiga argumen: objek Kesalahan (dapat null), objek Twin yang mewakili identitas perangkat yang dibuat, dan objek respons khusus transportasi yang berguna untuk pengelogan atau penelusuran kesalahan.