DeviceMethodResponse class

  • Referência
Pacote:
azure-iot-device

um DeviceMethodResponse objeto é fornecido ao utilizador, permitindo que o DeviceMethodRequest utilizador construa e envie uma resposta bem formatada de volta para o serviço para cada chamada de método de dispositivo. Uma instância desta classe é transmitida como o segundo parâmetro para a chamada de retorno registada através de onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).

Construtores

DeviceMethodResponse(string, DeviceTransport)

Propriedades

isResponseComplete

Valor booleano que indica se a resposta já foi enviada.
payload

O payload da resposta, enviado de volta para o autor da chamada no lado do serviço.
requestId

O identificador de pedido fornecido pelo serviço para esta chamada de método de dispositivo.
status

Código de estado que indica se o método foi ou não bem-sucedido (200) (qualquer outro número que não seja 200).

Métodos

send(number, any)
send(number, any, ErrorCallback)

Envia a resposta do método do dispositivo de volta para o serviço através do objeto de transporte subjacente com o parâmetro de estado como o estado da chamada de método.
send(number, ErrorCallback)

Detalhes do Construtor

DeviceMethodResponse(string, DeviceTransport) 

new DeviceMethodResponse(requestId: string, transport: DeviceTransport)

Parâmetros

requestId

string

transport
DeviceTransport

Detalhes de Propriedade

isResponseComplete

Valor booleano que indica se a resposta já foi enviada.

isResponseComplete: boolean

Valor de Propriedade

boolean

payload

O payload da resposta, enviado de volta para o autor da chamada no lado do serviço.

payload: any

Valor de Propriedade

any

requestId

O identificador de pedido fornecido pelo serviço para esta chamada de método de dispositivo.

requestId: string

Valor de Propriedade

string

status

Código de estado que indica se o método foi ou não bem-sucedido (200) (qualquer outro número que não seja 200).

status: number

Valor de Propriedade

number

Detalhes de Método

send(number, any) 

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

Parâmetros

status

number

payload

any

Devoluções

Promise<void>

send(number, any, ErrorCallback)

Envia a resposta do método do dispositivo de volta para o serviço através do objeto de transporte subjacente com o parâmetro de estado como o estado da chamada de método.

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

Parâmetros

status

number

Um código de estado numérico a ser enviado de volta para o serviço.

payload

any

[opcional] O payload da resposta do método.

done

ErrorCallback

[opcional] Uma função de chamada de retorno que será chamada assim que a resposta for enviada de volta para o serviço. Um objeto de erro é transmitido como um argumento para a função no caso de ocorrer um erro. Se a chamada de retorno não for especificada, será devolvida uma Promessa.

send(number, ErrorCallback) 

function send(status: number, done: ErrorCallback)

Parâmetros

status

number

done

ErrorCallback