Freigeben über

DigitalTwinClient class

  • Referenz
Paket:
azure-iothub

Konstruktoren

DigitalTwinClient(IoTHubTokenCredentials)

Konstruktor, der auch eine instance des vom DigitalTwinClient verwendeten Protokollebenenclients erstellt.

Methoden

getDigitalTwin(string)

Rufen Sie den Digitalen Zwilling eines bestimmten Geräts ab.
getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>)
invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

Rufen Sie einen Befehl für eine Komponente eines bestimmten Geräts auf, und rufen Sie das Ergebnis ab.
invokeComponentCommand(string, string, string, any, DigitalTwinInvokeComponentCommandOptionalParams)

Rufen Sie einen Befehl für eine Komponente eines bestimmten Geräts auf, und rufen Sie das Ergebnis ab.
updateDigitalTwin(string, any[], string | TripleValueCallback<void, HttpOperationResponse>, TripleValueCallback<void, HttpOperationResponse>)
updateDigitalTwin(string, any[], string)

Aktualisieren Sie den Digitalen Zwilling eines bestimmten Geräts mithilfe eines Patchobjekts.

Details zum Konstruktor

DigitalTwinClient(IoTHubTokenCredentials)

Konstruktor, der auch eine instance des vom DigitalTwinClient verwendeten Protokollebenenclients erstellt.

new DigitalTwinClient(creds: IoTHubTokenCredentials)

Parameter

creds
IoTHubTokenCredentials

Die IoTHub-Tokenanmeldeinformationen, die zum Erstellen des Protocol Layer-Clients verwendet werden.

Details zur Methode

getDigitalTwin(string)

Rufen Sie den Digitalen Zwilling eines bestimmten Geräts ab.

function getDigitalTwin(digitalTwinId: string): Promise<DigitalTwinResponse>

Parameter

digitalTwinId

string

Die Digitale Zwillings-ID des angegebenen Geräts oder Moduls. Das Format von digitalTwinId ist DeviceId[~ModuleId]. ModuleId ist optional.

Gibt zurück

Promise<DigitalTwinResponse>

DigitalTwinResponse Das Rückgabeobjekt, das den Digitalen Zwilling plus httpResponse enthält.

getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>) 

function getDigitalTwin(digitalTwinId: string, callback: TripleValueCallback<DigitalTwin, HttpOperationResponse>)

Parameter

digitalTwinId

string

callback

TripleValueCallback<DigitalTwin, HttpOperationResponse>

invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

Rufen Sie einen Befehl für eine Komponente eines bestimmten Geräts auf, und rufen Sie das Ergebnis ab.

function invokeCommand(digitalTwinId: string, commandName: string, argument: any, options?: DigitalTwinInvokeRootLevelCommandOptionalParams): Promise<DigitalTwinInvokeRootLevelCommandResponse>

Parameter

digitalTwinId

string

Die Digitale Zwillings-ID des angegebenen Geräts.

commandName

string

argument

any

Das Argument eines Befehls.

options

DigitalTwinInvokeRootLevelCommandOptionalParams

Der optionale Parameter zum Festlegen von Optionen, einschließlich connectionTimeoutInSeconds und responseTimeoutInSeconds. Die antwortTimeoutInSeconds müssen sich innerhalb von [5; 300]

Gibt zurück

Promise<DigitalTwinInvokeRootLevelCommandResponse>

DigitalTwinInvokeRootLevelCommandResponse Das Ergebnis des aufgerufenen Befehls mit dem Ergebnis, status Code, der Anforderungs-ID und dem analysierten HttpResponse.

invokeComponentCommand(string, string, string, any, DigitalTwinInvokeComponentCommandOptionalParams)

Rufen Sie einen Befehl für eine Komponente eines bestimmten Geräts auf, und rufen Sie das Ergebnis ab.

function invokeComponentCommand(digitalTwinId: string, componentName: string, commandName: string, argument: any, options?: DigitalTwinInvokeComponentCommandOptionalParams): Promise<DigitalTwinInvokeComponentCommandResponse>

Parameter

digitalTwinId

string

Die Digitale Zwillings-ID des angegebenen Geräts.

componentName

string

Der Name der Komponente.

commandName

string

Der Name des Befehls.

argument

any

Das Argument eines Befehls.

options

DigitalTwinInvokeComponentCommandOptionalParams

Der optionale Parameter zum Festlegen von Optionen, einschließlich connectionTimeoutInSeconds und responseTimeoutInSeconds. Die antwortTimeoutInSeconds müssen sich innerhalb von [5; 300]

Gibt zurück

Promise<DigitalTwinInvokeComponentCommandResponse>

DigitalTwinInvokeComponentCommandResponse Das Ergebnis des aufgerufenen Befehls, das das Ergebnis, status Code, die Anforderungs-ID und die analysierte HttpResponse enthält.

updateDigitalTwin(string, any[], string | TripleValueCallback<void, HttpOperationResponse>, TripleValueCallback<void, HttpOperationResponse>) 

function updateDigitalTwin(digitalTwinId: string, patch: any[], eTagOrCallback?: string | TripleValueCallback<void, HttpOperationResponse>, callback?: TripleValueCallback<void, HttpOperationResponse>)

Parameter

digitalTwinId

string

patch

any[]

eTagOrCallback

string | TripleValueCallback<void, HttpOperationResponse>

callback

TripleValueCallback<void, HttpOperationResponse>

updateDigitalTwin(string, any[], string)

Aktualisieren Sie den Digitalen Zwilling eines bestimmten Geräts mithilfe eines Patchobjekts.

function updateDigitalTwin(digitalTwinId: string, patch: any[], eTag?: string): Promise<DigitalTwinUpdateResponse>

Parameter

digitalTwinId

string

Die Digitale Zwillings-ID des angegebenen Geräts.

patch

any[]

Der Patch-Objet enthält den Updateteil eines Digitalen Zwillings.

eTag

string

Das eTag zum Identifizieren des Patches.

Gibt zurück

Promise<DigitalTwinUpdateResponse>

DigitalTwinUpdateResponse Der HTTPesponse.