DeviceMethodResponse class

Pacchetto:

azure-iot-device

All'utente viene fornito un oggetto DeviceMethodResponse con ogni DeviceMethodRequest che consente all'utente di costruire e inviare una risposta ben formattata al servizio per ogni chiamata al metodo del dispositivo. Un'istanza di questa classe viene passata come secondo parametro al callback registrato tramite onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).

Costruttori

DeviceMethodResponse(string, DeviceTransport)

Proprietà

isResponseComplete	Valore booleano che indica se la risposta è già stata inviata.
payload	Payload della risposta, inviato al chiamante sul lato servizio.
requestId	Identificatore della richiesta fornito dal servizio per questa chiamata al metodo del dispositivo.
status	Codice di stato che indica se il metodo ha avuto esito positivo (200) o meno (qualsiasi altro numero diverso da 200).

Metodi

send(number, any)
send(number, any, ErrorCallback)	Invia la risposta del metodo del dispositivo al servizio tramite l'oggetto trasporto sottostante usando il parametro status come stato della chiamata al metodo.
send(number, ErrorCallback)

Dettagli costruttore

DeviceMethodResponse(string, DeviceTransport)

new DeviceMethodResponse(requestId: string, transport: DeviceTransport)

Parametri

requestId

string

transport

DeviceTransport

Dettagli proprietà

isResponseComplete

Valore booleano che indica se la risposta è già stata inviata.

isResponseComplete: boolean

Valore della proprietà

boolean

payload

Payload della risposta, inviato al chiamante sul lato servizio.

payload: any

Valore della proprietà

any

requestId

Identificatore della richiesta fornito dal servizio per questa chiamata al metodo del dispositivo.

requestId: string

Valore della proprietà

string

status

Codice di stato che indica se il metodo ha avuto esito positivo (200) o meno (qualsiasi altro numero diverso da 200).

status: number

Valore della proprietà

number

Dettagli metodo

send(number, any)

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

Parametri

status

number

payload

any

Restituisce

Promise<void>

send(number, any, ErrorCallback)

Invia la risposta del metodo del dispositivo al servizio tramite l'oggetto trasporto sottostante usando il parametro status come stato della chiamata al metodo.

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

Parametri

status

number

Codice di stato numerico da inviare al servizio.

payload

any

[facoltativo] Payload della risposta al metodo.

done

ErrorCallback

[facoltativo] Funzione di callback che verrà chiamata dopo che la risposta è stata inviata al servizio. Un oggetto errore viene passato come argomento alla funzione nel caso in cui si verifichi un errore. Se il callback non viene specificato, verrà restituito un elemento Promise.

send(number, ErrorCallback)

function send(status: number, done: ErrorCallback)

Parametri

status

number

done

ErrorCallback