Dela via

DeviceMethodResponse class

Paket:
azure-iot-device

ett DeviceMethodResponse objekt tillhandahålls till användaren med varje DeviceMethodRequest så att användaren kan konstruera och skicka ett välformaterat svar tillbaka till tjänsten för varje enhetsmetodanrop. En instans av den här klassen skickas som den andra parametern till motringningen som registrerats via onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).

Konstruktorer

DeviceMethodResponse(string, DeviceTransport)

Egenskaper

isResponseComplete

Booleskt värde som anger om svaret redan har skickats.
payload

Nyttolasten för svaret som skickas tillbaka till anroparen på tjänstsidan.
requestId

Begärandeidentifieraren som tillhandahålls av tjänsten för det här enhetsmetodanropet.
status

Statuskod som anger om metoden lyckades (200) eller inte (något annat tal som inte är 200).

Metoder

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

Skickar tillbaka enhetsmetodens svar till tjänsten via det underliggande transportobjektet med statusparametern som status för metodanropet.
send(number, ErrorCallback)

Konstruktorinformation

DeviceMethodResponse(string, DeviceTransport) 

new DeviceMethodResponse(requestId: string, transport: DeviceTransport)

Parametrar

requestId

string

transport
DeviceTransport

Egenskapsinformation

isResponseComplete

Booleskt värde som anger om svaret redan har skickats.

isResponseComplete: boolean

Egenskapsvärde

boolean

payload

Nyttolasten för svaret som skickas tillbaka till anroparen på tjänstsidan.

payload: any

Egenskapsvärde

any

requestId

Begärandeidentifieraren som tillhandahålls av tjänsten för det här enhetsmetodanropet.

requestId: string

Egenskapsvärde

string

status

Statuskod som anger om metoden lyckades (200) eller inte (något annat tal som inte är 200).

status: number

Egenskapsvärde

number

Metodinformation

send(number, any) 

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

Parametrar

status

number

payload

any

Returer

Promise<void>

send(number, any, ErrorCallback)

Skickar tillbaka enhetsmetodens svar till tjänsten via det underliggande transportobjektet med statusparametern som status för metodanropet.

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

Parametrar

status

number

En numerisk statuskod som ska skickas tillbaka till tjänsten.

payload

any

[valfritt] Nyttolasten för metodsvaret.

done

ErrorCallback

[valfritt] En återanropsfunktion som anropas när svaret har skickats tillbaka till tjänsten. Ett felobjekt skickas som ett argument till funktionen om ett fel inträffar. Om återanrop inte har angetts returneras ett Promise.

send(number, ErrorCallback) 

function send(status: number, done: ErrorCallback)

Parametrar

status

number

done

ErrorCallback