DigitalTwinClient class

Paket:

azure-iothub

Oluşturucular

DigitalTwinClient(IoTHubTokenCredentials)

Oluşturucu ayrıca DigitalTwinClient tarafından kullanılan Protokol Katmanı İstemcisi'nin bir örneğini oluşturur.

Yöntemler

getDigitalTwin(string)	Belirli bir cihazın Dijital İkizini alma.
getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>)
invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)	Belirli bir cihazın bileşeninde bir komut çağırın ve bunun sonucunu alın.
invokeComponentCommand(string, string, string, any, DigitalTwinInvokeComponentCommandOptionalParams)	Belirli bir cihazın bileşeninde bir komut çağırın ve bunun sonucunu alın.
updateDigitalTwin(string, any[], string | TripleValueCallback<void, HttpOperationResponse>, TripleValueCallback<void, HttpOperationResponse>)
updateDigitalTwin(string, any[], string)	Bir düzeltme eki nesnesi kullanarak belirli bir cihazın Dijital İkizini güncelleştirin.

Oluşturucu Ayrıntıları

DigitalTwinClient(IoTHubTokenCredentials)

Oluşturucu ayrıca DigitalTwinClient tarafından kullanılan Protokol Katmanı İstemcisi'nin bir örneğini oluşturur.

new DigitalTwinClient(creds: IoTHubTokenCredentials)

Parametreler

creds

IoTHubTokenCredentials

Protokol Katmanı istemcisi oluşturmak için kullanılan IoTHub belirteci kimlik bilgileri.

Yöntem Ayrıntıları

getDigitalTwin(string)

Belirli bir cihazın Dijital İkizini alma.

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

Parametreler

digitalTwinId

string

Verilen cihazın veya modülün dijital ikiz kimliği. digitalTwinId biçimi DeviceId[~ModuleId] şeklindedir. ModuleId isteğe bağlıdır.

Döndürülenler

Promise<DigitalTwinResponse>

DigitalTwinResponse Digital Twin ve HttpResponse içeren dönüş nesnesi.

getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>)

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

Parametreler

digitalTwinId

string

callback

TripleValueCallback<DigitalTwin, HttpOperationResponse>

invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

Belirli bir cihazın bileşeninde bir komut çağırın ve bunun sonucunu alın.

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

Parametreler

digitalTwinId

string

Verilen cihazın dijital ikiz kimliği.

commandName

string

argument

any

Bir komutun bağımsız değişkeni.

options

DigitalTwinInvokeRootLevelCommandOptionalParams

connectionTimeoutInSeconds ve responseTimeoutInSeconds gibi seçenekleri ayarlamak için isteğe bağlı parametre. responseTimeoutInSeconds [5; 300] içinde olmalıdır

Döndürülenler

Promise<DigitalTwinInvokeRootLevelCommandResponse>

DigitalTwinInvokeRootLevelCommandResponse Sonuç, durum kodu, istek kimliği ve ayrıştırılan HttpResponse'u içeren çağrılan komutun sonucu.

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

Belirli bir cihazın bileşeninde bir komut çağırın ve bunun sonucunu alın.

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

Parametreler

digitalTwinId

string

Verilen cihazın dijital ikiz kimliği.

componentName

string

Bileşenin adı.

commandName

string

Komutun adı.

argument

any

Bir komutun bağımsız değişkeni.

options

DigitalTwinInvokeComponentCommandOptionalParams

connectionTimeoutInSeconds ve responseTimeoutInSeconds gibi seçenekleri ayarlamak için isteğe bağlı parametre. responseTimeoutInSeconds [5; 300] içinde olmalıdır

Döndürülenler

Promise<DigitalTwinInvokeComponentCommandResponse>

DigitalTwinInvokeComponentCommandResponse Sonuç, durum kodu, istek kimliği ve ayrıştırılan HttpResponse'u içeren çağrılan komutun sonucu.

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>)

Parametreler

digitalTwinId

string

patch

any[]

eTagOrCallback

string | TripleValueCallback<void, HttpOperationResponse>

callback

TripleValueCallback<void, HttpOperationResponse>

updateDigitalTwin(string, any[], string)

Bir düzeltme eki nesnesi kullanarak belirli bir cihazın Dijital İkizini güncelleştirin.

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

Parametreler

digitalTwinId

string

Verilen cihazın dijital ikiz kimliği.

patch

any[]

Düzeltme eki objet, Bir Dijital İkiz'in güncelleştirme bölümünü içerir.

eTag

string

Düzeltme ekini tanımlamak için eTag.

Döndürülenler

Promise<DigitalTwinUpdateResponse>

DigitalTwinUpdateResponse The HTTPesponse.