Udostępnij za pośrednictwem

DigitalTwinClient class

  • Odwołanie
Pakiet:
azure-iothub

Konstruktory

DigitalTwinClient(IoTHubTokenCredentials)

Konstruktor, który tworzy również wystąpienie klienta warstwy protokołu używanego przez element DigitalTwinClient.

Metody

getDigitalTwin(string)

Pobierz cyfrową reprezentację bliźniaczą danego urządzenia.
getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>)
invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

Wywołaj polecenie w składniku określonego urządzenia i uzyskaj jego wynik.
invokeComponentCommand(string, string, string, any, DigitalTwinInvokeComponentCommandOptionalParams)

Wywołaj polecenie w składniku określonego urządzenia i uzyskaj jego wynik.
updateDigitalTwin(string, any[], string | TripleValueCallback<void, HttpOperationResponse>, TripleValueCallback<void, HttpOperationResponse>)
updateDigitalTwin(string, any[], string)

Zaktualizuj usługę Digital Twin danego urządzenia przy użyciu obiektu patch.

Szczegóły konstruktora

DigitalTwinClient(IoTHubTokenCredentials)

Konstruktor, który tworzy również wystąpienie klienta warstwy protokołu używanego przez element DigitalTwinClient.

new DigitalTwinClient(creds: IoTHubTokenCredentials)

Parametry

creds
IoTHubTokenCredentials

Poświadczenia tokenu usługi IoTHub używane do tworzenia klienta warstwy protokołu.

Szczegóły metody

getDigitalTwin(string)

Pobierz cyfrową reprezentację bliźniaczą danego urządzenia.

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

Parametry

digitalTwinId

string

Identyfikator cyfrowej reprezentacji bliźniaczej danego urządzenia lub modułu. Format digitalTwinId to DeviceId[~ModuleId]. ModuleId jest opcjonalny.

Zwraca

Promise<DigitalTwinResponse>

DigitalTwinResponse Obiekt powrotny zawierający usługę Digital Twin i httpResponse.

getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>) 

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

Parametry

digitalTwinId

string

callback

TripleValueCallback<DigitalTwin, HttpOperationResponse>

invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

Wywołaj polecenie w składniku określonego urządzenia i uzyskaj jego wynik.

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

Parametry

digitalTwinId

string

Identyfikator cyfrowej reprezentacji bliźniaczej danego urządzenia.

commandName

string

argument

any

Argument polecenia.

options

DigitalTwinInvokeRootLevelCommandOptionalParams

Opcjonalny parametr służący do ustawiania opcji, w tym connectionTimeoutInSeconds i responseTimeoutInSeconds. OdpowiedźTimeoutInSeconds musi należeć do zakresu [5; 300]

Zwraca

Promise<DigitalTwinInvokeRootLevelCommandResponse>

DigitalTwinInvokeRootLevelCommandResponse Wynik wywołanego polecenia zawierającego wynik, kod stanu, identyfikator żądania i przeanalizowany httpResponse.

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

Wywołaj polecenie w składniku określonego urządzenia i uzyskaj jego wynik.

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

Parametry

digitalTwinId

string

Identyfikator cyfrowej reprezentacji bliźniaczej danego urządzenia.

componentName

string

Nazwa składnika.

commandName

string

Nazwa polecenia.

argument

any

Argument polecenia.

options

DigitalTwinInvokeComponentCommandOptionalParams

Opcjonalny parametr służący do ustawiania opcji, w tym connectionTimeoutInSeconds i responseTimeoutInSeconds. OdpowiedźTimeoutInSeconds musi należeć do zakresu [5; 300]

Zwraca

Promise<DigitalTwinInvokeComponentCommandResponse>

DigitalTwinInvokeComponentCommandResponse Wynik wywołanego polecenia zawierającego wynik, kod stanu, identyfikator żądania i przeanalizowany 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>)

Parametry

digitalTwinId

string

patch

any[]

eTagOrCallback

string | TripleValueCallback<void, HttpOperationResponse>

callback

TripleValueCallback<void, HttpOperationResponse>

updateDigitalTwin(string, any[], string)

Zaktualizuj usługę Digital Twin danego urządzenia przy użyciu obiektu patch.

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

Parametry

digitalTwinId

string

Identyfikator cyfrowej reprezentacji bliźniaczej danego urządzenia.

patch

any[]

Patch objet zawiera część aktualizacji usługi Digital Twin.

eTag

string

Element eTag do identyfikowania poprawki.

Zwraca

Promise<DigitalTwinUpdateResponse>

DigitalTwinUpdateResponse The HTTPesponse.