DeviceMethodResponse class

  • Referência
Pacote:
azure-iot-device

um DeviceMethodResponse objeto é fornecido ao usuário com cada DeviceMethodRequest um permitindo que o usuário construa e envie uma resposta bem formatada de volta ao serviço para cada chamada de método de dispositivo. Uma instância dessa classe é passada como o segundo parâmetro para o retorno de chamada registrado por meio onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)de .

Construtores

DeviceMethodResponse(string, DeviceTransport)

Propriedades

isResponseComplete

Booliano que indica se a resposta já foi enviada.
payload

O conteúdo da resposta, enviado de volta para o chamador no lado do serviço.
requestId

O identificador de solicitação fornecido pelo serviço para essa chamada de método de dispositivo.
status

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

Métodos

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

Envia a resposta do método de dispositivo de volta ao serviço por meio do objeto de transporte subjacente usando o parâmetro status como o status 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 da propriedade

isResponseComplete

Booliano que indica se a resposta já foi enviada.

isResponseComplete: boolean

Valor da propriedade

boolean

payload

O conteúdo da resposta, enviado de volta para o chamador no lado do serviço.

payload: any

Valor da propriedade

any

requestId

O identificador de solicitação fornecido pelo serviço para essa chamada de método de dispositivo.

requestId: string

Valor da propriedade

string

status

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

status: number

Valor da propriedade

number

Detalhes do método

send(number, any) 

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

Parâmetros

status

number

payload

any

Retornos

Promise<void>

send(number, any, ErrorCallback)

Envia a resposta do método de dispositivo de volta ao serviço por meio do objeto de transporte subjacente usando o parâmetro status como o status da chamada de método.

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

Parâmetros

status

number

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

payload

any

[opcional] O conteúdo da resposta do método.

done

ErrorCallback

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

send(number, ErrorCallback) 

function send(status: number, done: ErrorCallback)

Parâmetros

status

number

done

ErrorCallback