Twin class

Paket:

azure-iothub

Cihaz İkizi, Azure IoT hub'ı tarafından depolanan ve cihaz çevrimdışı olsa bile kullanılabilen bir cihazın durumunu açıklayan belgedir. Yaklaşık 3 bölümde oluşturulmuş:

• Etiketler: yalnızca hizmet tarafından erişilebilen anahtar/değer çiftleri
• İstenen Özellikler: Bir hizmet tarafından güncelleştirildi ve cihaz tarafından alındı
• Bildirilen Özellikler: cihaz tarafından güncelleştirilir ve hizmet tarafından alınır.

Bu bir olasılık olsa da, istenen ve bildirilen özelliklerin eşleşmesi gerekmediğini ve gerekirse bu iki koleksiyonu eşitleme mantığının SDK kullanıcısına bırakıldığını unutmayın.

Daha fazla bilgi için bkz . Cihaz İkizlerini Anlama.

Belirli bir cihaz için bir Twin elde etmenin önerilen yolu yöntemini kullanmaktır getTwin(string, HttpResponseCallback<Twin>) .

Oluşturucular

Twin(string | DeviceIdentity, Registry)

Yeni Twinbir örneği oluşturur. Yeni Twin bir nesne almak için önerilen yöntem yöntemini kullanmaktır getTwin(string, HttpResponseCallback<Twin>) .

Özellikler

deviceId	cihaz kimliği kayıt defterinde mevcut olduğundan, ikizle ilişkili cihaz kimliğinin benzersiz tanımlayıcısı.
etag	Cihaz ikizinin birden çok paralel sürümünden kaçınmak için iyimser eşzamanlılıkta kullanılan etiket.
modelId	cihaz kimliği kayıt defterinde mevcut olduğundan, ikizle ilişkili cihaz kimliğinin model kimliği.
moduleId	cihaz kimliği kayıt defterinde bulunduğundan, ikizle ilişkili modülün modül tanımlayıcısı.
properties	İstenen ve bildirilen özellikler sözlükleri (sırasıyla ve properties.reportediçindeproperties.desired).
tags	Yalnızca hizmet tarafında kullanılabilen ve belirli cihazları bulmak için sorgularda kullanılabilen anahtar/değer çiftlerinin koleksiyonu.

Yöntemler

get()
get(IncomingMessageCallback<Twin>)	IoT Hub hizmetinden bu cihaz ikizinin en son sürümünü alır.
toJSON()
update(any)
update(any, IncomingMessageCallback<Twin>)	Cihaz ikizini bağımsız değişken olarak sağlanan düzeltme eki ile güncelleştirin.

Oluşturucu Ayrıntıları

Twin(string | DeviceIdentity, Registry)

Yeni Twinbir örneği oluşturur. Yeni Twin bir nesne almak için önerilen yöntem yöntemini kullanmaktır getTwin(string, HttpResponseCallback<Twin>) .

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

Parametreler

device

string | DeviceIdentity

Cihaz tanımlayıcı dizesi veya cihazı açıklayan bir nesne. Bir Object ise, bir deviceId özelliği içermelidir.

registryClient

Registry

REST API çağrılarını yürütmek için kullanılan HTTP kayıt defteri istemcisi.

Özellik Ayrıntıları

deviceId

cihaz kimliği kayıt defterinde mevcut olduğundan, ikizle ilişkili cihaz kimliğinin benzersiz tanımlayıcısı.

deviceId: string

Özellik Değeri

string

etag

Cihaz ikizinin birden çok paralel sürümünden kaçınmak için iyimser eşzamanlılıkta kullanılan etiket.

etag: string

Özellik Değeri

string

modelId

cihaz kimliği kayıt defterinde mevcut olduğundan, ikizle ilişkili cihaz kimliğinin model kimliği.

modelId?: string

Özellik Değeri

string

moduleId

cihaz kimliği kayıt defterinde bulunduğundan, ikizle ilişkili modülün modül tanımlayıcısı.

moduleId?: string

Özellik Değeri

string

properties

İstenen ve bildirilen özellikler sözlükleri (sırasıyla ve properties.reportediçindeproperties.desired).

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

Özellik Değeri

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

tags

Yalnızca hizmet tarafında kullanılabilen ve belirli cihazları bulmak için sorgularda kullanılabilen anahtar/değer çiftlerinin koleksiyonu.

tags: {[key: string]: string}

Özellik Değeri

{[key: string]: string}

Yöntem Ayrıntıları

get()

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

Döndürülenler

Promise<ResultWithIncomingMessage<Twin>>

get(IncomingMessageCallback<Twin>)

IoT Hub hizmetinden bu cihaz ikizinin en son sürümünü alır.

function get(done?: IncomingMessageCallback<Twin>)

Parametreler

done

IncomingMessageCallback<Twin>

İşlem tamamlandığında çağrılacak isteğe bağlı işlev. done üç bağımsız değişkenle çağrılır: Hata nesnesi (null olabilir), oluşturulan cihaz kimliğini temsil eden bir İkiz nesnesi ve günlüğe kaydetme veya hata ayıklama için kullanışlı aktarıma özgü yanıt nesnesi.

toJSON()

function toJSON(): object

Döndürülenler

object

update(any)

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

Parametreler

patch

any

Döndürülenler

Promise<ResultWithIncomingMessage<Twin>>

update(any, IncomingMessageCallback<Twin>)

Cihaz ikizini bağımsız değişken olarak sağlanan düzeltme eki ile güncelleştirin.

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

Parametreler

patch

any

Bu cihaz ikizi için uygulanacak yeni değerleri içeren nesne.

done

IncomingMessageCallback<Twin>

İşlem tamamlandığında çağrılacak isteğe bağlı işlev. done üç bağımsız değişkenle çağrılır: Hata nesnesi (null olabilir), oluşturulan cihaz kimliğini temsil eden bir İkiz nesnesi ve günlüğe kaydetme veya hata ayıklama için kullanışlı aktarıma özgü yanıt nesnesi.