Twin class

Csomag:

azure-iothub

Az ikereszköz egy Azure IoT Hub által tárolt eszköz állapotát leíró dokumentum, amely akkor is elérhető, ha az eszköz offline állapotban van. 3 részből áll:

• Címkék: kulcs/érték párok csak a szolgáltatásoldalról érhetők el
• Kívánt tulajdonságok: egy szolgáltatás frissíti, és az eszköz fogadja
• Jelentett tulajdonságok: az eszköz frissítette, és a szolgáltatás fogadta.

Vegye figyelembe, hogy bár lehetséges, a kívánt és a jelentett tulajdonságoknak nem kell egyezniük, és hogy a két gyűjtemény szinkronizálásának logikája szükség esetén az SDK felhasználójára marad.

További információ: Az ikereszközök ismertetése.

Egy adott eszközhöz Twin az ajánlott módszer a getTwin(string, HttpResponseCallback<Twin>) metódus használata.

Konstruktorok

Twin(string | DeviceIdentity, Registry)

Új példányt hoz Twinlétre. Az új Twin objektum lekérésének ajánlott módja a getTwin(string, HttpResponseCallback<Twin>) metódus használata.

Tulajdonságok

deviceId	Az ikerpéldányhoz társított eszközidentitás egyedi azonosítója, mivel az megtalálható az eszközidentitás-beállításjegyzékben.
etag	Az optimista egyidejűségben használt címke az ikereszköz több párhuzamos kiadásának elkerülésére szolgál.
modelId	Az ikerpéldányhoz társított eszközidentitás modellazonosítója, mivel az megtalálható az eszközidentitás-beállításjegyzékben.
moduleId	Az ikerpéldányhoz társított modul modulazonosítója, mivel az megtalálható az eszközidentitás-beállításjegyzékben.
properties	A kívánt és jelentett tulajdonságok dictionnaries (vagy a és properties.reported).properties.desired
tags	Olyan kulcs-/értékpárok gyűjteménye, amelyek csak a szolgáltatásoldalon érhetők el, és lekérdezésekben használhatók adott eszközök megkereséséhez.

Metódusok

get()
get(IncomingMessageCallback<Twin>)	Lekéri az ikereszköz legújabb verzióját a IoT Hub szolgáltatásból.
toJSON()
update(any)
update(any, IncomingMessageCallback<Twin>)	Frissítse az ikereszközt argumentumként megadott javítással.

Konstruktor adatai

Twin(string | DeviceIdentity, Registry)

Új példányt hoz Twinlétre. Az új Twin objektum lekérésének ajánlott módja a getTwin(string, HttpResponseCallback<Twin>) metódus használata.

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

Paraméterek

device

string | DeviceIdentity

Eszközazonosító sztring vagy az eszközt leíró objektum. Ha egy objektumnak tartalmaznia kell egy deviceId tulajdonságot.

registryClient

Registry

A REST API-hívások végrehajtásához használt HTTP-beállításjegyzék-ügyfél.

Tulajdonság adatai

deviceId

Az ikerpéldányhoz társított eszközidentitás egyedi azonosítója, mivel az megtalálható az eszközidentitás-beállításjegyzékben.

deviceId: string

Tulajdonság értéke

string

etag

Az optimista egyidejűségben használt címke az ikereszköz több párhuzamos kiadásának elkerülésére szolgál.

etag: string

Tulajdonság értéke

string

modelId

Az ikerpéldányhoz társított eszközidentitás modellazonosítója, mivel az megtalálható az eszközidentitás-beállításjegyzékben.

modelId?: string

Tulajdonság értéke

string

moduleId

Az ikerpéldányhoz társított modul modulazonosítója, mivel az megtalálható az eszközidentitás-beállításjegyzékben.

moduleId?: string

Tulajdonság értéke

string

properties

A kívánt és jelentett tulajdonságok dictionnaries (vagy a és properties.reported).properties.desired

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

Tulajdonság értéke

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

tags

Olyan kulcs-/értékpárok gyűjteménye, amelyek csak a szolgáltatásoldalon érhetők el, és lekérdezésekben használhatók adott eszközök megkereséséhez.

tags: {[key: string]: string}

Tulajdonság értéke

{[key: string]: string}

Metódus adatai

get()

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

Válaszok

Promise<ResultWithIncomingMessage<Twin>>

get(IncomingMessageCallback<Twin>)

Lekéri az ikereszköz legújabb verzióját a IoT Hub szolgáltatásból.

function get(done?: IncomingMessageCallback<Twin>)

Paraméterek

done

IncomingMessageCallback<Twin>

A művelet befejezésekor meghívandó opcionális függvény. done a rendszer három argumentumot fog meghívni: egy Hibaobjektumot (lehet null), egy ikerobjektumot , amely a létrehozott eszközidentitást jelöli, és egy átvitelspecifikus válaszobjektumot, amely hasznos naplózáshoz vagy hibakereséshez.

toJSON()

function toJSON(): object

Válaszok

object

update(any)

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

Paraméterek

patch

any

Válaszok

Promise<ResultWithIncomingMessage<Twin>>

update(any, IncomingMessageCallback<Twin>)

Frissítse az ikereszközt argumentumként megadott javítással.

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

Paraméterek

patch

any

Az ikereszközre alkalmazandó új értékeket tartalmazó objektum.

done

IncomingMessageCallback<Twin>

A művelet befejezésekor meghívandó opcionális függvény. done a rendszer három argumentumot fog meghívni: egy Hibaobjektumot (lehet null), egy ikerobjektumot , amely a létrehozott eszközidentitást jelöli, és egy átvitelspecifikus válaszobjektumot, amely hasznos naplózáshoz vagy hibakereséshez.