com.googlecode.android_scripting.facade
Class SettingsFacade

java.lang.Object
  com.googlecode.android_scripting.jsonrpc.RpcReceiver
      com.googlecode.android_scripting.facade.SettingsFacade

public class SettingsFacade
extends RpcReceiver

Exposes phone settings functionality.

Author:

Frank Spychalski (frank.spychalski@gmail.com)

Field Summary

static int	AIRPLANE_MODE_OFF
static int	AIRPLANE_MODE_ON

Constructor Summary

SettingsFacade(FacadeManager manager)
Creates a new SettingsFacade.

Method Summary

java.lang.Boolean	checkAirplaneMode()
java.lang.Boolean	checkRingerSilentMode()
java.lang.Boolean	checkScreenOn()
int	getMaxMediaVolume()
int	getMaxRingerVolume()
int	getMediaVolume()
int	getRingerVolume()
java.lang.Integer	getScreenBrightness()
java.lang.Integer	getScreenTimeout()
java.lang.Boolean	getVibrateMode(java.lang.Boolean ringer)
void	setMediaVolume(java.lang.Integer volume)
void	setRingerVolume(java.lang.Integer volume)
java.lang.Integer	setScreenBrightness(java.lang.Integer value)
java.lang.Integer	setScreenTimeout(java.lang.Integer value)
void	shutdown() Invoked when the receiver is shut down.
java.lang.Boolean	toggleAirplaneMode(java.lang.Boolean enabled)
java.lang.Boolean	toggleRingerSilentMode(java.lang.Boolean enabled)
java.lang.Boolean	toggleVibrateMode(java.lang.Boolean enabled, java.lang.Boolean ringer)

Methods inherited from class java.lang.Object

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

Field Detail

AIRPLANE_MODE_OFF

public static int AIRPLANE_MODE_OFF

AIRPLANE_MODE_ON

public static int AIRPLANE_MODE_ON

Constructor Detail

SettingsFacade

public SettingsFacade(FacadeManager manager)

Creates a new SettingsFacade.

Parameters:

service - is the Context the APIs will run under

Method Detail

setScreenTimeout

@Rpc(description="Sets the screen timeout to this number of seconds.",
     returns="The original screen timeout.")
public java.lang.Integer setScreenTimeout(@RpcParameter(name="value")
                                                                java.lang.Integer value)

getScreenTimeout

@Rpc(description="Returns the current screen timeout in seconds.",
     returns="the current screen timeout in seconds.")
public java.lang.Integer getScreenTimeout()

checkAirplaneMode

@Rpc(description="Checks the airplane mode setting.",
     returns="True if airplane mode is enabled.")
public java.lang.Boolean checkAirplaneMode()

toggleAirplaneMode

@Rpc(description="Toggles airplane mode on and off.",
     returns="True if airplane mode is enabled.")
public java.lang.Boolean toggleAirplaneMode(@RpcParameter(name="enabled")@RpcOptional
                                                                  java.lang.Boolean enabled)

checkRingerSilentMode

@Rpc(description="Checks the ringer silent mode setting.",
     returns="True if ringer silent mode is enabled.")
public java.lang.Boolean checkRingerSilentMode()

toggleRingerSilentMode

@Rpc(description="Toggles ringer silent mode on and off.",
     returns="True if ringer silent mode is enabled.")
public java.lang.Boolean toggleRingerSilentMode(@RpcParameter(name="enabled")@RpcOptional
                                                                      java.lang.Boolean enabled)

toggleVibrateMode

@Rpc(description="Toggles vibrate mode on and off. If ringer=true then set Ringer setting, else set Notification setting",
     returns="True if vibrate mode is enabled.")
public java.lang.Boolean toggleVibrateMode(@RpcParameter(name="enabled")@RpcOptional
                                                                 java.lang.Boolean enabled,
                                                                 @RpcParameter(name="ringer")@RpcOptional
                                                                 java.lang.Boolean ringer)

getVibrateMode

@Rpc(description="Checks Vibration setting. If ringer=true then query Ringer setting, else query Notification setting",
     returns="True if vibrate mode is enabled.")
public java.lang.Boolean getVibrateMode(@RpcParameter(name="ringer")@RpcOptional
                                                              java.lang.Boolean ringer)

getMaxRingerVolume

@Rpc(description="Returns the maximum ringer volume.")
public int getMaxRingerVolume()

getRingerVolume

@Rpc(description="Returns the current ringer volume.")
public int getRingerVolume()

setRingerVolume

@Rpc(description="Sets the ringer volume.")
public void setRingerVolume(@RpcParameter(name="volume")
                                           java.lang.Integer volume)

getMaxMediaVolume

@Rpc(description="Returns the maximum media volume.")
public int getMaxMediaVolume()

getMediaVolume

@Rpc(description="Returns the current media volume.")
public int getMediaVolume()

setMediaVolume

@Rpc(description="Sets the media volume.")
public void setMediaVolume(@RpcParameter(name="volume")
                                          java.lang.Integer volume)

getScreenBrightness

@Rpc(description="Returns the screen backlight brightness.",
     returns="the current screen brightness between 0 and 255")
public java.lang.Integer getScreenBrightness()

setScreenBrightness

@Rpc(description="Sets the the screen backlight brightness.",
     returns="the original screen brightness.")
public java.lang.Integer setScreenBrightness(@RpcParameter(name="value",description="brightness value between 0 and 255")
                                                                   java.lang.Integer value)

checkScreenOn

@Rpc(description="Checks if the screen is on or off (requires API level 7).",
     returns="True if the screen is currently on.")
public java.lang.Boolean checkScreenOn()
                                throws java.lang.Exception

Throws:

java.lang.Exception

shutdown

public void shutdown()

Description copied from class: RpcReceiver

Invoked when the receiver is shut down.

Specified by:

shutdown in class RpcReceiver