DeviceMethodResponse class

  • Referencia
Paquete:
azure-iot-device

se DeviceMethodResponse proporciona un objeto al usuario con cada uno de los DeviceMethodRequest cuales permite al usuario construir y enviar una respuesta con formato correcto al servicio para cada llamada al método de dispositivo. Una instancia de esta clase se pasa como segundo parámetro a la devolución de llamada registrada a través onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)de .

Constructores

DeviceMethodResponse(string, DeviceTransport)

Propiedades

isResponseComplete

Boolean que indica si la respuesta ya se ha enviado.
payload

La carga de la respuesta, enviada de vuelta al autor de la llamada en el lado del servicio.
requestId

Identificador de solicitud proporcionado por el servicio para esta llamada al método de dispositivo.
status

Código de estado que indica si el método se realizó correctamente (200) o no (cualquier otro número que no sea 200).

Métodos

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

Devuelve la respuesta del método de dispositivo al servicio a través del objeto de transporte subyacente mediante el parámetro status como estado de la llamada al método.
send(number, ErrorCallback)

Detalles del constructor

DeviceMethodResponse(string, DeviceTransport) 

new DeviceMethodResponse(requestId: string, transport: DeviceTransport)

Parámetros

requestId

string

transport
DeviceTransport

Detalles de las propiedades

isResponseComplete

Boolean que indica si la respuesta ya se ha enviado.

isResponseComplete: boolean

Valor de propiedad

boolean

payload

La carga de la respuesta, enviada de vuelta al autor de la llamada en el lado del servicio.

payload: any

Valor de propiedad

any

requestId

Identificador de solicitud proporcionado por el servicio para esta llamada al método de dispositivo.

requestId: string

Valor de propiedad

string

status

Código de estado que indica si el método se realizó correctamente (200) o no (cualquier otro número que no sea 200).

status: number

Valor de propiedad

number

Detalles del método

send(number, any) 

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

Parámetros

status

number

payload

any

Devoluciones

Promise<void>

send(number, any, ErrorCallback)

Devuelve la respuesta del método de dispositivo al servicio a través del objeto de transporte subyacente mediante el parámetro status como estado de la llamada al método.

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

Parámetros

status

number

Código de estado numérico que se va a devolver al servicio.

payload

any

[opcional] Carga de la respuesta del método.

done

ErrorCallback

[opcional] Función de devolución de llamada a la que se llamará una vez que la respuesta se haya devuelto al servicio. Un objeto de error se pasa como argumento a la función en caso de que se produzca un error. Si no se especifica la devolución de llamada, se devolverá una promesa.

send(number, ErrorCallback) 

function send(status: number, done: ErrorCallback)

Parámetros

status

number

done

ErrorCallback