DeviceMethodResponse class

  • Référence
Paquet:
azure-iot-device

un DeviceMethodResponse objet est fourni à l’utilisateur avec chacun DeviceMethodRequest d’eux permettant à l’utilisateur de construire et d’envoyer une réponse bien formatée au service pour chaque appel de méthode d’appareil. Une instance de cette classe est passée en tant que deuxième paramètre au rappel inscrit via onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).

Constructeurs

DeviceMethodResponse(string, DeviceTransport)

Propriétés

isResponseComplete

Boolean indiquant si la réponse a déjà été envoyée.
payload

Charge utile de la réponse, renvoyée à l’appelant côté service.
requestId

Identificateur de demande fourni par le service pour cet appel de méthode d’appareil.
status

Code d’état indiquant si la méthode a réussi (200) ou non (tout autre nombre qui n’est pas 200).

Méthodes

send(number, any)
send(number, any, ErrorCallback)

Renvoie la réponse de la méthode d’appareil au service via l’objet de transport sous-jacent à l’aide du paramètre status comme état de l’appel de méthode.
send(number, ErrorCallback)

Détails du constructeur

DeviceMethodResponse(string, DeviceTransport) 

new DeviceMethodResponse(requestId: string, transport: DeviceTransport)

Paramètres

requestId

string

transport
DeviceTransport

Détails de la propriété

isResponseComplete

Boolean indiquant si la réponse a déjà été envoyée.

isResponseComplete: boolean

Valeur de propriété

boolean

payload

Charge utile de la réponse, renvoyée à l’appelant côté service.

payload: any

Valeur de propriété

any

requestId

Identificateur de demande fourni par le service pour cet appel de méthode d’appareil.

requestId: string

Valeur de propriété

string

status

Code d’état indiquant si la méthode a réussi (200) ou non (tout autre nombre qui n’est pas 200).

status: number

Valeur de propriété

number

Détails de la méthode

send(number, any) 

function send(status: number, payload?: any): Promise<void>

Paramètres

status

number

payload

any

Retours

Promise<void>

send(number, any, ErrorCallback)

Renvoie la réponse de la méthode d’appareil au service via l’objet de transport sous-jacent à l’aide du paramètre status comme état de l’appel de méthode.

function send(status: number, payload?: any, done?: ErrorCallback)

Paramètres

status

number

Code d’état numérique à renvoyer au service.

payload

any

[facultatif] Charge utile de la réponse de la méthode.

done

ErrorCallback

[facultatif] Fonction de rappel qui sera appelée une fois la réponse renvoyée au service. Un objet error est passé en tant qu’argument à la fonction en cas d’erreur. Si le rappel n’est pas spécifié, une promesse est retournée.

send(number, ErrorCallback) 

function send(status: number, done: ErrorCallback)

Paramètres

status

number

done

ErrorCallback