DeviceMethodResponse class

Pakket:

azure-iot-device

een DeviceMethodResponse-object wordt aan de gebruiker verstrekt met elke DeviceMethodRequest waarmee de gebruiker een goed opgemaakt antwoord naar de service kan maken en verzenden voor elke aanroep van de apparaatmethode. Een exemplaar van deze klasse wordt doorgegeven als de tweede parameter aan de callback geregistreerd via onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).

Constructors

DeviceMethodResponse(string, DeviceTransport)

Eigenschappen

isResponseComplete	Booleaanse waarde die aangeeft of het antwoord al is verzonden.
payload	De nettolading van het antwoord, teruggestuurd naar de aanroeper aan de servicezijde.
requestId	De aanvraag-id die door de service wordt geleverd voor deze aanroep van de apparaatmethode.
status	Statuscode die aangeeft of de methode is geslaagd (200) of niet (een ander getal dat niet 200 is).

Methoden

send(number, any)
send(number, any, ErrorCallback)	Verzendt het antwoord van de apparaatmethode terug naar de service via het onderliggende transportobject met behulp van de statusparameter als de status van de methode-aanroep.
send(number, ErrorCallback)

Constructordetails

DeviceMethodResponse(string, DeviceTransport)

new DeviceMethodResponse(requestId: string, transport: DeviceTransport)

Parameters

requestId

string

transport

DeviceTransport

Eigenschapdetails

isResponseComplete

Booleaanse waarde die aangeeft of het antwoord al is verzonden.

isResponseComplete: boolean

Waarde van eigenschap

boolean

payload

De nettolading van het antwoord, teruggestuurd naar de aanroeper aan de servicezijde.

payload: any

Waarde van eigenschap

any

requestId

De aanvraag-id die door de service wordt geleverd voor deze aanroep van de apparaatmethode.

requestId: string

Waarde van eigenschap

string

status

Statuscode die aangeeft of de methode is geslaagd (200) of niet (een ander getal dat niet 200 is).

status: number

Waarde van eigenschap

number

Methodedetails

send(number, any)

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

Parameters

status

number

payload

any

Retouren

Promise<void>

send(number, any, ErrorCallback)

Verzendt het antwoord van de apparaatmethode terug naar de service via het onderliggende transportobject met behulp van de statusparameter als de status van de methode-aanroep.

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

Parameters

status

number

Een numerieke statuscode die moet worden teruggestuurd naar de service.

payload

any

[optioneel] De nettolading van het antwoord van de methode.

done

ErrorCallback

[optioneel] Een callback-functie die wordt aangeroepen zodra het antwoord naar de service is verzonden. Er wordt een foutobject doorgegeven als argument aan de functie voor het geval er een fout optreedt. Als callback niet is opgegeven, wordt er een Promise geretourneerd.

send(number, ErrorCallback)

function send(status: number, done: ErrorCallback)

Parameters

status

number

done

ErrorCallback