me.adaptive.arp.api

Class DeviceBridge

java.lang.Object

me.adaptive.arp.api.BaseSystemBridge

me.adaptive.arp.api.DeviceBridge

All Implemented Interfaces:

APIBridge, IAdaptiveRP, IBaseSystem, IDevice

public class DeviceBridge
extends BaseSystemBridge
implements IDevice, APIBridge

Interface for Managing the Device operations Auto-generated implementation of IDevice specification.

Field Summary

Fields inherited from class me.adaptive.arp.api.BaseSystemBridge

apiGroup

Constructor Summary

Constructors

Constructor and Description
DeviceBridge(IDevice delegate) Constructor with delegate.

Method Summary

Modifier and Type	Method and Description
void	addButtonListener(IButtonListener listener) Register a new listener that will receive button events.
void	addDeviceOrientationListener(IDeviceOrientationListener listener) Add a listener to start receiving device orientation change events.
IDevice	getDelegate() Get the delegate implementation.
DeviceInfo	getDeviceInfo() Returns the device information for the current device executing the runtime.
Locale	getLocaleCurrent() Gets the current Locale for the device.
ICapabilitiesOrientation	getOrientationCurrent() Returns the current orientation of the device.
APIResponse	invoke(APIRequest request) Invokes the given method specified in the API request object.
void	removeButtonListener(IButtonListener listener) De-registers an existing listener from receiving button events.
void	removeButtonListeners() Removed all existing listeners from receiving button events.
void	removeDeviceOrientationListener(IDeviceOrientationListener listener) Remove a listener to stop receiving device orientation change events.
void	removeDeviceOrientationListeners() Remove all listeners receiving device orientation events.
void	setDelegate(IDevice delegate) Set the delegate implementation.

Methods inherited from class me.adaptive.arp.api.BaseSystemBridge

getAPIGroup, getAPIVersion, getJSONParser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface me.adaptive.arp.api.IAdaptiveRP

getAPIGroup, getAPIVersion

Constructor Detail

DeviceBridge

public DeviceBridge(IDevice delegate)

Constructor with delegate.

Parameters:

delegate - The delegate implementing platform specific functions.

Method Detail

getDelegate

public final IDevice getDelegate()

Get the delegate implementation.

Returns:

IDevice delegate that manages platform specific functions..

setDelegate

public final void setDelegate(IDevice delegate)

Set the delegate implementation.

Parameters:

delegate - The delegate implementing platform specific functions.

addButtonListener

public void addButtonListener(IButtonListener listener)

Register a new listener that will receive button events.

Specified by:

addButtonListener in interface IDevice

Parameters:

listener - to be registered.

Since:

v2.0

addDeviceOrientationListener

public void addDeviceOrientationListener(IDeviceOrientationListener listener)

Add a listener to start receiving device orientation change events.

Specified by:

addDeviceOrientationListener in interface IDevice

Parameters:

listener - Listener to add to receive orientation change events.

Since:

v2.0.5

getDeviceInfo

public DeviceInfo getDeviceInfo()

Returns the device information for the current device executing the runtime.

Specified by:

getDeviceInfo in interface IDevice

Returns:

DeviceInfo for the current device.

Since:

v2.0

getLocaleCurrent

public Locale getLocaleCurrent()

Gets the current Locale for the device.

Specified by:

getLocaleCurrent in interface IDevice

Returns:

The current Locale information.

Since:

v2.0

getOrientationCurrent

public ICapabilitiesOrientation getOrientationCurrent()

Returns the current orientation of the device. Please note that this may be different from the orientation of the display. For display orientation, use the IDisplay APIs.

Specified by:

getOrientationCurrent in interface IDevice

Returns:

The current orientation of the device.

Since:

v2.0.5

removeButtonListener

public void removeButtonListener(IButtonListener listener)

De-registers an existing listener from receiving button events.

Specified by:

removeButtonListener in interface IDevice

Parameters:

listener - to be removed.

Since:

v2.0

removeButtonListeners

public void removeButtonListeners()

Removed all existing listeners from receiving button events.

Specified by:

removeButtonListeners in interface IDevice

Since:

v2.0

removeDeviceOrientationListener

public void removeDeviceOrientationListener(IDeviceOrientationListener listener)

Remove a listener to stop receiving device orientation change events.

Specified by:

removeDeviceOrientationListener in interface IDevice

Parameters:

listener - Listener to remove from receiving orientation change events.

Since:

v2.0.5

removeDeviceOrientationListeners

public void removeDeviceOrientationListeners()

Remove all listeners receiving device orientation events.

Specified by:

removeDeviceOrientationListeners in interface IDevice

Since:

v2.0.5

invoke

public APIResponse invoke(APIRequest request)

Invokes the given method specified in the API request object.

Specified by:

invoke in interface APIBridge

Overrides:

invoke in class BaseSystemBridge

Parameters:

request - APIRequest object containing method name and parameters.

Returns:

APIResponse with status code, message and JSON response or a JSON null string for void functions. Status code 200 is OK, all others are HTTP standard error conditions.