Delen via

DigitalTwinClient class

  • Referentie
Pakket:
azure-iothub

Constructors

DigitalTwinClient(IoTHubTokenCredentials)

Constructor die ook een exemplaar maakt van de Protocol Layer Client die wordt gebruikt door de DigitalTwinClient.

Methoden

getDigitalTwin(string)

Haal de Digital Twin van een bepaald apparaat op.
getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>)
invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

Roep een opdracht aan op een onderdeel van een bepaald apparaat en haal het resultaat ervan op.
invokeComponentCommand(string, string, string, any, DigitalTwinInvokeComponentCommandOptionalParams)

Roep een opdracht aan op een onderdeel van een bepaald apparaat en haal het resultaat ervan op.
updateDigitalTwin(string, any[], string | TripleValueCallback<void, HttpOperationResponse>, TripleValueCallback<void, HttpOperationResponse>)
updateDigitalTwin(string, any[], string)

Werk de Digital Twin van een bepaald apparaat bij met behulp van een patchobject.

Constructordetails

DigitalTwinClient(IoTHubTokenCredentials)

Constructor die ook een exemplaar maakt van de Protocol Layer Client die wordt gebruikt door de DigitalTwinClient.

new DigitalTwinClient(creds: IoTHubTokenCredentials)

Parameters

creds
IoTHubTokenCredentials

De IoTHub-tokenreferenties die worden gebruikt voor het maken van de Protocol Layer-client.

Methodedetails

getDigitalTwin(string)

Haal de Digital Twin van een bepaald apparaat op.

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

Parameters

digitalTwinId

string

De digitale dubbel-id van het opgegeven apparaat of de opgegeven module. Indeling van digitalTwinId is DeviceId[~ModuleId]. ModuleId is optioneel.

Retouren

Promise<DigitalTwinResponse>

DigitalTwinResponse Het retourobject met de Digital Twin plus httpresponse.

getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>) 

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

Parameters

digitalTwinId

string

callback

TripleValueCallback<DigitalTwin, HttpOperationResponse>

invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

Roep een opdracht aan op een onderdeel van een bepaald apparaat en haal het resultaat ervan op.

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

Parameters

digitalTwinId

string

De digitale dubbel-id van het opgegeven apparaat.

commandName

string

argument

any

Het argument van een opdracht.

options

DigitalTwinInvokeRootLevelCommandOptionalParams

De optionele parameter voor het instellen van opties, waaronder connectionTimeoutInSeconds en responseTimeoutInSeconds. De responseTimeoutInSeconds moeten zich binnen [5; 300]

Retouren

Promise<DigitalTwinInvokeRootLevelCommandResponse>

DigitalTwinInvokeRootLevelCommandResponse Het resultaat van de aangeroepen opdracht met het resultaat, de statuscode, de aanvraag-id en de geparseerde HttpResponse.

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

Roep een opdracht aan op een onderdeel van een bepaald apparaat en haal het resultaat ervan op.

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

Parameters

digitalTwinId

string

De digitale dubbel-id van het opgegeven apparaat.

componentName

string

De naam van het onderdeel.

commandName

string

De naam van de opdracht.

argument

any

Het argument van een opdracht.

options

DigitalTwinInvokeComponentCommandOptionalParams

De optionele parameter voor het instellen van opties, waaronder connectionTimeoutInSeconds en responseTimeoutInSeconds. De responseTimeoutInSeconds moeten zich binnen [5; 300]

Retouren

Promise<DigitalTwinInvokeComponentCommandResponse>

DigitalTwinInvokeComponentCommandResponse Het resultaat van de aangeroepen opdracht met het resultaat, de statuscode, de aanvraag-id en de geparseerde HttpResponse.

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>)

Parameters

digitalTwinId

string

patch

any[]

eTagOrCallback

string | TripleValueCallback<void, HttpOperationResponse>

callback

TripleValueCallback<void, HttpOperationResponse>

updateDigitalTwin(string, any[], string)

Werk de Digital Twin van een bepaald apparaat bij met behulp van een patchobject.

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

Parameters

digitalTwinId

string

De digitale dubbel-id van het opgegeven apparaat.

patch

any[]

De patch objet bevat het updategedeelte van een Digital Twin.

eTag

string

De eTag voor het identificeren van de patch.

Retouren

Promise<DigitalTwinUpdateResponse>

DigitalTwinUpdateResponse The HTTPesponse.