DigitalTwinClient class

套件:

azure-iothub

建構函式

DigitalTwinClient(IoTHubTokenCredentials)

建構函式，也會建立 DigitalTwinClient 所使用的通訊協定層用戶端實例。

方法

getDigitalTwin(string)	擷取指定裝置的數位對應項。
getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>)
invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)	在特定裝置的元件上叫用命令，並取得其結果。
invokeComponentCommand(string, string, string, any, DigitalTwinInvokeComponentCommandOptionalParams)	在特定裝置的元件上叫用命令，並取得其結果。
updateDigitalTwin(string, any[], string | TripleValueCallback<void, HttpOperationResponse>, TripleValueCallback<void, HttpOperationResponse>)
updateDigitalTwin(string, any[], string)	使用修補程式物件更新指定裝置的數位對應項。

建構函式詳細資料

DigitalTwinClient(IoTHubTokenCredentials)

建構函式，也會建立 DigitalTwinClient 所使用的通訊協定層用戶端實例。

new DigitalTwinClient(creds: IoTHubTokenCredentials)

參數

creds

IoTHubTokenCredentials

用於建立通訊協定層用戶端的 IoTHub 權杖認證。

方法詳細資料

getDigitalTwin(string)

擷取指定裝置的數位對應項。

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

參數

digitalTwinId

string

指定裝置或模組的數位對應項識別碼。 digitalTwinId 的格式為 DeviceId[~ModuleId]。 ModuleId 是選擇性的。

傳回

Promise<DigitalTwinResponse>

DigitalTwinResponse 包含 Digital Twin 加上 HttpResponse 的傳回物件。

getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>)

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

參數

digitalTwinId

string

callback

TripleValueCallback<DigitalTwin, HttpOperationResponse>

invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

在特定裝置的元件上叫用命令，並取得其結果。

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

參數

digitalTwinId

string

指定裝置的數位對應項識別碼。

commandName

string

argument

any

命令的引數。

options

DigitalTwinInvokeRootLevelCommandOptionalParams

要設定選項的選擇性參數，包括 connectionTimeoutInSeconds 和 responseTimeoutInSeconds。 responseTimeoutInSeconds 必須位於 [5; 300] 內

傳回

Promise<DigitalTwinInvokeRootLevelCommandResponse>

DigitalTwinInvokeRootLevelCommandResponse 叫用命令的結果，其中包含結果、狀態碼、要求識別碼和剖析的 HttpResponse。

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

在特定裝置的元件上叫用命令，並取得其結果。

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

參數

digitalTwinId

string

指定裝置的數位對應項識別碼。

componentName

string

元件的名稱。

commandName

string

命令的名稱。

argument

any

命令的引數。

options

DigitalTwinInvokeComponentCommandOptionalParams

要設定選項的選擇性參數，包括 connectionTimeoutInSeconds 和 responseTimeoutInSeconds。 responseTimeoutInSeconds 必須位於 [5; 300] 內

傳回

Promise<DigitalTwinInvokeComponentCommandResponse>

DigitalTwinInvokeComponentCommandResponse 叫用命令的結果，其中包含結果、狀態碼、要求識別碼和剖析的 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>)

參數

digitalTwinId

string

patch

any[]

eTagOrCallback

string | TripleValueCallback<void, HttpOperationResponse>

callback

TripleValueCallback<void, HttpOperationResponse>

updateDigitalTwin(string, any[], string)

使用修補程式物件更新指定裝置的數位對應項。

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

參數

digitalTwinId

string

指定裝置的數位對應項識別碼。

patch

any[]

修補程式 objet 包含 Digital Twin 的更新部分。

eTag

string

用於識別修補程式的 eTag。

傳回

Promise<DigitalTwinUpdateResponse>

DigitalTwinUpdateResponse HTTPesponse。