Udostępnij za pośrednictwem

DeviceMethodResponse class

  • Odwołanie
Pakiet:
azure-iot-device

DeviceMethodResponse obiekt jest dostarczany użytkownikowi z każdymDeviceMethodRequest, co umożliwia użytkownikowi konstruowanie i wysyłanie dobrze sformatowanej odpowiedzi z powrotem do usługi dla każdego wywołania metody urządzenia. Wystąpienie tej klasy jest przekazywane jako drugi parametr do wywołania zwrotnego zarejestrowanego za pośrednictwem metody onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).

Konstruktory

DeviceMethodResponse(string, DeviceTransport)

Właściwości

isResponseComplete

Wartość logiczna wskazująca, czy odpowiedź została już wysłana.
payload

Ładunek odpowiedzi, odesłany do obiektu wywołującego po stronie usługi.
requestId

Identyfikator żądania dostarczony przez usługę dla tego wywołania metody urządzenia.
status

Kod stanu wskazujący, czy metoda zakończyła się powodzeniem (200) lub nie (dowolną inną liczbą, która nie jest 200).

Metody

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

Wysyła odpowiedź metody urządzenia z powrotem do usługi za pośrednictwem bazowego obiektu transportu przy użyciu parametru status jako stanu wywołania metody.
send(number, ErrorCallback)

Szczegóły konstruktora

DeviceMethodResponse(string, DeviceTransport) 

new DeviceMethodResponse(requestId: string, transport: DeviceTransport)

Parametry

requestId

string

transport
DeviceTransport

Szczegóły właściwości

isResponseComplete

Wartość logiczna wskazująca, czy odpowiedź została już wysłana.

isResponseComplete: boolean

Wartość właściwości

boolean

payload

Ładunek odpowiedzi, odesłany do obiektu wywołującego po stronie usługi.

payload: any

Wartość właściwości

any

requestId

Identyfikator żądania dostarczony przez usługę dla tego wywołania metody urządzenia.

requestId: string

Wartość właściwości

string

status

Kod stanu wskazujący, czy metoda zakończyła się powodzeniem (200) lub nie (dowolną inną liczbą, która nie jest 200).

status: number

Wartość właściwości

number

Szczegóły metody

send(number, any) 

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

Parametry

status

number

payload

any

Zwraca

Promise<void>

send(number, any, ErrorCallback)

Wysyła odpowiedź metody urządzenia z powrotem do usługi za pośrednictwem bazowego obiektu transportu przy użyciu parametru status jako stanu wywołania metody.

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

Parametry

status

number

Kod stanu liczbowy, który ma zostać odesłany do usługi.

payload

any

[opcjonalnie] Ładunek odpowiedzi metody.

done

ErrorCallback

[opcjonalnie] Funkcja wywołania zwrotnego, która zostanie wywołana po wysłaniu odpowiedzi z powrotem do usługi. Obiekt błędu jest przekazywany jako argument do funkcji w przypadku wystąpienia błędu. Jeśli wywołanie zwrotne nie zostanie określone, zostanie zwrócona obietnica.

send(number, ErrorCallback) 

function send(status: number, done: ErrorCallback)

Parametry

status

number

done

ErrorCallback