IRPeripheral (irkit-android-sdk 1.3.1 API)

java.lang.Object
- com.getirkit.irkit.IRPeripheral

All Implemented Interfaces:

android.os.Parcelable, java.io.Serializable
```
public class IRPeripheral
extends java.lang.Object
implements java.io.Serializable, android.os.Parcelable
```
IRKitデバイスを表します。 An IRKit device.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`IRPeripheral.IRPeripheralListener`
`static interface`	`IRPeripheral.ReachabilityResult` testReachability()で使用するコールバック用インタフェースです。 Callback interface for testReachability().

Nested classes/interfaces inherited from interface android.os.Parcelable
android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields
Modifier and Type Field and Description

static android.os.Parcelable.Creator<IRPeripheral> CREATOR

static java.lang.String IRKIT_MODEL_NAME

static java.lang.String TAG
- Fields inherited from interface android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Fields
Modifier and Type	Field and Description
`static android.os.Parcelable.Creator<IRPeripheral>`	`CREATOR`
`static java.lang.String`	`IRKIT_MODEL_NAME`
`static java.lang.String`	`TAG`

Constructor Summary

Constructors
Constructor and Description

IRPeripheral()

Constructors
Constructor and Description
`IRPeripheral()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`describeContents()`
`void`	`fetchDeviceId()` POST /keys を呼んでdeviceidを取得します。 Fetch deviceid by calling POST /keys.
`void`	`fetchModelInfo()` modelNameとfirmwareVersionを取得します。 Fetch modelName and firmwareVersion.
`void`	`fetchModelInfo(int retryCount)` modelNameとfirmwareVersionを取得します。 Fetch modelName and firmwareVersion.
`java.lang.String`	`getCustomizedName()`
`java.lang.String`	`getDeviceAPIEndpoint()` このIRKitデバイスにローカルネットワーク内で接続するためのエンドポイントを返します。 Return a local network endpoint for this IRKit device.
`java.lang.String`	`getDeviceId()`
`java.lang.String`	`getFirmwareVersion()`
`java.util.Date`	`getFoundDate()`
`java.net.InetAddress`	`getHost()`
`java.lang.String`	`getHostname()`
`IRPeripheral.IRPeripheralListener`	`getListener()`
`java.lang.String`	`getModelName()`
`int`	`getPort()`
`boolean`	`hasDeviceId()`
`boolean`	`hasModelInfo()`
`boolean`	`isFetchingDeviceId()`
`boolean`	`isLocalAddressResolved()` IRKitがローカルネットワーク内に見つかっているかどうかを返します。 Return whether this IRKit is found on local network.
`boolean`	`isReachable()` IRKitへローカルネットワーク内で到達可能かどうかをテストします。最大で100ミリ秒ブロックします。 Test whether this IRKit is reachable on local network.
`boolean`	`isWaitingForConfiguration()` 自動設定を現在待機中かどうかを返します。 Returns whether this peripheral is waiting for auto configuration.
`void`	`lostLocalAddress()` IRKitにローカルネットワーク内で到達できなくなった際にこのメソッドを呼びます。 Call this method when IRKit is no longer reachable on local network.
`static java.util.Map<java.lang.String,java.lang.String>`	`parseServerHeaderValue(java.lang.String server)` Device HTTP APIのレスポンスに含まれるServerヘッダの値を解釈した結果を返します。 Returns parsed result of Server header contained in a response of Device HTTP API.
`void`	`setCustomizedName(java.lang.String customizedName)`
`void`	`setDeviceId(java.lang.String deviceId)`
`void`	`setFirmwareVersion(java.lang.String firmwareVersion)`
`void`	`setFoundDate(java.util.Date foundDate)`
`void`	`setHost(java.net.InetAddress host)`
`void`	`setHostname(java.lang.String hostname)`
`void`	`setIsWaitingForConfiguration(boolean isWaitingForConfiguration)` 自動設定を現在待機中かどうかをセットします。 Sets whether this peripheral is waiting for auto configuration.
`void`	`setListener(IRPeripheral.IRPeripheralListener listener)`
`void`	`setModelName(java.lang.String modelName)`
`void`	`setPort(int port)`
`boolean`	`storeResponseHeaders(Response response)` Device HTTP APIのレスポンスヘッダを解釈してフィールドを必要に応じて更新します。 Parse headers in Device HTTP API response and store in fields if updated.
`boolean`	`storeServerHeaderValue(java.lang.String server)` Device HTTP APIのレスポンスに含まれるServerヘッダの値を解釈します。 modelNameとfirmwareVersionの値が変化している場合はフィールドに保存します。 Parse the value of Server header in Device HTTP API response.
`void`	`testReachability(IRPeripheral.ReachabilityResult result)` IRKitにローカルネットワーク内で到達可能かどうかを非同期にテストします。 Test asynchronously whether this IRKit is reachable on local network.
`org.json.JSONObject`	`toJSONObject()`
`java.lang.String`	`toString()`
`void`	`writeToParcel(android.os.Parcel out, int flags)`

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

- Field Detail
  - TAG
```
public static final transient java.lang.String TAG
```
    See Also:
    
    Constant Field Values
  - IRKIT_MODEL_NAME
```
public static final transient java.lang.String IRKIT_MODEL_NAME
```
    See Also:
    
    Constant Field Values
  - CREATOR
```
public static final android.os.Parcelable.Creator<IRPeripheral> CREATOR
```
- Constructor Detail
  - IRPeripheral
```
public IRPeripheral()
```
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getListener
```
public IRPeripheral.IRPeripheralListener getListener()
```
  - setListener
```
public void setListener(IRPeripheral.IRPeripheralListener listener)
```
  - getHostname
```
public java.lang.String getHostname()
```
  - setHostname
```
public void setHostname(java.lang.String hostname)
```
  - getCustomizedName
```
public java.lang.String getCustomizedName()
```
  - setCustomizedName
```
public void setCustomizedName(java.lang.String customizedName)
```
  - getFoundDate
```
public java.util.Date getFoundDate()
```
  - setFoundDate
```
public void setFoundDate(java.util.Date foundDate)
```
  - hasDeviceId
```
public boolean hasDeviceId()
```
  - getDeviceId
```
public java.lang.String getDeviceId()
```
  - setDeviceId
```
public void setDeviceId(java.lang.String deviceId)
```
  - hasModelInfo
```
public boolean hasModelInfo()
```
  - getModelName
```
public java.lang.String getModelName()
```
  - setModelName
```
public void setModelName(java.lang.String modelName)
```
  - getFirmwareVersion
```
public java.lang.String getFirmwareVersion()
```
  - isFetchingDeviceId
```
public boolean isFetchingDeviceId()
```
  - setFirmwareVersion
```
public void setFirmwareVersion(java.lang.String firmwareVersion)
```
  - getHost
```
public java.net.InetAddress getHost()
```
  - setHost
```
public void setHost(java.net.InetAddress host)
```
  - getPort
```
public int getPort()
```
  - setPort
```
public void setPort(int port)
```
  - isWaitingForConfiguration
```
public boolean isWaitingForConfiguration()
```
    自動設定を現在待機中かどうかを返します。 Returns whether this peripheral is waiting for auto configuration.
    
    Returns:
    
    自動設定を待機中ならtrue。 True if this peripheral is waiting for auto configuration.
    
    Since:
    
    1.2.1
  - setIsWaitingForConfiguration
```
public void setIsWaitingForConfiguration(boolean isWaitingForConfiguration)
```
    自動設定を現在待機中かどうかをセットします。 Sets whether this peripheral is waiting for auto configuration.
    
    Parameters:
    
    isWaitingForConfiguration - 自動設定を待機中かどうか。 Whether this peripheral is waiting for auto configuration.
    
    Since:
    
    1.2.1
  - storeServerHeaderValue
```
public boolean storeServerHeaderValue(java.lang.String server)
```
    Device HTTP APIのレスポンスに含まれるServerヘッダの値を解釈します。 modelNameとfirmwareVersionの値が変化している場合はフィールドに保存します。 Parse the value of Server header in Device HTTP API response. modelName and firmwareVersion may be updated.
    
    Parameters:
    
    server - Serverヘッダの値。 Server header value.
    
    Returns:
    
    modelNameまたはfirmwareVersionの値が更新された場合はtrue。 True if modelName or firmwareVersion has modified.
  - parseServerHeaderValue
```
public static java.util.Map<java.lang.String,java.lang.String> parseServerHeaderValue(java.lang.String server)
```
    Device HTTP APIのレスポンスに含まれるServerヘッダの値を解釈した結果を返します。 Returns parsed result of Server header contained in a response of Device HTTP API.
    
    Parameters:
    
    server - Serverヘッダの値。 Server header value.
    
    Returns:
    
    modelNameとfirmwareVersionをキーとして含むMap。 Map containing modelName and firmwareVersion as the keys.
    
    Since:
    
    1.2.0
  - storeResponseHeaders
```
public boolean storeResponseHeaders(Response response)
```
    Device HTTP APIのレスポンスヘッダを解釈してフィールドを必要に応じて更新します。 Parse headers in Device HTTP API response and store in fields if updated.
    
    Parameters:
    
    response - Response object
    
    Returns:
    
    フィールドが更新された場合はtrue。 True if a field is modified.
  - fetchModelInfo
```
public void fetchModelInfo()
```
    modelNameとfirmwareVersionを取得します。 Fetch modelName and firmwareVersion.
  - fetchModelInfo
```
public void fetchModelInfo(int retryCount)
```
    modelNameとfirmwareVersionを取得します。 Fetch modelName and firmwareVersion.
    
    Parameters:
    
    retryCount - 最大リトライ数。 Max retry count.
  - fetchDeviceId
```
public void fetchDeviceId()
```
    POST /keys を呼んでdeviceidを取得します。 Fetch deviceid by calling POST /keys.
    
    See Also:
    
    POST /keys
  - getDeviceAPIEndpoint
```
public java.lang.String getDeviceAPIEndpoint()
```
    このIRKitデバイスにローカルネットワーク内で接続するためのエンドポイントを返します。 Return a local network endpoint for this IRKit device.
    
    Returns:
    
    "http://host:port" のような文字列。またはIRKitがローカルネットワーク内に見つからない場合はnull。 A string like "http://host:port", or null if this peripheral is not found on local network.
  - isLocalAddressResolved
```
public boolean isLocalAddressResolved()
```
    IRKitがローカルネットワーク内に見つかっているかどうかを返します。 Return whether this IRKit is found on local network.
    
    Returns:
    
    IRKitがローカルネットワーク内に検出済みの場合はtrue。 True if IRKit is found on local network.
  - isReachable
```
public boolean isReachable()
```
    IRKitへローカルネットワーク内で到達可能かどうかをテストします。最大で100ミリ秒ブロックします。 Test whether this IRKit is reachable on local network. Blocks up to 100 milliseconds.
    
    Returns:
    
    IRKitに到達可能な場合はtrue。 True if IRKit is reachable.
  - testReachability
```
public void testReachability(IRPeripheral.ReachabilityResult result)
```
    IRKitにローカルネットワーク内で到達可能かどうかを非同期にテストします。 Test asynchronously whether this IRKit is reachable on local network.
    
    Parameters:
    
    result - ReachabilityResult object
  - lostLocalAddress
```
public void lostLocalAddress()
```
    IRKitにローカルネットワーク内で到達できなくなった際にこのメソッドを呼びます。 Call this method when IRKit is no longer reachable on local network.
  - toJSONObject
```
public org.json.JSONObject toJSONObject()
```
  - describeContents
```
public int describeContents()
```
    Specified by:
    
    describeContents in interface android.os.Parcelable
  - writeToParcel
```
public void writeToParcel(android.os.Parcel out,
                          int flags)
```
    Specified by:
    
    writeToParcel in interface android.os.Parcelable

Class IRPeripheral

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TAG

IRKIT_MODEL_NAME

CREATOR

Constructor Detail

IRPeripheral

Method Detail

toString

getListener

setListener

getHostname

setHostname

getCustomizedName

setCustomizedName

getFoundDate

setFoundDate

hasDeviceId

getDeviceId

setDeviceId

hasModelInfo

getModelName

setModelName

getFirmwareVersion

isFetchingDeviceId

setFirmwareVersion

getHost

setHost

getPort

setPort

isWaitingForConfiguration

setIsWaitingForConfiguration

storeServerHeaderValue

parseServerHeaderValue

storeResponseHeaders

fetchModelInfo

fetchModelInfo

fetchDeviceId

getDeviceAPIEndpoint

isLocalAddressResolved

isReachable

testReachability

lostLocalAddress

toJSONObject

describeContents

writeToParcel