你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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