DeviceMethodResponse class
DeviceMethodResponseオブジェクトがユーザーに提供され、各DeviceMethodRequestデバイス メソッド呼び出しに対して適切な形式の応答を構築してサービスに送り返せるようにします。 このクラスのインスタンスは、 を介して onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)登録されたコールバックに 2 番目のパラメーターとして渡されます。
コンストラクター
| Device |
プロパティ
| is |
応答が既に送信されているかどうかを示すブール値。 |
| payload | 応答のペイロード。サービス側の呼び出し元に返されます。 |
| request |
このデバイス メソッド呼び出しに対してサービスによって提供される要求識別子。 |
| status | メソッドが成功した (200) かどうか (200 以外の数値) を示す状態コード。 |
メソッド
| send(number, any) | |
| send(number, any, Error |
status パラメーターをメソッド呼び出しの状態として使用して、基になるトランスポート オブジェクトを介してデバイス メソッドの応答をサービスに送り返します。 |
| send(number, Error |
コンストラクターの詳細
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)
status パラメーターをメソッド呼び出しの状態として使用して、基になるトランスポート オブジェクトを介してデバイス メソッドの応答をサービスに送り返します。
function send(status: number, payload?: any, done?: ErrorCallback)パラメーター
- status
-
number
サービスに送り返される数値状態コード。
- payload
-
any
[省略可能]メソッド応答のペイロード。
- done
-
ErrorCallback
[省略可能]応答がサービスに返送されると呼び出されるコールバック関数。 エラーが発生した場合に備えて、error オブジェクトが関数に引数として渡されます。 コールバックが指定されていない場合は、Promise が返されます。
send(number, ErrorCallback)
function send(status: number, done: ErrorCallback)パラメーター
- status
-
number
- done
-
ErrorCallback