IRHTTPClient (irkit-android-sdk 1.3.1 API)

java.lang.Object
- com.getirkit.irkit.net.IRHTTPClient

```
public class IRHTTPClient
extends java.lang.Object
```
Device HTTP APIとInternet HTTP APIを利用するためのクラスです。 Client for HTTP API and Internet HTTP API.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`APIENDPOINT_BASE` Internet HTTP APIのエンドポイントです。 Endpoint for Internet HTTP API.
`static java.lang.String`	`DEVICE_API_ENDPOINT_IRKITWIFI` IRKit Wi-Fiに接続しているときのDevice HTTP APIのエンドポイントです。 Endpoint for Device HTTP API when IRKit Wi-Fi is active.
`static java.lang.String`	`DEVICE_API_X_REQUESTED_WITH` Device HTTP APIのリクエストに付けるX-Requested-Withヘッダの値。 Value of X-Requested-With header which is added to every request to Device HTTP API.
`static java.lang.String`	`TAG`

Constructor Summary

Constructors
Constructor and Description
`IRHTTPClient()` コンストラクタです。インスタンスを取得するときはsharedInstance()メソッドを使ってください。 Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addClientKey(java.util.Map<java.lang.String,java.lang.String> params)` 引数のparamsにclientkeyを追加します。 Add clientkey to the given params.
`void`	`cancelPostDoor()` waitForDoor()をキャンセルします。 Cancel previously called waitForDoor().
`void`	`cancelRequests()` waitForSignal()をキャンセルします。現在進行中のwaitForSignal()についてはコールバックは呼ばれません。
`void`	`clearDeviceKeyCache()` Internet HTTP APIのPOST /1/devicesのレスポンスはキャッシュされますが、そのキャッシュを削除します。IRHTTPClientインスタンスを作成するたびにキャッシュは空になります。
`void`	`connectDeviceToWifi(IRWifiInfo irWifiInfo, IRAPICallback<IRDeviceAPIService.PostWifiResponse> callback)` IRKitをWi-Fiに接続させます。Device HTTP APIが使える場合のみ動作します。 Connect an IRKit to Wi-Fi.
`void`	`ensureRegisteredAndCall(java.lang.String apiKey, IRAPICallback<IRInternetAPIService.PostClientsResponse> callback)` clientkeyを取得していない場合は取得します。 Fetch clientkey if it is not fetched yet.
`java.lang.String`	`getClientKey()` clientkeyを返します。 Return the clientkey.
`IRDeviceAPIService`	`getDeviceAPIService()` Device HTTP APIを直接利用するためのインスタンスを返します。 Return the instance which provides direct access to Device HTTP API.
`IRInternetAPIService`	`getInternetAPIService()` Internet HTTP APIを直接利用するためのインスタンスを返します。 Return the instance which provides direct access to Internet HTTP API.
`IRDeviceAPIService`	`getThrottledDeviceAPIService()` スロットル制御を行いながらDevice HTTP APIにアクセスするためのオブジェクトを返します。 Returns an object which accesses Device HTTP API with request throttling.
`IRDeviceAPIService`	`getThrottledDeviceAPIService(IRPeripheral peripheral)` 特定のIRKitに対してスロットル制御を行いながらDevice HTTP APIにアクセスするためのオブジェクトを返します。 Returns an object which accesses Device HTTP API with request throttling.
`IRDeviceAPIService`	`getThrottledDeviceAPIService(java.lang.String deviceId)` 特定のIRKitに対してスロットル制御を行いながらDevice HTTP APIにアクセスするためのオブジェクトを返します。 Returns an object which accesses Device HTTP API with request throttling.
`IRInternetAPIService`	`getThrottledInternetAPIService()` スロットル制御を行いながらInternet HTTP APIにアクセスするためのオブジェクトを返します。 Returns an object which accesses Internet HTTP API with request throttling.
`IRInternetAPIService`	`getThrottledInternetAPIService(IRPeripheral peripheral)` 特定のIRKitに対してスロットル制御を行いながらInternet HTTP APIにアクセスするためのオブジェクトを返します。 Returns an object which accesses Internet HTTP API with request throttling.
`IRInternetAPIService`	`getThrottledInternetAPIService(java.lang.String deviceId)` 特定のIRKitに対してスロットル制御を行いながらInternet HTTP APIにアクセスするためのオブジェクトを返します。 Returns an object which accesses Internet HTTP API with request throttling.
`boolean`	`hasClientKey()` clientkeyがセット済みかどうかを返します。 Return whether clientkey has been set.
`void`	`obtainDeviceKey(IRAPICallback<IRInternetAPIService.PostDevicesResponse> callback)` devicekeyを取得します。 Fetch a devicekey.
`void`	`registerClient(java.lang.String apiKey, IRAPICallback<IRInternetAPIService.PostClientsResponse> callback)` apikeyを元にclientkeyを取得します。 Fetch clientkey using apikey.
`void`	`sendSignalOverInternet(IRSignal signal, IRAPICallback<IRInternetAPIService.PostMessagesResponse> callback)` Internet HTTP APIで赤外線信号を送信します。 Send signal over Internet HTTP API.
`void`	`sendSignalOverLocalNetwork(IRSignal signal, IRAPIResult result)` Device HTTP APIで赤外線信号を送信します。 Send IRSignal over Device HTTP API.
`void`	`setClientKey(java.lang.String key)` clientkeyをセットします。 Set a clientkey.
`void`	`setDeviceAPIEndpoint(java.lang.String endpoint)` Device HTTP APIのエンドポイントをセットします。 Set an endpoint for Device HTTP API.
`static IRHTTPClient`	`sharedInstance()`
`void`	`testIfIRKitWifiConnected(IRAPIResult result)` 192.168.1.1にリクエストを発行してレスポンスヘッダに"IRKit"が含まれていることを確認します。 Sends a request to 192.168.1.1 and checks if the response header contains "IRKit".
`void`	`waitForDoor(java.lang.String deviceId, IRAPICallback<IRInternetAPIService.PostDoorResponse> callback)` POST /1/doorを呼んで結果を待機します。サーバ側でタイムアウトして408が返ってきた場合は再度リクエストして待機します。
`void`	`waitForSignal(IRAPICallback<IRInternetAPIService.GetMessagesResponse> callback)` IRKitサーバに保存されている最新の赤外線信号を削除して、新しく赤外線信号を待機します。 Clear the IR signal saved in IRKit server, then wait for a new IR signal.
`void`	`waitForSignal(IRAPICallback<IRInternetAPIService.GetMessagesResponse> callback, boolean clear)` 赤外線信号を受信します。 Receive an IR signal.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TAG
```
public static final java.lang.String TAG
```
  - APIENDPOINT_BASE
```
public static final java.lang.String APIENDPOINT_BASE
```
    Internet HTTP APIのエンドポイントです。 Endpoint for Internet HTTP API.
    
    See Also:
    
    Constant Field Values
  - DEVICE_API_ENDPOINT_IRKITWIFI
```
public static final java.lang.String DEVICE_API_ENDPOINT_IRKITWIFI
```
    IRKit Wi-Fiに接続しているときのDevice HTTP APIのエンドポイントです。 Endpoint for Device HTTP API when IRKit Wi-Fi is active.
    
    See Also:
    
    Constant Field Values
  - DEVICE_API_X_REQUESTED_WITH
```
public static final java.lang.String DEVICE_API_X_REQUESTED_WITH
```
    Device HTTP APIのリクエストに付けるX-Requested-Withヘッダの値。 Value of X-Requested-With header which is added to every request to Device HTTP API.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IRHTTPClient
```
public IRHTTPClient()
```
    コンストラクタです。インスタンスを取得するときはsharedInstance()メソッドを使ってください。 Constructor. To get an instance, use sharedInstance().
    
    See Also:
    
    sharedInstance()
- Method Detail
  - sharedInstance
```
public static IRHTTPClient sharedInstance()
```
  - setClientKey
```
public void setClientKey(java.lang.String key)
```
    clientkeyをセットします。 Set a clientkey.
    
    Parameters:
    
    key - clientkey
  - setDeviceAPIEndpoint
```
public void setDeviceAPIEndpoint(java.lang.String endpoint)
```
    Device HTTP APIのエンドポイントをセットします。 Set an endpoint for Device HTTP API.
    
    Parameters:
    
    endpoint - A string like "http://127.0.0.1"
  - registerClient
```
public void registerClient(java.lang.String apiKey,
                           IRAPICallback<IRInternetAPIService.PostClientsResponse> callback)
```
    apikeyを元にclientkeyを取得します。 Fetch clientkey using apikey.
    
    Parameters:
    
    apiKey - apikey
    
    callback - 結果を受け取るコールバック。 Callback to be notified a result.
  - ensureRegisteredAndCall
```
public void ensureRegisteredAndCall(java.lang.String apiKey,
                                    IRAPICallback<IRInternetAPIService.PostClientsResponse> callback)
```
    clientkeyを取得していない場合は取得します。 Fetch clientkey if it is not fetched yet.
    
    Parameters:
    
    apiKey - apikey
    
    callback - 結果を受け取るコールバック。 Callback to be notified a result.
  - sendSignalOverInternet
```
public void sendSignalOverInternet(IRSignal signal,
                                   IRAPICallback<IRInternetAPIService.PostMessagesResponse> callback)
```
    Internet HTTP APIで赤外線信号を送信します。 Send signal over Internet HTTP API.
    
    Parameters:
    
    signal - IRSignal
    
    callback - 結果を受け取るコールバック。 Callback to be notified a result.
  - sendSignalOverLocalNetwork
```
public void sendSignalOverLocalNetwork(IRSignal signal,
                                       IRAPIResult result)
```
    Device HTTP APIで赤外線信号を送信します。 Send IRSignal over Device HTTP API.
    
    Parameters:
    
    signal - IRSignal
    
    result - 結果を受け取るコールバック。 Callback to be notified a result.
  - waitForSignal
```
public void waitForSignal(IRAPICallback<IRInternetAPIService.GetMessagesResponse> callback)
```
    IRKitサーバに保存されている最新の赤外線信号を削除して、新しく赤外線信号を待機します。 Clear the IR signal saved in IRKit server, then wait for a new IR signal.
    
    Parameters:
    
    callback - 結果を受け取るコールバック。 Callback to be notified a result.
  - waitForSignal
```
public void waitForSignal(IRAPICallback<IRInternetAPIService.GetMessagesResponse> callback,
                          boolean clear)
```
    赤外線信号を受信します。 Receive an IR signal.
    
    Parameters:
    
    callback - 結果を受け取るコールバック。 Callback to be notified a result.
    
    clear - trueの場合、IRKitサーバに保存されている信号を削除して、新しい信号を待機します。 If true, delete the IR signal saved in IRKit server, then wait for a new IR signal.
  - cancelRequests
```
public void cancelRequests()
```
    waitForSignal()をキャンセルします。現在進行中のwaitForSignal()についてはコールバックは呼ばれません。
    
    Cancel waitForSignal(). The callback passed to ongoing waitForSignal() will never be called.
  - addClientKey
```
public void addClientKey(java.util.Map<java.lang.String,java.lang.String> params)
```
    引数のparamsにclientkeyを追加します。 Add clientkey to the given params.
    
    Parameters:
    
    params - Map object
  - clearDeviceKeyCache
```
public void clearDeviceKeyCache()
```
    Internet HTTP APIのPOST /1/devicesのレスポンスはキャッシュされますが、そのキャッシュを削除します。IRHTTPClientインスタンスを作成するたびにキャッシュは空になります。
    
    Delete the cached response of POST /1/devices. A newly-created IRHTTPClient instance does not have a cached response. When it receives the response of POST /1/devices of Internet HTTP API, it will be cached.
  - obtainDeviceKey
```
public void obtainDeviceKey(IRAPICallback<IRInternetAPIService.PostDevicesResponse> callback)
```
    devicekeyを取得します。 Fetch a devicekey.
    
    Parameters:
    
    callback - devicekey取得結果を受け取るコールバック。 Callback to be notified a result which contains devicekey.
  - connectDeviceToWifi
```
public void connectDeviceToWifi(IRWifiInfo irWifiInfo,
                                IRAPICallback<IRDeviceAPIService.PostWifiResponse> callback)
```
    IRKitをWi-Fiに接続させます。Device HTTP APIが使える場合のみ動作します。 Connect an IRKit to Wi-Fi. This method works only if Device HTTP API is available.
    
    Parameters:
    
    irWifiInfo - 接続先のWi-Fi情報。 Target Wi-Fi.
    
    callback - 結果を受け取るコールバック。 Callback to be notified a result.
  - cancelPostDoor
```
public void cancelPostDoor()
```
    waitForDoor()をキャンセルします。 Cancel previously called waitForDoor().
  - waitForDoor
```
public void waitForDoor(java.lang.String deviceId,
                        IRAPICallback<IRInternetAPIService.PostDoorResponse> callback)
```
    POST /1/doorを呼んで結果を待機します。サーバ側でタイムアウトして408が返ってきた場合は再度リクエストして待機します。
    
    Call POST/1/door and wait for a result. When server returns 408 (server-side timeout), another request will be sent and this method will keep waiting.
    
    Parameters:
    
    deviceId - deviceid
    
    callback - 結果を受け取るコールバック。 Callback to be notified a result.
  - testIfIRKitWifiConnected
```
public void testIfIRKitWifiConnected(IRAPIResult result)
```
    192.168.1.1にリクエストを発行してレスポンスヘッダに"IRKit"が含まれていることを確認します。 Sends a request to 192.168.1.1 and checks if the response header contains "IRKit".
    
    Parameters:
    
    result - レスポンスヘッダにIRKitが含まれていればonSuccess()、含まれていなければonError()が呼ばれる。 If the response header contains "IRKit", onSuccess() will be called. Otherwise onError() will be called.
    
    Since:
    
    1.2.0
  - getInternetAPIService
```
public IRInternetAPIService getInternetAPIService()
```
    Internet HTTP APIを直接利用するためのインスタンスを返します。 Return the instance which provides direct access to Internet HTTP API.
    
    Returns:
    
    Internet HTTP APIを提供するインスタンス。 Instance which provides Internet HTTP API.
  - getDeviceAPIService
```
public IRDeviceAPIService getDeviceAPIService()
```
    Device HTTP APIを直接利用するためのインスタンスを返します。 Return the instance which provides direct access to Device HTTP API.
    
    Returns:
    
    Device HTTP APIを提供するインスタンス。 Instance which provides Device HTTP API.
  - getThrottledDeviceAPIService
```
public IRDeviceAPIService getThrottledDeviceAPIService(IRPeripheral peripheral)
```
    特定のIRKitに対してスロットル制御を行いながらDevice HTTP APIにアクセスするためのオブジェクトを返します。 Returns an object which accesses Device HTTP API with request throttling.
    
    Parameters:
    
    peripheral - 対象となるIRKitデバイス。 Target IRKit device.
    
    Returns:
    
    IRDeviceAPIService instance.
    
    Since:
    
    1.2.1
  - getThrottledDeviceAPIService
```
public IRDeviceAPIService getThrottledDeviceAPIService(java.lang.String deviceId)
```
    特定のIRKitに対してスロットル制御を行いながらDevice HTTP APIにアクセスするためのオブジェクトを返します。 Returns an object which accesses Device HTTP API with request throttling.
    
    Parameters:
    
    deviceId - 対象となるIRKitデバイスのdeviceid。 Deviceid of the target IRKit device.
    
    Returns:
    
    IRDeviceAPIService instance.
    
    Since:
    
    1.2.1
  - getThrottledDeviceAPIService
```
public IRDeviceAPIService getThrottledDeviceAPIService()
```
    スロットル制御を行いながらDevice HTTP APIにアクセスするためのオブジェクトを返します。 Returns an object which accesses Device HTTP API with request throttling.
    
    Returns:
    
    IRDeviceAPIService instance.
    
    Since:
    
    1.2.2
  - getThrottledInternetAPIService
```
public IRInternetAPIService getThrottledInternetAPIService(IRPeripheral peripheral)
```
    特定のIRKitに対してスロットル制御を行いながらInternet HTTP APIにアクセスするためのオブジェクトを返します。 Returns an object which accesses Internet HTTP API with request throttling.
    
    Parameters:
    
    peripheral - 対象となるIRKitデバイス。 Target IRKit device.
    
    Returns:
    
    IRInternetAPIService instance.
    
    Since:
    
    1.2.1
  - getThrottledInternetAPIService
```
public IRInternetAPIService getThrottledInternetAPIService(java.lang.String deviceId)
```
    特定のIRKitに対してスロットル制御を行いながらInternet HTTP APIにアクセスするためのオブジェクトを返します。 Returns an object which accesses Internet HTTP API with request throttling.
    
    Parameters:
    
    deviceId - 対象となるIRKitデバイスのdeviceid。 Deviceid of the target IRKit device.
    
    Returns:
    
    IRInternetAPIService instance.
    
    Since:
    
    1.2.1
  - getThrottledInternetAPIService
```
public IRInternetAPIService getThrottledInternetAPIService()
```
    スロットル制御を行いながらInternet HTTP APIにアクセスするためのオブジェクトを返します。 Returns an object which accesses Internet HTTP API with request throttling.
    
    Returns:
    
    IRInternetAPIService instance.
    
    Since:
    
    1.2.2
  - getClientKey
```
public java.lang.String getClientKey()
```
    clientkeyを返します。 Return the clientkey.
    
    Returns:
    
    clientkey
  - hasClientKey
```
public boolean hasClientKey()
```
    clientkeyがセット済みかどうかを返します。 Return whether clientkey has been set.
    
    Returns:
    
    clientkeyがセット済みならtrue。 True if clientkey has been set.

Class IRHTTPClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TAG

APIENDPOINT_BASE

DEVICE_API_ENDPOINT_IRKITWIFI

DEVICE_API_X_REQUESTED_WITH

Constructor Detail

IRHTTPClient

Method Detail

sharedInstance

setClientKey

setDeviceAPIEndpoint

registerClient

ensureRegisteredAndCall

sendSignalOverInternet

sendSignalOverLocalNetwork

waitForSignal

waitForSignal

cancelRequests

addClientKey

clearDeviceKeyCache

obtainDeviceKey

connectDeviceToWifi

cancelPostDoor

waitForDoor

testIfIRKitWifiConnected

getInternetAPIService

getDeviceAPIService

getThrottledDeviceAPIService

getThrottledDeviceAPIService

getThrottledDeviceAPIService

getThrottledInternetAPIService

getThrottledInternetAPIService

getThrottledInternetAPIService

getClientKey

hasClientKey