Compartir a través de

DigitalTwinClient class

  • Referencia
Paquete:
azure-iothub

Constructores

DigitalTwinClient(IoTHubTokenCredentials)

Constructor que también crea una instancia del cliente de capa de protocolo utilizado por DigitalTwinClient.

Métodos

getDigitalTwin(string)

Recupere el gemelo digital de un dispositivo determinado.
getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>)
invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

Invoque un comando en un componente de un dispositivo determinado y obtenga el resultado de él.
invokeComponentCommand(string, string, string, any, DigitalTwinInvokeComponentCommandOptionalParams)

Invoque un comando en un componente de un dispositivo determinado y obtenga el resultado de él.
updateDigitalTwin(string, any[], string | TripleValueCallback<void, HttpOperationResponse>, TripleValueCallback<void, HttpOperationResponse>)
updateDigitalTwin(string, any[], string)

Actualice el gemelo digital de un dispositivo determinado mediante un objeto patch.

Detalles del constructor

DigitalTwinClient(IoTHubTokenCredentials)

Constructor que también crea una instancia del cliente de capa de protocolo utilizado por DigitalTwinClient.

new DigitalTwinClient(creds: IoTHubTokenCredentials)

Parámetros

creds
IoTHubTokenCredentials

Credenciales de token de IoTHub usadas para crear el cliente de capa de protocolo.

Detalles del método

getDigitalTwin(string)

Recupere el gemelo digital de un dispositivo determinado.

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

Parámetros

digitalTwinId

string

Identificador de gemelo digital del dispositivo o módulo especificados. El formato de digitalTwinId es DeviceId[~ModuleId]. ModuleId es opcional.

Devoluciones

Promise<DigitalTwinResponse>

DigitalTwinResponse El objeto devuelto que contiene el gemelo digital más HttpResponse.

getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>) 

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

Parámetros

digitalTwinId

string

callback

TripleValueCallback<DigitalTwin, HttpOperationResponse>

invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

Invoque un comando en un componente de un dispositivo determinado y obtenga el resultado de él.

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

Parámetros

digitalTwinId

string

Identificador del gemelo digital del dispositivo especificado.

commandName

string

argument

any

Argumento de un comando.

options

DigitalTwinInvokeRootLevelCommandOptionalParams

Parámetro opcional para establecer opciones, como connectionTimeoutInSeconds y responseTimeoutInSeconds. ResponseTimeoutInSeconds debe estar dentro de [5; 300]

Devoluciones

Promise<DigitalTwinInvokeRootLevelCommandResponse>

DigitalTwinInvokeRootLevelCommandResponse Resultado del comando invocado que contiene el resultado, el código de estado, el identificador de solicitud y httpResponse analizados.

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

Invoque un comando en un componente de un dispositivo determinado y obtenga el resultado de él.

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

Parámetros

digitalTwinId

string

Identificador del gemelo digital del dispositivo especificado.

componentName

string

Nombre del componente.

commandName

string

Nombre del comando.

argument

any

Argumento de un comando.

options

DigitalTwinInvokeComponentCommandOptionalParams

Parámetro opcional para establecer opciones, como connectionTimeoutInSeconds y responseTimeoutInSeconds. ResponseTimeoutInSeconds debe estar dentro de [5; 300]

Devoluciones

Promise<DigitalTwinInvokeComponentCommandResponse>

DigitalTwinInvokeComponentCommandResponse Resultado del comando invocado que contiene el resultado, el código de estado, el identificador de solicitud y httpResponse analizados.

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

Parámetros

digitalTwinId

string

patch

any[]

eTagOrCallback

string | TripleValueCallback<void, HttpOperationResponse>

callback

TripleValueCallback<void, HttpOperationResponse>

updateDigitalTwin(string, any[], string)

Actualice el gemelo digital de un dispositivo determinado mediante un objeto patch.

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

Parámetros

digitalTwinId

string

Identificador del gemelo digital del dispositivo especificado.

patch

any[]

El objeto patch contiene la parte de actualización de un gemelo digital.

eTag

string

ETag para identificar la revisión.

Devoluciones

Promise<DigitalTwinUpdateResponse>

DigitalTwinUpdateResponse El HTTPesponse.