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

[선택 사항] 응답이 서비스로 다시 전송되면 호출되는 콜백 함수입니다. 오류 개체는 오류가 발생할 경우 함수에 인수로 전달됩니다. 콜백을 지정하지 않으면 Promise가 반환됩니다.

send(number, ErrorCallback) 

function send(status: number, done: ErrorCallback)

매개 변수

status

number

done

ErrorCallback