Twin class

Paket:

azure-iothub

En enhetstvilling är ett dokument som beskriver tillståndet för en enhet som lagras av en Azure IoT-hubb och som är tillgänglig även om enheten är offline. Den är byggd i cirka 3 avsnitt:

• Taggar: nyckel/värde-par som endast är tillgängliga från tjänstsidan
• Önskade egenskaper: uppdateras av en tjänst och tas emot av enheten
• Rapporterade egenskaper: uppdateras av enheten och tas emot av tjänsten.

Observera att även om det är en möjlighet, behöver önskade och rapporterade egenskaper inte matcha och att logiken för att synkronisera dessa två samlingar, om det behövs, lämnas till användaren av SDK.

Mer information finns i Understanding Device Twins.

Det rekommenderade sättet att hämta en Twin för en viss enhet är att använda metoden getTwin(string, HttpResponseCallback<Twin>).

Konstruktorer

Twin(string | DeviceIdentity, Registry)

Instansierar en ny Twin. Det rekommenderade sättet att hämta ett nytt Twin objekt är att använda metoden getTwin(string, HttpResponseCallback<Twin>).

Egenskaper

deviceId	Unik identifierare för enhetsidentiteten som är associerad med tvillingen, eftersom den finns i enhetsidentitetsregistret.
etag	Tagg som används i optimistisk samtidighet för att undvika flera parallella utgåvor av enhetstvillingen.
modelId	Modell-ID för enhetsidentiteten som är associerad med tvillingen, eftersom den finns i enhetsidentitetsregistret.
moduleId	Modulidentifierare för modulen som är associerad med tvillingen, eftersom den finns i enhetsidentitetsregistret.
properties	De önskade och rapporterade egenskaper dictionnaries (respektive i properties.desired och properties.reported).
tags	Samling nyckel/värde-par som endast är tillgängliga på tjänstsidan och som kan användas i frågor för att hitta specifika enheter.

Metoder

get()
get(IncomingMessageCallback<Twin>)	Hämtar den senaste versionen av den här enhetstvillingen från IoT Hub-tjänsten.
toJSON()
update(any)
update(any, IncomingMessageCallback<Twin>)	Uppdatera enhetstvillingen med korrigeringen som anges som argument.

Konstruktorinformation

Twin(string | DeviceIdentity, Registry)

Instansierar en ny Twin. Det rekommenderade sättet att hämta ett nytt Twin objekt är att använda metoden getTwin(string, HttpResponseCallback<Twin>).

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

Parametrar

device

string | DeviceIdentity

En enhetsidentifierarsträng eller ett objekt som beskriver enheten. Om ett objekt måste det innehålla en deviceId-egenskap.

registryClient

Registry

HTTP-registerklienten som används för att köra REST API-anrop.

Egenskapsinformation

deviceId

Unik identifierare för enhetsidentiteten som är associerad med tvillingen, eftersom den finns i enhetsidentitetsregistret.

deviceId: string

Egenskapsvärde

string

etag

Tagg som används i optimistisk samtidighet för att undvika flera parallella utgåvor av enhetstvillingen.

etag: string

Egenskapsvärde

string

modelId

Modell-ID för enhetsidentiteten som är associerad med tvillingen, eftersom den finns i enhetsidentitetsregistret.

modelId?: string

Egenskapsvärde

string

moduleId

Modulidentifierare för modulen som är associerad med tvillingen, eftersom den finns i enhetsidentitetsregistret.

moduleId?: string

Egenskapsvärde

string

properties

De önskade och rapporterade egenskaper dictionnaries (respektive i properties.desired och properties.reported).

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

Egenskapsvärde

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

tags

Samling nyckel/värde-par som endast är tillgängliga på tjänstsidan och som kan användas i frågor för att hitta specifika enheter.

tags: {[key: string]: string}

Egenskapsvärde

{[key: string]: string}

Metodinformation

get()

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

Returer

Promise<ResultWithIncomingMessage<Twin>>

get(IncomingMessageCallback<Twin>)

Hämtar den senaste versionen av den här enhetstvillingen från IoT Hub-tjänsten.

function get(done?: IncomingMessageCallback<Twin>)

Parametrar

done

IncomingMessageCallback<Twin>

Den valfria funktionen som ska anropas när åtgärden är klar. done anropas med tre argument: ett felobjekt (kan vara null), ett Twin--objekt som representerar den skapade enhetsidentiteten och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.

toJSON()

function toJSON(): object

Returer

object

update(any)

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

Parametrar

patch

any

Returer

Promise<ResultWithIncomingMessage<Twin>>

update(any, IncomingMessageCallback<Twin>)

Uppdatera enhetstvillingen med korrigeringen som anges som argument.

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

Parametrar

patch

any

Objekt som innehåller de nya värden som ska tillämpas på den här enhetstvillingen.

done

IncomingMessageCallback<Twin>

Den valfria funktionen som ska anropas när åtgärden är klar. done anropas med tre argument: ett felobjekt (kan vara null), ett Twin--objekt som representerar den skapade enhetsidentiteten och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.