DeviceMethodResponse class

Csomag:

azure-iot-device

a DeviceMethodResponse objektum minden egyes DeviceMethodRequest lehetővé teszi, hogy a felhasználó megfelelően formázott választ hozzon létre és küldjön vissza a szolgáltatásnak minden egyes eszközmetódus-híváshoz. Az osztály egy példánya a második paraméterként lesz átadva a onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)keresztül regisztrált visszahívásnak.

Konstruktorok

DeviceMethodResponse(string, DeviceTransport)

Tulajdonságok

isResponseComplete	Logikai érték, amely jelzi, hogy a válasz már el lett-e küldve.
payload	A válasz hasznos adata, amelyet a szolgáltatás oldalán a hívónak küldtek vissza.
requestId	A szolgáltatás által az eszközmetódus hívásához megadott kérésazonosító.
status	Állapotkód, amely jelzi, hogy a metódus sikeres volt-e (200) vagy sem (bármely más szám, amely nem 200).

Metódusok

send(number, any)
send(number, any, ErrorCallback)	Az eszközmetódus válaszát az alapul szolgáló átviteli objektumon keresztül küldi vissza a szolgáltatásnak az állapotparaméterrel a metódushívás állapotaként.
send(number, ErrorCallback)

Konstruktor adatai

DeviceMethodResponse(string, DeviceTransport)

new DeviceMethodResponse(requestId: string, transport: DeviceTransport)

Paraméterek

requestId

string

transport

DeviceTransport

Tulajdonság adatai

isResponseComplete

Logikai érték, amely jelzi, hogy a válasz már el lett-e küldve.

isResponseComplete: boolean

Tulajdonság értéke

boolean

payload

A válasz hasznos adata, amelyet a szolgáltatás oldalán a hívónak küldtek vissza.

payload: any

Tulajdonság értéke

any

requestId

A szolgáltatás által az eszközmetódus hívásához megadott kérésazonosító.

requestId: string

Tulajdonság értéke

string

status

Állapotkód, amely jelzi, hogy a metódus sikeres volt-e (200) vagy sem (bármely más szám, amely nem 200).

status: number

Tulajdonság értéke

number

Metódus adatai

send(number, any)

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

Paraméterek

status

number

payload

any

Válaszok

Promise<void>

send(number, any, ErrorCallback)

Az eszközmetódus válaszát az alapul szolgáló átviteli objektumon keresztül küldi vissza a szolgáltatásnak az állapotparaméterrel a metódushívás állapotaként.

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

Paraméterek

status

number

A szolgáltatásnak visszaküldendő numerikus állapotkód.

payload

any

[nem kötelező] A metódus válaszának hasznos adata.

done

ErrorCallback

[nem kötelező] Egy visszahívási függvény, amely akkor lesz meghívva, ha a válasz vissza lett küldve a szolgáltatásnak. Hiba esetén a függvény argumentumként egy hibaobjektumot ad át. Ha nincs megadva visszahívás, a rendszer ígéretet ad vissza.

send(number, ErrorCallback)

function send(status: number, done: ErrorCallback)

Paraméterek

status

number

done

ErrorCallback