DigitalTwinClient class

  • Referência
Pacote:
azure-iothub

Construtores

DigitalTwinClient(IoTHubTokenCredentials)

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

Métodos

getDigitalTwin(string)

Recupere o Gêmeo Digital de um determinado dispositivo.
getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>)
invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

Invoque um comando em um componente de um dispositivo específico e obtenha o resultado dele.
invokeComponentCommand(string, string, string, any, DigitalTwinInvokeComponentCommandOptionalParams)

Invoque um comando em um componente de um dispositivo específico e obtenha o resultado dele.
updateDigitalTwin(string, any[], string | TripleValueCallback<void, HttpOperationResponse>, TripleValueCallback<void, HttpOperationResponse>)
updateDigitalTwin(string, any[], string)

Atualize o Gêmeo Digital de um determinado dispositivo usando um objeto patch.

Detalhes do construtor

DigitalTwinClient(IoTHubTokenCredentials)

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

new DigitalTwinClient(creds: IoTHubTokenCredentials)

Parâmetros

creds
IoTHubTokenCredentials

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

Detalhes do método

getDigitalTwin(string)

Recupere o Gêmeo Digital de um determinado dispositivo.

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

Parâmetros

digitalTwinId

string

A ID do gêmeo digital do dispositivo ou módulo especificado. O formato de digitalTwinId é DeviceId[~ModuleId]. ModuleId é opcional.

Retornos

Promise<DigitalTwinResponse>

DigitalTwinResponse O objeto de retorno que contém o Gêmeo 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 em um componente de um dispositivo específico e obtenha o resultado dele.

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

Parâmetros

digitalTwinId

string

A ID do gêmeo 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. Os responseTimeoutInSeconds devem estar dentro de [5; 300]

Retornos

Promise<DigitalTwinInvokeRootLevelCommandResponse>

DigitalTwinInvokeRootLevelCommandResponse O resultado do comando invocado que contém o resultado, o código status, a ID da solicitação e o HttpResponse analisado.

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

Invoque um comando em um componente de um dispositivo específico e obtenha o resultado dele.

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

Parâmetros

digitalTwinId

string

A ID do gêmeo 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. Os responseTimeoutInSeconds devem estar dentro de [5; 300]

Retornos

Promise<DigitalTwinInvokeComponentCommandResponse>

DigitalTwinInvokeComponentCommandResponse O resultado do comando invocado que contém o resultado, status código, A ID da solicitação 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 Gêmeo Digital de um determinado dispositivo usando um objeto patch.

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

Parâmetros

digitalTwinId

string

A ID do gêmeo digital do dispositivo especificado.

patch

any[]

O objeto patch contém a parte de atualização de um Gêmeo Digital.

eTag

string

A eTag para identificar o patch.

Retornos

Promise<DigitalTwinUpdateResponse>

DigitalTwinUpdateResponse O HTTPesponse.