DigitalTwinClient class
Конструкторы
| Digital |
Конструктор, который также создает экземпляр клиента уровня протокола, используемого DigitalTwinClient. |
Методы
| get |
Получение цифрового двойника заданного устройства. |
| get |
|
| invoke |
Вызовите команду для компонента конкретного устройства и получите результат. |
| invoke |
Вызовите команду для компонента конкретного устройства и получите результат. |
| update |
|
| update |
Обновите цифровой двойник данного устройства с помощью объекта patch. |
Сведения о конструкторе
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)
Обновите цифровой двойник данного устройства с помощью объекта patch.
function updateDigitalTwin(digitalTwinId: string, patch: any[], eTag?: string): Promise<DigitalTwinUpdateResponse>Параметры
- digitalTwinId
-
string
Идентификатор цифрового двойника данного устройства.
- patch
-
any[]
Пакет patch objet содержит часть обновления цифрового двойника.
- eTag
-
string
ETag для идентификации исправления.
Возвращаемое значение
Promise<DigitalTwinUpdateResponse>
DigitalTwinUpdateResponse — HTTPesponse.