AlarmManagerFacade

• cancelRepeating
• scheduleAbsolute
• scheduleInexactRepeating
• scheduleRelative
• scheduleRepeating

AndroidFacade

• getClipboard
• getInput
• getIntent
• getPackageVersion
• getPackageVersionCode
• getPassword
• makeToast
• notify
• requiredVersion
• sendEmail
• setClipboard
• startActivity
• startActivityForResult
• vibrate

ApplicationManagerFacade

• forceStopPackage
• getLaunchableApplications
• getRunningPackages
• launch

BatteryManagerFacade

• batteryCheckPresent
• batteryGetHealth
• batteryGetLevel
• batteryGetPlugType
• batteryGetStatus
• batteryGetTechnology
• batteryGetTemperature
• batteryGetVoltage

BluetoothFacade Requires API Level 5.

• bluetoothAccept
• bluetoothConnect
• bluetoothGetConnectedDeviceName
• bluetoothMakeDiscoverable
• bluetoothRead
• bluetoothReadLine
• bluetoothReadReady
• bluetoothStop
• bluetoothWrite
• checkBluetoothState
• toggleBluetoothState

CameraFacade

• cameraCapturePicture
• cameraInteractiveCapturePicture

CommonIntentsFacade

• pick
• scanBarcode
• search
• view
• viewContacts
• viewHtml
• viewMap

ConditionManagerFacade

• onRingerSilent

ContactsFacade

• contactsGet
• contactsGetAttributes
• contactsGetById
• contactsGetCount
• contactsGetIds
• pickContact
• pickPhone

EventFacade

• receiveEvent

LocationFacade

• geocode
• getLastKnownLocation
• readLocation
• startLocating
• stopLocating

MediaRecorderFacade

• recorderCaptureVideo
• recorderStartMicrophone
• recorderStartPhone
• recorderStop
• startInteractiveVideoRecording

PhoneFacade

• getCellLocation
• phoneCall
• phoneCallNumber
• phoneDial
• phoneDialNumber
• readPhoneState
• startTrackingPhoneState
• stopTrackingPhoneState

PulseGeneratorFacade

• pulseGeneratorGetHz
• pulseGeneratorGetHzSamples
• pulseGeneratorGetLeftPulseMs
• pulseGeneratorGetLeftPulsePercent
• pulseGeneratorGetLeftPulseSamples
• pulseGeneratorGetRightPulseMs
• pulseGeneratorGetRightPulsePercent
• pulseGeneratorGetRightPulseSamples
• pulseGeneratorIsPlaying
• pulseGeneratorRun
• pulseGeneratorSetHzPercent
• pulseGeneratorSetLeftPulsePercent
• pulseGeneratorSetRightPulsePercent
• pulseGeneratorStop
• pulseGeneratorToggleInverted
• pulseGeneratorTogglePlayback
• pulseGenteratorSetHz

SensorManagerFacade

• readSensors
• startSensing
• stopSensing

SettingsFacade

• checkAirplaneMode
• checkRingerSilentMode
• checkScreenOn
• getMaxMediaVolume
• getMaxRingerVolume
• getMediaVolume
• getRingerVolume
• getScreenBrightness
• getScreenTimeout
• setMediaVolume
• setRingerVolume
• setScreenBrightness
• setScreenTimeout
• toggleAirplaneMode
• toggleRingerSilentMode

SignalStrengthFacade Requires API Level 7.

• readSignalStrengths
• startTrackingSignalStrengths
• stopTrackingSignalStrengths

SmsFacade

• smsDeleteMessage
• smsGetAttributes
• smsGetMessageById
• smsGetMessageCount
• smsGetMessageIds
• smsGetMessages
• smsMarkMessageRead
• smsSend

SpeechRecognitionFacade

• recognizeSpeech

TextToSpeechFacade Requires API Level 4.

• ttsIsSpeaking
• ttsSpeak

ToneGeneratorFacade

• generateDtmfTones

UiFacade

• dialogCreateAlert
• dialogCreateHorizontalProgress
• dialogCreateSeekBar
• dialogCreateSpinnerProgress
• dialogDismiss
• dialogGetResponse
• dialogGetSelectedItems
• dialogSetCurrentProgress
• dialogSetItems
• dialogSetMaxProgress
• dialogSetMultiChoiceItems
• dialogSetNegativeButtonText
• dialogSetNeutralButtonText
• dialogSetPositiveButtonText
• dialogSetSingleChoiceItems
• dialogShow

WakeLockFacade

• wakeLockAcquireBright
• wakeLockAcquireDim
• wakeLockAcquireFull
• wakeLockAcquirePartial
• wakeLockRelease

WifiFacade

• checkWifiState
• toggleWifiState
• wifiGetScanResults
• wifiStartScan

_{batteryCheckPresent}¶

batteryCheckPresent()

Returns true if battery is present

Requires API Level 5.

_{batteryGetHealth}¶

batteryGetHealth()

Returns battery health:
1 - unknown;
2 - good;
3 - overheat;
4 - dead;
5 - over voltage;
6 - unspecified failure;

_{batteryGetLevel}¶

batteryGetLevel()

Returns current battery level (percentage)

Requires API Level 5.

_{batteryGetPlugType}¶

batteryGetPlugType()

Returns plug type:
-1 - unknown;
0 - unplugged;
1 - power source is an AC charger;
2 - power source is a USB port;

_{batteryGetStatus}¶

batteryGetStatus()

Returns battery status:
1 - unknown;
2 - charging;
3 - discharging;
4 - not charging;
5 - full;

_{batteryGetTechnology}¶

batteryGetTechnology()

Returns battery technology

Requires API Level 5.

_{batteryGetTemperature}¶

batteryGetTemperature()

Returns current battery temperature

Requires API Level 5.

_{batteryGetVoltage}¶

batteryGetVoltage()

Returns current battery voltage

Requires API Level 5.

_{bluetoothAccept}¶

bluetoothAccept(
 String uuid[optional, default 457807c0-4897-11df-9879-0800200c9a66])

Listens for and accepts a Bluetooth connection.

Requires API Level 5.

_{bluetoothConnect}¶

bluetoothConnect(
 String uuid[optional, default 457807c0-4897-11df-9879-0800200c9a66]: It is    
sometimes necessary to specify a particular UUID to use for the Bluetooth      
connection.)

Displays a dialog with discoverable devices and connects to one chosen by the  
user.

Returns:
  True if the connection was established successfully.

Requires API Level 5.

_{bluetoothGetConnectedDeviceName}¶

bluetoothGetConnectedDeviceName()

Returns the name of the connected device.

Requires API Level 5.

_{bluetoothMakeDiscoverable}¶

bluetoothMakeDiscoverable(
 Integer duration[optional, default 300]: period of time, in seconds, during    
which the device should be discoverable)

Requests that the device be discoverable for Bluetooth connections.

Requires API Level 5.

_{bluetoothRead}¶

bluetoothRead(
 Integer bufferSize[optional, default 4096])

Read up to bufferSize bytes.

Requires API Level 5.

_{bluetoothReadLine}¶

bluetoothReadLine()

Read the next line.

Requires API Level 5.

_{bluetoothReadReady}¶

bluetoothReadReady()

Returns True if the next read is guaranteed not to block.

Requires API Level 5.

_{bluetoothStop}¶

bluetoothStop()

Stops Bluetooth connection.

Requires API Level 5.

_{bluetoothWrite}¶

bluetoothWrite(
 String bytes)

Sends bytes over the currently open Bluetooth connection.

Requires API Level 5.

_{cameraCapturePicture}¶

cameraCapturePicture(
 String path,
 Boolean useAutoFocus[optional, default true])

Take a picture and save it to the specified path.

Returns:
 A map of Booleans autoFocus and takePicture where True indicates success.

_{cameraInteractiveCapturePicture}¶

cameraInteractiveCapturePicture(
 String path)

Starts the image capture application to take a picture and saves it to the      
specified path.

_{cancelRepeating}¶

cancelRepeating(
 String script)

cancels all scheduled regular executions of a given script

_{checkAirplaneMode}¶

checkAirplaneMode()

Checks the airplane mode setting.

Returns:
  True if airplane mode is enabled.

_{checkBluetoothState}¶

checkBluetoothState()

Checks Bluetooth state.

Returns:
  True if Bluetooth is enabled.

Requires API Level 5.

_{checkRingerSilentMode}¶

checkRingerSilentMode()

Checks the ringer silent mode setting.

Returns:
  True if ringer silent mode is enabled.

_{checkScreenOn}¶

checkScreenOn()

Checks if the screen is on or off (requires API level 7).

Returns:
  True if the screen is currently on.

_{checkWifiState}¶

checkWifiState()

Checks Wifi state.

Returns:
  True if Wifi is enabled.

_contactsGet¶

contactsGet(
 JSONArray attributes[optional])

Returns a List of all contacts.

Returns:
  a List of contacts as Maps

_{contactsGetAttributes}¶

contactsGetAttributes()

Returns a List of all possible attributes for contacts.

_{contactsGetById}¶

contactsGetById(
 Integer id,
  JSONArray attributes[optional])

Returns contacts by ID.

_{contactsGetCount}¶

contactsGetCount()

Returns the number of contacts.

_{contactsGetIds}¶

contactsGetIds()

Returns a List of all contact IDs.

_{dialogCreateAlert}¶

dialogCreateAlert(
 String Title[optional],
  String Message[optional])

Create alert dialog.

_{dialogCreateHorizontalProgress}¶

dialogCreateHorizontalProgress(
 String Title[optional],
 String Message[optional],
 Integer Maximum progress[optional, default 100])

Create a horizontal progress dialog.

_{dialogCreateSeekBar}¶

dialogCreateSeekBar(
 Integer Starting value[optional, default 50],
 Integer Maximum value[optional, default 100],
 String Title,
  String Message)

Create seek bar dialog.

_{dialogCreateSpinnerProgress}¶

dialogCreateSpinnerProgress(
 String Title[optional],
 String Message[optional],
 Integer Maximum progress[optional, default 100])

Create a spinner progress dialog.

_{dialogDismiss}¶

dialogDismiss()

Dismiss dialog.

_{dialogGetResponse}¶

dialogGetResponse()

Returns dialog response.

_{dialogGetSelectedItems}¶

dialogGetSelectedItems()

This method provides list of items user selected.

Returns:
  Selected items

_{dialogSetCurrentProgress}¶

dialogSetCurrentProgress(
 Integer current)

Set progress dialog current value.

_{dialogSetItems}¶

dialogSetItems(
  JSONArray items)

Set alert dialog list items.

_{dialogSetMaxProgress}¶

dialogSetMaxProgress(
  Integer max)

Set progress dialog maximum value.

_{dialogSetMultiChoiceItems}¶

dialogSetMultiChoiceItems(
 JSONArray items,
 JSONArray selected[optional]: list of selected items)

Set dialog multiple choice items and selection.

_{dialogSetNegativeButtonText}¶

dialogSetNegativeButtonText(
  String text)

Set alert dialog button text.

_{dialogSetNeutralButtonText}¶

dialogSetNeutralButtonText(
  String text)

Set alert dialog button text.

_{dialogSetPositiveButtonText}¶

dialogSetPositiveButtonText(
 String text)

Set alert dialog positive button text.

_{dialogSetSingleChoiceItems}¶

dialogSetSingleChoiceItems(
 JSONArray items,
 Integer selected[optional, default 0]: selected item index)

Set dialog single choice items and selected item.

_dialogShow¶

dialogShow()

Show dialog.

_{forceStopPackage}¶

forceStopPackage(
 String packageName: name of package)

Force stops a package.

_{generateDtmfTones}¶

generateDtmfTones(
 String phoneNumber,
 Integer toneDuration[optional, default 100]: duration of each tone in          
milliseconds)

Generate DTMF tones for the given phone number.

_geocode¶

geocode(
 Double latitude,
 Double longitude,
 Integer maxResults[optional, default 1]: maximum number of results)

Returns a list of addresses for the given latitude and longitude.

Returns:
  A list of addresses.

_{getCellLocation}¶

getCellLocation()

Returns the current cell location.

_getClipboard¶

getClipboard()

Read text from the clipboard.

Returns:
  The text in the clipboard.

_getInput¶

getInput(
 String title[optional, default SL4A Input]: title of the input box,
 String message[optional, default Please enter value:]: message to display      
above the input box)

Queries the user for a text input.

_getIntent¶

getIntent()

Returns the intent that launched the script.

_{getLastKnownLocation}¶

getLastKnownLocation()

Returns the last known location of the device.

Returns:
  A map of location information by provider.

_{getLaunchableApplications}¶

getLaunchableApplications()

Returns a list of all launchable application class names.

_{getMaxMediaVolume}¶

getMaxMediaVolume()

Returns the maximum media volume.

_{getMaxRingerVolume}¶

getMaxRingerVolume()

Returns the maximum ringer volume.

_{getMediaVolume}¶

getMediaVolume()

Returns the current media volume.

_{getPackageVersion}¶

getPackageVersion(
  String packageName)

Retrieve package version string

_{getPackageVersionCode}¶

getPackageVersionCode(
  String packageName)

Retrieve package version code

_getPassword¶

getPassword(
 String title[optional, default SL4A Password Input]: title of the input box,
 String message[optional, default Please enter password:]: message to display  
above the input box)

Queries the user for a password.

_{getRingerVolume}¶

getRingerVolume()

Returns the current ringer volume.

_{getRunningPackages}¶

getRunningPackages()

Returns a list of packages running activities or services.

Returns:
  List of packages running activities.

_{getScreenBrightness}¶

getScreenBrightness()

Returns the screen backlight brightness.

Returns:
  the current screen brightness between 0 and 255

_{getScreenTimeout}¶

getScreenTimeout()

Returns the current screen timeout in seconds.

Returns:
  the current screen timeout in seconds.

_launch¶

launch(
  String className)

Start activity with the given class name.

_makeToast¶

makeToast(
  String message)

Displays a short-duration Toast notification.

_notify¶

notify(
 String title: title,
 String message)

Displays a notification that will be canceled when the user clicks on it.

_{onRingerSilent}¶

onRingerSilent(
 String scriptName: script to execute when the ringer volume is set to silent,  
or set to anything other than silent)

Schedules a script for execution when the ringer volume is set to silent.

_phoneCall¶

phoneCall(
  String uri)

Calls a contact/phone number by URI.

_{phoneCallNumber}¶

phoneCallNumber(
  String phone number)

Calls a phone number.

_phoneDial¶

phoneDial(
  String uri)

Dials a contact/phone number by URI.

_{phoneDialNumber}¶

phoneDialNumber(
  String phone number)

Dials a phone number.

_pick¶

pick(
 String uri)

Display content to be picked by URI (e.g. contacts)

Returns:
  A map of result values.

_pickContact¶

pickContact()

Displays a list of contacts to pick from.

Returns:
  A map of result values.

_pickPhone¶

pickPhone()

Displays a list of phone numbers to pick from.

Returns:
  The selected phone number.

_{pulseGeneratorGetHz}¶

pulseGeneratorGetHz()

Wraps PulseGenerator getHz().

_{pulseGeneratorGetHzSamples}¶

pulseGeneratorGetHzSamples()

Wraps PulseGenerator getHzSamples().

_{pulseGeneratorGetLeftPulseMs}¶

pulseGeneratorGetLeftPulseMs()

Wraps PulseGenerator getLeftPulseMs().

_{pulseGeneratorGetLeftPulsePercent}¶

pulseGeneratorGetLeftPulsePercent()

Wraps PulseGenerator getLeftPulsePercent().

_{pulseGeneratorGetLeftPulseSamples}¶

pulseGeneratorGetLeftPulseSamples()

Wraps PulseGenerator getLeftPulseSamples().

_{pulseGeneratorGetRightPulseMs}¶

pulseGeneratorGetRightPulseMs()

Wraps PulseGenerator getRightPulseMs().

_{pulseGeneratorGetRightPulsePercent}¶

pulseGeneratorGetRightPulsePercent()

Wraps PulseGenerator getRightPulsePercent().

_{pulseGeneratorGetRightPulseSamples}¶

pulseGeneratorGetRightPulseSamples()

Wraps PulseGenerator getRightPulseSamples().

_{pulseGeneratorIsPlaying}¶

pulseGeneratorIsPlaying()

Wraps PulseGenerator isPlaying().

_{pulseGeneratorRun}¶

pulseGeneratorRun()

Wraps PulseGenerator run().

_{pulseGeneratorSetHzPercent}¶

pulseGeneratorSetHzPercent(
 Integer percent)

Wraps PulseGenerator setHzPercent().

_{pulseGeneratorSetLeftPulsePercent}¶

pulseGeneratorSetLeftPulsePercent(
 Integer percent)

Wraps PulseGenerator setLeftPulsePercent().

_{pulseGeneratorSetRightPulsePercent}¶

pulseGeneratorSetRightPulsePercent(
 Integer percent)

Wraps PulseGenerator setRightPulsePercent().

_{pulseGeneratorStop}¶

pulseGeneratorStop()

Wraps PulseGenerator stop().

_{pulseGeneratorToggleInverted}¶

pulseGeneratorToggleInverted()

Wraps PulseGenerator toggleInverted().

_{pulseGeneratorTogglePlayback}¶

pulseGeneratorTogglePlayback()

Wraps PulseGenerator togglePlayback().

_{pulseGenteratorSetHz}¶

pulseGenteratorSetHz(
  Float hz)

Wraps PulseGenerator setHz().

_readLocation¶

readLocation()

Returns the current location as indicated by all available providers.

Returns:
  A map of location information by provider.

_{readPhoneState}¶

readPhoneState()

Returns the current phone state and incoming number.

Returns:
  A Map of "state" and "incomingNumber"

_readSensors¶

readSensors()

Starts recording sensor data to be available for polling.

_{readSignalStrengths}¶

readSignalStrengths()

Returns the current signal strengths.

Returns:
  A map of "gsm_signal_strength"

Requires API Level 7.

_receiveEvent¶

receiveEvent()

Receives the most recent event (i.e. location or sensor update, etc.)

Returns:
  Map of event properties.

_{recognizeSpeech}¶

recognizeSpeech(
 String prompt[optional]: text prompt to show to the user when asking them to  
speak,
 String language[optional]: language override to inform the recognizer that it  
should expect speech in a language different than the one set in the            
java.util.Locale.getDefault(),
 String languageModel[optional]: informs the recognizer which speech model to  
prefer (see android.speech.RecognizeIntent))

Recognizes user's speech and returns the most likely result.

Returns:
  An empty string in case the speech cannot be recongnized.

_{recorderCaptureVideo}¶

recorderCaptureVideo(
 String targetPath,
 Double duration[optional],
 Boolean recordAudio[optional, default true])

Records video (and optionally audio) from the camera and saves it to the given  
location.
Duration specifies the maximum duration of the recording session.
If duration is not provided this method will return immediately and the        
recording will only be stopped
when recorderStop is called or when a scripts exits.
Otherwise it will block for the time period equal to the duration argument.

_{recorderStartMicrophone}¶

recorderStartMicrophone(
 String targetPath)

Records audio from the microphone and saves it to the given location.

_{recorderStartPhone}¶

recorderStartPhone(
 String targetPath)

Records audio from the phone and saves it to the given location.

_recorderStop¶

recorderStop()

Stops a previously started recording.

_{requiredVersion}¶

requiredVersion(
 Integer requiredVersion)

Check if SL4A is higher or equal of specified version

_scanBarcode¶

scanBarcode()

Starts the barcode scanner.

Returns:
  A Map representation of the result Intent.

_{scheduleAbsolute}¶

scheduleAbsolute(
 String script: script to execute,
 Double time: time of invocation, in seconds since epoch,
 Boolean wakeup[optional, default true]: whether or not to wake up the device  
if asleep)

schedules one-time execution of a script

_{scheduleInexactRepeating}¶

scheduleInexactRepeating(
 Double interval: the interval between invocations, in seconds,
 String script: the script to execute,
 Boolean wakeup[optional, default true]: whether or not to wakeup the device if
asleep)

schedules a script for (inexact) regular execution - saves battery in          
comparison to scheduleRepeating

_{scheduleRelative}¶

scheduleRelative(
 String script: script to execute,
 Double secondsFromNow: after what time to execute the script,
 Boolean wakeup[optional, default true]: whether or not to wake up the device  
if asleep)

schedules one-time execution of a script, a given number of seconds from now

_{scheduleRepeating}¶

scheduleRepeating(
 Double interval: interval between invocations, in seconds,
 String script: script to execute,
 Double firstExecutionTime[optional]: first time to execute script, in seconds  
since epoch,
 Boolean wakeup[optional, default true]: whether or not to wake up the device  
if asleep)

scheudles a script for (exact) regular execution

_search¶

search(
  String query)

Starts a search for the given query.

_sendEmail¶

sendEmail(
 String recipientAddress,
 String subject,
 String body)

Launches an activity that sends an e-mail message to a given recipient.

_setClipboard¶

setClipboard(
  String text)

Put text in the clipboard.

_{setMediaVolume}¶

setMediaVolume(
  Integer volume)

Sets the media volume.

_{setRingerVolume}¶

setRingerVolume(
  Integer volume)

Sets the ringer volume.

_{setScreenBrightness}¶

setScreenBrightness(
 Integer value: brightness value between 0 and 255)

Sets the the screen backlight brightness.

Returns:
  the original screen brightness.

_{setScreenTimeout}¶

setScreenTimeout(
 Integer value)

Sets the screen timeout to this number of seconds.

Returns:
  The original screen timeout.

_{smsDeleteMessage}¶

smsDeleteMessage(
 Integer id)

Deletes a message.

Returns:
  True if the message was deleted

_{smsGetAttributes}¶

smsGetAttributes()

Returns a List of all possible message attributes.

_{smsGetMessageById}¶

smsGetMessageById(
 Integer id: message ID,
 JSONArray attributes[optional])

Returns message attributes.

_{smsGetMessageCount}¶

smsGetMessageCount(
 Boolean unreadOnly,
 String folder[optional, default inbox])

Returns the number of messages.

_{smsGetMessageIds}¶

smsGetMessageIds(
 Boolean unreadOnly,
 String folder[optional, default inbox])

Returns a List of all message IDs.

_{smsGetMessages}¶

smsGetMessages(
 Boolean unreadOnly,
 String folder[optional, default inbox],
 JSONArray attributes[optional])

Returns a List of all messages.

Returns:
  a List of messages as Maps

_{smsMarkMessageRead}¶

smsMarkMessageRead(
 JSONArray ids: List of message IDs to mark as read.,
 Boolean read)

Marks messages as read.

Returns:
  number of messages marked read

_smsSend¶

smsSend(
 String destinationAddress: typically a phone number,
 String text)

Sends an SMS.

_{startActivity}¶

startActivity(
 String action,
 String uri[optional],
 String type[optional]: MIME type/subtype of the URI,
 JSONObject extras[optional]: a Map of extras to add to the Intent)

Starts an activity.

_{startActivityForResult}¶

startActivityForResult(
 String action,
 String uri[optional],
 String type[optional]: MIME type/subtype of the URI,
 JSONObject extras[optional]: a Map of extras to add to the Intent)

Starts an activity and returns the result.

Returns:
  A Map representation of the result Intent.

_{startInteractiveVideoRecording}¶

startInteractiveVideoRecording(
 String path)

Starts the video capture application to record a video and saves it to the      
specified path.

_{startLocating}¶

startLocating(
 Integer minDistance[optional, default 60000]: minimum time between updates in  
milliseconds,
 Integer minUpdateDistance[optional, default 30]: minimum distance between      
updates in meters)

Starts collecting location data.

_startSensing¶

startSensing(
 Integer sampleSize[optional, default 5]: number of samples for calculating    
average readings)

Starts recording sensor data to be available for polling.

_{startTrackingPhoneState}¶

startTrackingPhoneState()

Starts tracking phone state.

_{startTrackingSignalStrengths}¶

startTrackingSignalStrengths()

Starts tracking signal strengths.

Requires API Level 7.

_stopLocating¶

stopLocating()

Stops collecting location data.

_stopSensing¶

stopSensing()

Stops collecting sensor data.

_{stopTrackingPhoneState}¶

stopTrackingPhoneState()

Stops tracking phone state.

_{stopTrackingSignalStrengths}¶

stopTrackingSignalStrengths()

Stops tracking signal strength.

Requires API Level 7.

_{toggleAirplaneMode}¶

toggleAirplaneMode(
 Boolean enabled[optional])

Toggles airplane mode on and off.

Returns:
  True if airplane mode is enabled.

_{toggleBluetoothState}¶

toggleBluetoothState(
 Boolean enabled[optional],
 Boolean prompt[optional, default true]: Prompt the user to confirm changing    
the Bluetooth state.)

Toggle Bluetooth on and off.

Returns:
  True if Bluetooth is enabled.

Requires API Level 5.

_{toggleRingerSilentMode}¶

toggleRingerSilentMode(
 Boolean enabled[optional])

Toggles ringer silent mode on and off.

Returns:
  True if ringer silent mode is enabled.

_{toggleWifiState}¶

toggleWifiState(
 Boolean enabled[optional])

Toggle Wifi on and off.

Returns:
  True if Wifi is enabled.

_{ttsIsSpeaking}¶

ttsIsSpeaking()

Returns True if speech is currently in progress.

Requires API Level 4.

_ttsSpeak¶

ttsSpeak(
  String message)

Speaks the provided message via TTS.

Requires API Level 4.

_vibrate¶

vibrate(
 Integer duration[optional, default 300]: duration in milliseconds)

Vibrates the phone or a specified duration in milliseconds.

_view¶

view(
 String uri,
 String type[optional]: MIME type/subtype of the URI,
 JSONObject extras[optional]: a Map of extras to add to the Intent)

Start activity with view action by URI (i.e. browser, contacts, etc.).

_viewContacts¶

viewContacts()

Opens the list of contacts.

_viewHtml¶

viewHtml(
 String path: the path to the HTML file)

Opens the browser to display a local HTML file.

_viewMap¶

viewMap(
 String query, e.g. pizza, 123 My Street)

Opens a map search for query (e.g. pizza, 123 My Street).

_{wakeLockAcquireBright}¶

wakeLockAcquireBright()

Acquires a bright wake lock (CPU on, screen bright).

_{wakeLockAcquireDim}¶

wakeLockAcquireDim()

Acquires a dim wake lock (CPU on, screen dim).

_{wakeLockAcquireFull}¶

wakeLockAcquireFull()

Acquires a full wake lock (CPU on, screen bright, keyboard bright).

_{wakeLockAcquirePartial}¶

wakeLockAcquirePartial()

Acquires a partial wake lock (CPU on).

_{wakeLockRelease}¶

wakeLockRelease()

Releases the wake lock.

_{wifiGetScanResults}¶

wifiGetScanResults()

Returns the list of access points found during the most recent Wifi scan.

_{wifiStartScan}¶

wifiStartScan()

Starts a scan for Wifi access points.

Returns:
  True if the scan was initiated successfully.