Megosztás a következőn keresztül:

DigitalTwinClient class

  • Referencia
Csomag:
azure-iothub

Konstruktorok

DigitalTwinClient(IoTHubTokenCredentials)

Konstruktor, amely a DigitalTwinClient által használt protokollréteg-ügyfél egy példányát is létrehozza.

Metódusok

getDigitalTwin(string)

Kérje le egy adott eszköz Digitális ikerpéldányát.
getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>)
invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

Parancs meghívása egy adott eszköz egyik összetevőjén, és annak eredménye.
invokeComponentCommand(string, string, string, any, DigitalTwinInvokeComponentCommandOptionalParams)

Parancs meghívása egy adott eszköz egyik összetevőjén, és annak eredménye.
updateDigitalTwin(string, any[], string | TripleValueCallback<void, HttpOperationResponse>, TripleValueCallback<void, HttpOperationResponse>)
updateDigitalTwin(string, any[], string)

Frissítse egy adott eszköz Digitális ikerpéldányát egy javítási objektummal.

Konstruktor adatai

DigitalTwinClient(IoTHubTokenCredentials)

Konstruktor, amely a DigitalTwinClient által használt protokollréteg-ügyfél egy példányát is létrehozza.

new DigitalTwinClient(creds: IoTHubTokenCredentials)

Paraméterek

creds
IoTHubTokenCredentials

A Protocol Layer-ügyfél létrehozásához használt IoTHub-jogkivonat hitelesítő adatai.

Metódus adatai

getDigitalTwin(string)

Kérje le egy adott eszköz Digitális ikerpéldányát.

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

Paraméterek

digitalTwinId

string

Az adott eszköz vagy modul digitális ikerpéldány-azonosítója. A digitalTwinId formátuma DeviceId[~ModuleId]. A ModuleId megadása nem kötelező.

Válaszok

Promise<DigitalTwinResponse>

DigitalTwinResponse A Digital Twin és a HttpResponse értéket tartalmazó visszatérési objektum.

getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>) 

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

Paraméterek

digitalTwinId

string

callback

TripleValueCallback<DigitalTwin, HttpOperationResponse>

invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

Parancs meghívása egy adott eszköz egyik összetevőjén, és annak eredménye.

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

Paraméterek

digitalTwinId

string

Az adott eszköz digitális ikerpéldány-azonosítója.

commandName

string

argument

any

Egy parancs argumentuma.

options

DigitalTwinInvokeRootLevelCommandOptionalParams

A választható paraméter, amely beállítási lehetőségeket tartalmaz, beleértve a connectionTimeoutInSeconds és a responseTimeoutInSeconds paramétert. A responseTimeoutInSeconds értéknek a következőn belül kell lennie: [5; 300]

Válaszok

Promise<DigitalTwinInvokeRootLevelCommandResponse>

DigitalTwinInvokeRootLevelCommandResponse A meghívott parancs eredménye, amely tartalmazza az eredményt, az állapotkódot, a kérelem azonosítóját és az elemezt HttpResponse-t.

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

Parancs meghívása egy adott eszköz egyik összetevőjén, és annak eredménye.

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

Paraméterek

digitalTwinId

string

Az adott eszköz digitális ikerpéldány-azonosítója.

componentName

string

Az összetevő neve.

commandName

string

A parancs neve.

argument

any

Egy parancs argumentuma.

options

DigitalTwinInvokeComponentCommandOptionalParams

A választható paraméter, amely beállítási lehetőségeket tartalmaz, beleértve a connectionTimeoutInSeconds és a responseTimeoutInSeconds paramétert. A responseTimeoutInSeconds értéknek a következőn belül kell lennie: [5; 300]

Válaszok

Promise<DigitalTwinInvokeComponentCommandResponse>

DigitalTwinInvokeComponentCommandResponse A meghívott parancs eredménye, amely tartalmazza az eredményt, az állapotkódot, a kérelem azonosítóját és az elemezt HttpResponse-t.

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

Paraméterek

digitalTwinId

string

patch

any[]

eTagOrCallback

string | TripleValueCallback<void, HttpOperationResponse>

callback

TripleValueCallback<void, HttpOperationResponse>

updateDigitalTwin(string, any[], string)

Frissítse egy adott eszköz Digitális ikerpéldányát egy javítási objektummal.

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

Paraméterek

digitalTwinId

string

Az adott eszköz digitális ikerpéldány-azonosítója.

patch

any[]

A patch objet tartalmazza a Digital Twin frissítési részét.

eTag

string

A javítás azonosítására szolgáló eTag.

Válaszok

Promise<DigitalTwinUpdateResponse>

DigitalTwinUpdateResponse A HTTPesponse.