Share via

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)

パッチ オブジェクトを使用して、特定のデバイスの Digital Twin を更新します。

コンストラクターの詳細

DigitalTwinClient(IoTHubTokenCredentials)

DigitalTwinClient によって使用されるプロトコル層クライアントのインスタンスも作成するコンストラクター。

new DigitalTwinClient(creds: IoTHubTokenCredentials)

パラメーター

creds
IoTHubTokenCredentials

プロトコル層クライアントの作成に使用される IoTHub トークン資格情報。

メソッドの詳細

getDigitalTwin(string)

特定のデバイスのデジタル ツインを取得します。

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

パラメーター

digitalTwinId

string

指定されたデバイスまたはモジュールのデジタル ツイン ID。 digitalTwinId の形式は DeviceId[~ModuleId]です。 ModuleId は省略可能です。

戻り値

Promise<DigitalTwinResponse>

DigitalTwinResponse Digital Twin と HttpResponse を含む return オブジェクト。

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

指定されたデバイスのデジタル ツイン ID。

commandName

string

argument

any

コマンドの引数。

options

DigitalTwinInvokeRootLevelCommandOptionalParams

connectionTimeoutInSeconds や responseTimeoutInSeconds などのオプションを設定する省略可能なパラメーター。 responseTimeoutInSeconds は [5; 300] 以内である必要があります

戻り値

Promise<DigitalTwinInvokeRootLevelCommandResponse>

DigitalTwinInvokeRootLevelCommandResponse 結果、状態コード、要求 ID、解析された HttpResponse を含む呼び出されたコマンドの結果。

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

特定のデバイスのコンポーネントでコマンドを呼び出し、その結果を取得します。

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

パラメーター

digitalTwinId

string

指定されたデバイスのデジタル ツイン ID。

componentName

string

コンポーネントの名前。

commandName

string

コマンドの名前。

argument

any

コマンドの引数。

options

DigitalTwinInvokeComponentCommandOptionalParams

connectionTimeoutInSeconds や responseTimeoutInSeconds などのオプションを設定する省略可能なパラメーター。 responseTimeoutInSeconds は [5; 300] 以内である必要があります

戻り値

Promise<DigitalTwinInvokeComponentCommandResponse>

DigitalTwinInvokeComponentCommandResponse 結果、状態コード、要求 ID、解析された 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)

パッチ オブジェクトを使用して、特定のデバイスの Digital Twin を更新します。

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

パラメーター

digitalTwinId

string

指定されたデバイスのデジタル ツイン ID。

patch

any[]

パッチ オブジェクトには、Digital Twin の更新部分が含まれています。

eTag

string

パッチを識別するための eTag。

戻り値

Promise<DigitalTwinUpdateResponse>

DigitalTwinUpdateResponse HTTPesponse。