DigitalTwinClient class
생성자
| Digital |
또한 DigitalTwinClient에서 사용하는 프로토콜 계층 클라이언트의 instance 만드는 생성자입니다. |
메서드
| get |
지정된 디바이스의 디지털 트윈을 검색합니다. |
| get |
|
| invoke |
특정 디바이스의 구성 요소에서 명령을 호출하고 결과를 가져옵니다. |
| invoke |
특정 디바이스의 구성 요소에서 명령을 호출하고 결과를 가져옵니다. |
| update |
|
| update |
패치 개체를 사용하여 지정된 디바이스의 디지털 트윈을 업데이트합니다. |
생성자 세부 정보
DigitalTwinClient(IoTHubTokenCredentials)
또한 DigitalTwinClient에서 사용하는 프로토콜 계층 클라이언트의 instance 만드는 생성자입니다.
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를 포함하는 반환 개체입니다.
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)
패치 개체를 사용하여 지정된 디바이스의 디지털 트윈을 업데이트합니다.
function updateDigitalTwin(digitalTwinId: string, patch: any[], eTag?: string): Promise<DigitalTwinUpdateResponse>매개 변수
- digitalTwinId
-
string
지정된 디바이스의 디지털 트윈 ID입니다.
- patch
-
any[]
패치 오브젯에는 디지털 트윈의 업데이트 부분이 포함되어 있습니다.
- eTag
-
string
패치를 식별하기 위한 eTag입니다.
반환
Promise<DigitalTwinUpdateResponse>
DigitalTwinUpdateResponse HTTPesponse입니다.