Partilhar via

DigitalTwinClient class

  • Referência
Pacote:
azure-iothub

Construtores

DigitalTwinClient(IoTHubTokenCredentials)

Construtor que também cria uma instância do Cliente de Camada de Protocolo utilizado pelo DigitalTwinClient.

Métodos

getDigitalTwin(string)

Obtenha o Duplo Digital de um determinado dispositivo.
getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>)
invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

Invoque um comando num componente de um determinado dispositivo e obtenha o resultado do mesmo.
invokeComponentCommand(string, string, string, any, DigitalTwinInvokeComponentCommandOptionalParams)

Invoque um comando num componente de um determinado dispositivo e obtenha o resultado do mesmo.
updateDigitalTwin(string, any[], string | TripleValueCallback<void, HttpOperationResponse>, TripleValueCallback<void, HttpOperationResponse>)
updateDigitalTwin(string, any[], string)

Atualize o Duplo Digital de um determinado dispositivo com um objeto de patch.

Detalhes do Construtor

DigitalTwinClient(IoTHubTokenCredentials)

Construtor que também cria uma instância do Cliente de Camada de Protocolo utilizado pelo DigitalTwinClient.

new DigitalTwinClient(creds: IoTHubTokenCredentials)

Parâmetros

creds
IoTHubTokenCredentials

As credenciais de token do IoTHub utilizadas para criar o cliente da Camada de Protocolo.

Detalhes de Método

getDigitalTwin(string)

Obtenha o Duplo Digital de um determinado dispositivo.

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

Parâmetros

digitalTwinId

string

O ID do duplo digital do dispositivo ou módulo especificado. O formato digitalTwinId é DeviceId[~ModuleId]. ModuleId é opcional.

Devoluções

Promise<DigitalTwinResponse>

DigitalTwinResponse O objeto de retorno que contém o Duplo Digital e o 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 um comando num componente de um determinado dispositivo e obtenha o resultado do mesmo.

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

Parâmetros

digitalTwinId

string

O ID do duplo digital do dispositivo especificado.

commandName

string

argument

any

O argumento de um comando.

options

DigitalTwinInvokeRootLevelCommandOptionalParams

O parâmetro opcional para definir opções, incluindo connectionTimeoutInSeconds e responseTimeoutInSeconds. O responseTimeoutInSeconds tem de estar dentro de [5; 300]

Devoluções

Promise<DigitalTwinInvokeRootLevelCommandResponse>

DigitalTwinInvokeRootLevelCommandResponse O resultado do comando invocado que contém o resultado, o código de estado, o ID do pedido e o HttpResponse analisado.

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

Invoque um comando num componente de um determinado dispositivo e obtenha o resultado do mesmo.

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

Parâmetros

digitalTwinId

string

O ID do duplo digital do dispositivo especificado.

componentName

string

O nome do componente.

commandName

string

O nome do comando.

argument

any

O argumento de um comando.

options

DigitalTwinInvokeComponentCommandOptionalParams

O parâmetro opcional para definir opções, incluindo connectionTimeoutInSeconds e responseTimeoutInSeconds. O responseTimeoutInSeconds tem de estar dentro de [5; 300]

Devoluções

Promise<DigitalTwinInvokeComponentCommandResponse>

DigitalTwinInvokeComponentCommandResponse O resultado do comando invocado que contém o resultado, o código de estado, o ID do pedido e o HttpResponse analisado.

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)

Atualize o Duplo Digital de um determinado dispositivo com um objeto de patch.

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

Parâmetros

digitalTwinId

string

O ID do duplo digital do dispositivo especificado.

patch

any[]

O patch objet contém a parte de atualização de um Digital Twin.

eTag

string

A eTag para identificar o patch.

Devoluções

Promise<DigitalTwinUpdateResponse>

DigitalTwinUpdateResponse O HTTPesponse.