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)	Отправляет ответ метода устройства обратно в службу через базовый транспортный объект, используя параметр состояния в качестве состояния вызова метода.
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)

Отправляет ответ метода устройства обратно в службу через базовый транспортный объект, используя параметр состояния в качестве состояния вызова метода.

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

Параметры

status

number

Числовой код состояния, отправляемый обратно в службу.

payload

any

[необязательно] Полезные данные ответа метода.

done

ErrorCallback

[необязательно] Функция обратного вызова, которая будет вызываться после отправки ответа обратно в службу. Объект ошибки передается в качестве аргумента функции в случае возникновения ошибки. Если обратный вызов не указан, возвращается обещание.

send(number, ErrorCallback)

function send(status: number, done: ErrorCallback)

Параметры

status

number

done

ErrorCallback