Delen via

Twin class

  • Referentie
Pakket:
azure-iothub

Een apparaatdubbel is een document waarin de status wordt beschreven van een apparaat dat is opgeslagen door een Azure IoT-hub en beschikbaar is, zelfs als het apparaat offline is. Het is gebouwd rond 3 secties:

  • Tags: sleutel-waardeparen die alleen toegankelijk zijn vanaf de servicezijde
  • Gewenste eigenschappen: bijgewerkt door een service en ontvangen door het apparaat
  • Gerapporteerde eigenschappen: bijgewerkt door het apparaat en ontvangen door de service.

Hoewel dit een mogelijkheid is, hoeven de gewenste en gerapporteerde eigenschappen niet overeen te komen en dat de logica voor het synchroniseren van deze twee verzamelingen, indien nodig, wordt overgelaten aan de gebruiker van de SDK.

Zie Understanding Device Twins (Apparaatdubbels begrijpen) voor meer informatie.

De aanbevolen manier om een Twin voor een specifiek apparaat te verkrijgen, is door de getTwin(string, HttpResponseCallback<Twin>) methode te gebruiken.

Constructors

Twin(string | DeviceIdentity, Registry)

Er wordt een nieuwe geïnstitueert Twin. De aanbevolen manier om een nieuw Twin object op te halen, is door de getTwin(string, HttpResponseCallback<Twin>) methode te gebruiken.

Eigenschappen

deviceId

De unieke id van de apparaat-id die is gekoppeld aan de dubbel, zoals deze bestaat in het register voor apparaat-id's.
etag

Tag die wordt gebruikt in optimistische gelijktijdigheid om meerdere parallelle edities van de apparaatdubbel te voorkomen.
modelId

Model-id van de apparaat-id die is gekoppeld aan de dubbel, zoals deze bestaat in het register voor apparaat-id's.
moduleId

Module-id voor de module die is gekoppeld aan de dubbel, zoals deze bestaat in het apparaat-id-register.
properties

De gewenste en gerapporteerde eigenschappenwoordenlijsten (respectievelijk in properties.desired en properties.reported).
tags

Verzameling van sleutel-waardeparen die alleen beschikbaar zijn aan de servicezijde en kunnen worden gebruikt in query's om specifieke apparaten te vinden.

Methoden

get()
get(IncomingMessageCallback<Twin>)

Hiermee haalt u de nieuwste versie van deze apparaatdubbel op uit de IoT Hub-service.
toJSON()
update(any)
update(any, IncomingMessageCallback<Twin>)

Werk de apparaatdubbel bij met de patch die als argument is opgegeven.

Constructordetails

Twin(string | DeviceIdentity, Registry)

Er wordt een nieuwe geïnstitueert Twin. De aanbevolen manier om een nieuw Twin object op te halen, is door de getTwin(string, HttpResponseCallback<Twin>) methode te gebruiken.

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

Parameters

device

string | DeviceIdentity

Een apparaat-id-tekenreeks of een object dat het apparaat beschrijft. Als het een Object is, moet deze de eigenschap deviceId bevatten.

registryClient
Registry

De HTTP-registerclient die wordt gebruikt voor het uitvoeren van REST API-aanroepen.

Eigenschapdetails

deviceId

De unieke id van de apparaat-id die is gekoppeld aan de dubbel, zoals deze bestaat in het register voor apparaat-id's.

deviceId: string

Waarde van eigenschap

string

etag

Tag die wordt gebruikt in optimistische gelijktijdigheid om meerdere parallelle edities van de apparaatdubbel te voorkomen.

etag: string

Waarde van eigenschap

string

modelId

Model-id van de apparaat-id die is gekoppeld aan de dubbel, zoals deze bestaat in het register voor apparaat-id's.

modelId?: string

Waarde van eigenschap

string

moduleId

Module-id voor de module die is gekoppeld aan de dubbel, zoals deze bestaat in het apparaat-id-register.

moduleId?: string

Waarde van eigenschap

string

properties

De gewenste en gerapporteerde eigenschappenwoordenlijsten (respectievelijk in properties.desired en properties.reported).

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

Waarde van eigenschap

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

tags

Verzameling van sleutel-waardeparen die alleen beschikbaar zijn aan de servicezijde en kunnen worden gebruikt in query's om specifieke apparaten te vinden.

tags: {[key: string]: string}

Waarde van eigenschap

{[key: string]: string}

Methodedetails

get() 

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

Retouren

Promise<ResultWithIncomingMessage<Twin>>

get(IncomingMessageCallback<Twin>)

Hiermee haalt u de nieuwste versie van deze apparaatdubbel op uit de IoT Hub-service.

function get(done?: IncomingMessageCallback<Twin>)

Parameters

done

IncomingMessageCallback<Twin>

De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid. done wordt aangeroepen met drie argumenten: een foutobject (kan null zijn), een dubbelobject dat de gemaakte apparaat-id vertegenwoordigt en een transportspecifiek antwoordobject dat handig is voor logboekregistratie of foutopsporing.

toJSON() 

function toJSON(): object

Retouren

object

update(any) 

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

Parameters

patch

any

Retouren

Promise<ResultWithIncomingMessage<Twin>>

update(any, IncomingMessageCallback<Twin>)

Werk de apparaatdubbel bij met de patch die als argument is opgegeven.

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

Parameters

patch

any

Object met de nieuwe waarden die moeten worden toegepast op deze apparaatdubbel.

done

IncomingMessageCallback<Twin>

De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid. done wordt aangeroepen met drie argumenten: een foutobject (kan null zijn), een dubbelobject dat de gemaakte apparaat-id vertegenwoordigt en een transportspecifiek antwoordobject dat handig is voor logboekregistratie of foutopsporing.