DeviceMethodResponse class
Um objeto DeviceMethodResponse é fornecido ao usuário com cada DeviceMethodRequest 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 via onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void).
Construtores
Device |
Propriedades
is |
Booleano indicando se a resposta já foi enviada. |
payload | A carga útil da resposta, enviada de volta ao chamador no lado do serviço. |
request |
O identificador de solicitação fornecido pelo serviço para esta 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, Error |
Envia a resposta do método de dispositivo de volta para o serviço através do objeto de transporte subjacente usando o parâmetro status como o status da chamada do método. |
send(number, Error |
Detalhes do Construtor
DeviceMethodResponse(string, DeviceTransport)
new DeviceMethodResponse(requestId: string, transport: DeviceTransport)
Parâmetros
- requestId
-
string
- transport
- DeviceTransport
Detalhes de Propriedade
isResponseComplete
Booleano indicando se a resposta já foi enviada.
isResponseComplete: boolean
Valor de Propriedade
boolean
payload
A carga útil da resposta, enviada de volta ao chamador no lado do serviço.
payload: any
Valor de Propriedade
any
requestId
O identificador de solicitação fornecido pelo serviço para esta chamada de método de dispositivo.
requestId: string
Valor de 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 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 de dispositivo de volta para o serviço através do objeto de transporte subjacente usando o parâmetro status como o status da chamada do 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 ao serviço.
- payload
-
any
[opcional] A carga útil da resposta do método.
- done
-
ErrorCallback
[opcional] Uma função de retorno de chamada que será chamada assim 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