Condividi tramite

DigitalTwinClient class

  • Riferimento
Pacchetto:
azure-iothub

Costruttori

DigitalTwinClient(IoTHubTokenCredentials)

Costruttore che crea anche un'istanza del client del livello protocollo usato da DigitalTwinClient.

Metodi

getDigitalTwin(string)

Recuperare il gemello digitale di un determinato dispositivo.
getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>)
invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

Richiamare un comando su un componente di un determinato dispositivo e ottenere il risultato.
invokeComponentCommand(string, string, string, any, DigitalTwinInvokeComponentCommandOptionalParams)

Richiamare un comando su un componente di un determinato dispositivo e ottenere il risultato.
updateDigitalTwin(string, any[], string | TripleValueCallback<void, HttpOperationResponse>, TripleValueCallback<void, HttpOperationResponse>)
updateDigitalTwin(string, any[], string)

Aggiornare il gemello digitale di un determinato dispositivo usando un oggetto patch.

Dettagli costruttore

DigitalTwinClient(IoTHubTokenCredentials)

Costruttore che crea anche un'istanza del client del livello protocollo usato da DigitalTwinClient.

new DigitalTwinClient(creds: IoTHubTokenCredentials)

Parametri

creds
IoTHubTokenCredentials

Credenziali del token IoTHub usate per la creazione del client Di livello protocollo.

Dettagli metodo

getDigitalTwin(string)

Recuperare il gemello digitale di un determinato dispositivo.

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

Parametri

digitalTwinId

string

ID del gemello digitale del dispositivo o del modulo specificato. Il formato digitalTwinId è DeviceId[~ModuleId]. ModuleId è facoltativo.

Restituisce

Promise<DigitalTwinResponse>

DigitalTwinResponse L'oggetto restituito contenente Il gemello digitale più HttpResponse.

getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>) 

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

Parametri

digitalTwinId

string

callback

TripleValueCallback<DigitalTwin, HttpOperationResponse>

invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

Richiamare un comando su un componente di un determinato dispositivo e ottenere il risultato.

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

Parametri

digitalTwinId

string

ID del gemello digitale del dispositivo specificato.

commandName

string

argument

any

Argomento di un comando.

options

DigitalTwinInvokeRootLevelCommandOptionalParams

Parametro facoltativo per impostare le opzioni, tra cui connectionTimeoutInSeconds e responseTimeoutInSeconds. ResponseTimeoutInSeconds deve essere compreso in [5; 300]

Restituisce

Promise<DigitalTwinInvokeRootLevelCommandResponse>

DigitalTwinInvokeRootLevelCommandResponse Il risultato del comando richiamato contenente il risultato, il codice di stato, l'ID richiesta e httpResponse analizzato.

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

Richiamare un comando su un componente di un determinato dispositivo e ottenere il risultato.

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

Parametri

digitalTwinId

string

ID del gemello digitale del dispositivo specificato.

componentName

string

Nome del componente.

commandName

string

Nome del comando.

argument

any

Argomento di un comando.

options

DigitalTwinInvokeComponentCommandOptionalParams

Parametro facoltativo per impostare le opzioni, tra cui connectionTimeoutInSeconds e responseTimeoutInSeconds. ResponseTimeoutInSeconds deve essere compreso in [5; 300]

Restituisce

Promise<DigitalTwinInvokeComponentCommandResponse>

DigitalTwinInvokeComponentCommandResponse Il risultato del comando richiamato contenente il risultato, il codice di stato, l'ID richiesta e httpResponse analizzato.

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

Parametri

digitalTwinId

string

patch

any[]

eTagOrCallback

string | TripleValueCallback<void, HttpOperationResponse>

callback

TripleValueCallback<void, HttpOperationResponse>

updateDigitalTwin(string, any[], string)

Aggiornare il gemello digitale di un determinato dispositivo usando un oggetto patch.

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

Parametri

digitalTwinId

string

ID del gemello digitale del dispositivo specificato.

patch

any[]

L'oggetto patch contiene la parte di aggiornamento di un gemello digitale.

eTag

string

ETag per identificare la patch.

Restituisce

Promise<DigitalTwinUpdateResponse>

DigitalTwinUpdateResponse The HTTPesponse.