DeviceMethodResponse class

套件:

azure-iot-device

每個 DeviceMethodResponse 都會提供 DeviceMethodRequest 對象給使用者，讓使用者針對每個裝置方法呼叫建構和傳送格式正確的回應回服務。 這個類別的實例會當做第二個參數傳遞至透過 onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)註冊的回呼。

建構函式

DeviceMethodResponse(string, DeviceTransport)

屬性

isResponseComplete	布爾值，指出是否已傳送回應。
payload	回應的承載，會傳回給服務端的呼叫端。
requestId	服務針對這個裝置方法呼叫所提供的要求標識符。
status	狀態代碼，指出方法是否成功 （200） （任何其他不是 200 的數位）。

方法

send(number, any)
send(number, any, ErrorCallback)	使用 status 參數做為方法呼叫的狀態，透過基礎傳輸物件將裝置方法的回應傳回服務。
send(number, ErrorCallback)

建構函式詳細資料

DeviceMethodResponse(string, DeviceTransport)

new DeviceMethodResponse(requestId: string, transport: DeviceTransport)

參數

requestId

string

transport

DeviceTransport

屬性詳細資料

isResponseComplete

布爾值，指出是否已傳送回應。

isResponseComplete: boolean

屬性值

boolean

payload

回應的承載，會傳回給服務端的呼叫端。

payload: any

屬性值

any

requestId

服務針對這個裝置方法呼叫所提供的要求標識符。

requestId: string

屬性值

string

status

狀態代碼，指出方法是否成功 （200） （任何其他不是 200 的數位）。

status: number

屬性值

number

方法詳細資料

send(number, any)

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

參數

status

number

payload

any

傳回

Promise<void>

send(number, any, ErrorCallback)

使用 status 參數做為方法呼叫的狀態，透過基礎傳輸物件將裝置方法的回應傳回服務。

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

參數

status

number

要傳回服務的數值狀態代碼。

payload

any

[選擇性]方法響應的承載。

done

ErrorCallback

[選擇性]回呼函式，會在回應傳回服務後呼叫。 錯誤物件會當做自變數傳遞至函式，以防發生錯誤。 如果未指定回呼，則會傳回 Promise。

send(number, ErrorCallback)

function send(status: number, done: ErrorCallback)

參數

status

number

done

ErrorCallback