DeviceMethodResponse class

Balíček:

azure-iot-device

Uživateli je k dispozici objekt DeviceMethodResponse s každou DeviceMethodRequest který uživateli umožňuje vytvořit a odeslat dobře naformátovanou odpověď zpět do služby pro každé volání metody zařízení. Instance této třídy se předává jako druhý parametr zpětnému volání registrovanému prostřednictvím onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).

Konstruktory

DeviceMethodResponse(string, DeviceTransport)

Vlastnosti

isResponseComplete	Logická hodnota označující, jestli už byla odpověď odeslána.
payload	Datová část odpovědi, která se odeslala zpět volajícímu na straně služby.
requestId	Identifikátor požadavku zadaný službou pro volání této metody zařízení.
status	Stavový kód označující, jestli metoda proběhla úspěšně (200), nebo ne (jakékoli jiné číslo, které není 200).

Metody

send(number, any)
send(number, any, ErrorCallback)	Odešle odpověď metody zařízení zpět do služby prostřednictvím podkladového transportního objektu pomocí parametru stavu jako stav volání metody.
send(number, ErrorCallback)

Podrobnosti konstruktoru

DeviceMethodResponse(string, DeviceTransport)

new DeviceMethodResponse(requestId: string, transport: DeviceTransport)

Parametry

requestId

string

transport

DeviceTransport

Podrobnosti vlastnosti

isResponseComplete

Logická hodnota označující, jestli už byla odpověď odeslána.

isResponseComplete: boolean

Hodnota vlastnosti

boolean

payload

Datová část odpovědi, která se odeslala zpět volajícímu na straně služby.

payload: any

Hodnota vlastnosti

any

requestId

Identifikátor požadavku zadaný službou pro volání této metody zařízení.

requestId: string

Hodnota vlastnosti

string

status

Stavový kód označující, jestli metoda proběhla úspěšně (200), nebo ne (jakékoli jiné číslo, které není 200).

status: number

Hodnota vlastnosti

number

Podrobnosti metody

send(number, any)

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

Parametry

status

number

payload

any

Návraty

Promise<void>

send(number, any, ErrorCallback)

Odešle odpověď metody zařízení zpět do služby prostřednictvím podkladového transportního objektu pomocí parametru stavu jako stav volání metody.

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

Parametry

status

number

Číselný stavový kód, který se má odeslat zpět do služby.

payload

any

[volitelné] Datová část odpovědi metody.

done

ErrorCallback

[volitelné] Funkce zpětného volání, která bude volána po odeslání odpovědi zpět do služby. Objekt chyby se předá funkci jako argument v případě, že dojde k chybě. Pokud zpětné volání není zadané, vrátí se příslib.

send(number, ErrorCallback)

function send(status: number, done: ErrorCallback)

Parametry

status

number

done

ErrorCallback