Share via

DigitalTwinClient class

  • Référence
Paquet:
azure-iothub

Constructeurs

DigitalTwinClient(IoTHubTokenCredentials)

Constructeur qui crée également une instance du client de couche de protocole utilisé par DigitalTwinClient.

Méthodes

getDigitalTwin(string)

Récupérez le jumeau numérique d’un appareil donné.
getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>)
invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

Appelez une commande sur un composant d’un appareil particulier et obtenez le résultat de celle-ci.
invokeComponentCommand(string, string, string, any, DigitalTwinInvokeComponentCommandOptionalParams)

Appelez une commande sur un composant d’un appareil particulier et obtenez le résultat de celle-ci.
updateDigitalTwin(string, any[], string | TripleValueCallback<void, HttpOperationResponse>, TripleValueCallback<void, HttpOperationResponse>)
updateDigitalTwin(string, any[], string)

Mettez à jour le jumeau numérique d’un appareil donné à l’aide d’un objet patch.

Détails du constructeur

DigitalTwinClient(IoTHubTokenCredentials)

Constructeur qui crée également une instance du client de couche de protocole utilisé par DigitalTwinClient.

new DigitalTwinClient(creds: IoTHubTokenCredentials)

Paramètres

creds
IoTHubTokenCredentials

Informations d’identification de jeton IoTHub utilisées pour créer le client de couche de protocole.

Détails de la méthode

getDigitalTwin(string)

Récupérez le jumeau numérique d’un appareil donné.

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

Paramètres

digitalTwinId

string

ID du jumeau numérique de l’appareil ou du module donné. Le format de digitalTwinId est DeviceId[~ModuleId]. ModuleId est facultatif.

Retours

Promise<DigitalTwinResponse>

DigitalTwinResponse Objet de retour contenant le jumeau numérique et le httpResponse.

getDigitalTwin(string, TripleValueCallback<DigitalTwin, HttpOperationResponse>) 

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

Paramètres

digitalTwinId

string

callback

TripleValueCallback<DigitalTwin, HttpOperationResponse>

invokeCommand(string, string, any, DigitalTwinInvokeRootLevelCommandOptionalParams)

Appelez une commande sur un composant d’un appareil particulier et obtenez le résultat de celle-ci.

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

Paramètres

digitalTwinId

string

ID de jumeau numérique de l’appareil donné.

commandName

string

argument

any

Argument d’une commande.

options

DigitalTwinInvokeRootLevelCommandOptionalParams

Paramètre facultatif pour définir des options, notamment connectionTimeoutInSeconds et responseTimeoutInSeconds. La valeur responseTimeoutInSeconds doit se trouver dans [5; 300]

Retours

Promise<DigitalTwinInvokeRootLevelCommandResponse>

DigitalTwinInvokeRootLevelCommandResponse Résultat de la commande appelée contenant le résultat, le code status, l’ID de requête et le HttpResponse analysé.

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

Appelez une commande sur un composant d’un appareil particulier et obtenez le résultat de celle-ci.

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

Paramètres

digitalTwinId

string

ID de jumeau numérique de l’appareil donné.

componentName

string

Nom du composant.

commandName

string

Nom de la commande.

argument

any

Argument d’une commande.

options

DigitalTwinInvokeComponentCommandOptionalParams

Paramètre facultatif pour définir des options, notamment connectionTimeoutInSeconds et responseTimeoutInSeconds. La valeur responseTimeoutInSeconds doit se trouver dans [5; 300]

Retours

Promise<DigitalTwinInvokeComponentCommandResponse>

DigitalTwinInvokeComponentCommandResponse Résultat de la commande appelée contenant le résultat, le code status, l’ID de requête et le HttpResponse analysé.

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ètres

digitalTwinId

string

patch

any[]

eTagOrCallback

string | TripleValueCallback<void, HttpOperationResponse>

callback

TripleValueCallback<void, HttpOperationResponse>

updateDigitalTwin(string, any[], string)

Mettez à jour le jumeau numérique d’un appareil donné à l’aide d’un objet patch.

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

Paramètres

digitalTwinId

string

ID de jumeau numérique de l’appareil donné.

patch

any[]

L’objet patch contient la partie de mise à jour d’un jumeau numérique.

eTag

string

eTag permettant d’identifier le correctif.

Retours

Promise<DigitalTwinUpdateResponse>

DigitalTwinUpdateResponse Le HTTPesponse.