Other Components

BluetoothServer

Bluetooth server component

Properties

Available: boolean

Tell whether Bluetooth is available on the Android device.

CharacterEncoding: text

The character encoding to use when sending and receiving text.

DelimiterByte: number

The delimiter byte to use when passing a negative number for the numberOfBytes parameter when calling ReceiveText, ReceiveSignedBytes, or ReceiveUnsignedBytes.

Enabled: boolean

Tell whether Bluetooth is enabled.

HighByteFirst: boolean

Whether 2 and 4 byte numbers should be sent and received with the high (or most significant) byte first. Check the documentation for the device with which your app will be communicating for the appropriate setting. This is also known as big-endian.

IsAccepting: boolean

Tell whether this BluetoothServer component is accepting an incoming connection.

IsConnected: boolean

Tell whether a Bluetooth connection has been made.

Secure

Whether to invoke SSP (Simple Secure Pairing), which is supported on devices with Bluetooth v2.1 or higher. When working with embedded Bluetooth devices, this property may need to be set to False. For Android 2.0-2.2, this property setting will be ignored.

Events

ConnectionAccepted()

Indicates that a bluetooth connection has been accepted.

Methods

AcceptConnection(text serviceName)

Accept an incoming connection with the Serial Port Profile (SPP).

AcceptConnectionWithUUID(text serviceName, text uuid)

Accept an incoming connection with a specific UUID.

number BytesAvailableToReceive()

Returns an estimate of the number of bytes that can be received without blocking

Disconnect()

Disconnect from the connected Bluetooth device.

number ReceiveSigned1ByteNumber()

Receive a signed 1-byte number from the connected Bluetooth device.

number ReceiveSigned2ByteNumber()

Receive a signed 2-byte number from the connected Bluetooth device.

number ReceiveSigned4ByteNumber()

Receive a signed 4-byte number from the connected Bluetooth device.

list ReceiveSignedBytes(number numberOfBytes)

Receive multiple signed byte values from the connected Bluetooth device. If numberOfBytes is less than 0, read until a delimiter byte value is received.

text ReceiveText(number numberOfBytes)

Receive text from the connected Bluetooth device. If numberOfBytes is less than 0, read until a delimiter byte value is received.

number ReceiveUnsigned1ByteNumber()

Receive an unsigned 1-byte number from the connected Bluetooth device.

number ReceiveUnsigned2ByteNumber()

Receive an unsigned 2-byte number from the connected Bluetooth device.

number ReceiveUnsigned4ByteNumber()

Receive an unsigned 4-byte number from the connected Bluetooth device.

list ReceiveUnsignedBytes(number numberOfBytes)

Receive multiple unsigned byte values from the connected Bluetooth device. If numberOfBytes is less than 0, read until a delimiter byte value is received.

Send1ByteNumber(text number)

Send a 1-byte number to the connected Bluetooth device.

Send2ByteNumber(text number)

Send a 2-byte number to the connected Bluetooth device.

Send4ByteNumber(text number)

Send a 4-byte number to the connected Bluetooth device.

SendBytes(list list)

Send a list of byte values to the connected Bluetooth device.

SendText(text text)

Send text to the connected Bluetooth device.

StopAccepting()

Stop accepting an incoming connection.

Notifier

A notifier is a non-visible component that can show verious kinds of alerts and can log information. Use a notifier to display notices and alerts to users of your app, and also to log information that can help you debug your app.

Properties

none

Events

AfterChoosing(Text choice)

Signaled after the user has made a choice in response to ShowChooseDialog . The argument is the text on the button that the user tapped.

AfterTextInput(Text response)

Signaled after the user has responded to ShowTextDialog . The argument is the text on the button that the user entered.

Methods

ShowMessageDialog(Text message, Text title, Text buttonText)

Pops up a notice that remains until the user taps a button with the given text. The arguments are the message to be shown, the title of the notice, and the label on the button.

ShowChooseDialog(Text message, Text title, Text button1Text, Text button2Text, boolean cancelable)

Pops up a notice the user must respond to by tapping one of two buttons with the given text. The arguments are the message to be shown, the title of the notice, and the labels on the left and right buttons, respectively. The AfterChoosing event is signalled after the user taps one of the buttons.

ShowTextDialog(Text message, Text title, boolean cancelable)

Pops up a notice which the user must respond to by entering some text. The arguments are the message to be shown and the title of the notice. The AfterTextInput event is signalled after the user enters the text.

ShowAlert(Text message)

Pops up a temporary notice, which vanishes after a few seconds. The argument is the text of the notice.

LogError(Text message)

LogInfo(Text message)

LogWarning(Text message)

These methods are for use in debugging. They write messages to the various logs on the Android device. The logs can be read with the use of Android debugging tools, like the Android Debug Bridge (ADB).

SpeechRecognizer

Use a speech recognizer component to listen to the user speaking and convert the spoken sound into text using Android's speech recognition feature.

Properties

Result

The last text produced by the recognizer.

Events

AfterGettingText(text result)

Signaled after the recognizer has produced text. The argument is the text result that was produced.

BeforeGettingText()

Signaled just before the recognizer is called.

Methods

GetText()

Asks the user to speak, and converts the speech to text. Signals the AfterGettingText event when the result is available.

TextToSpeech

Use a text-to-speech component to have the device speak text audibly.

In order for this component to work, the device must have the TTS Extended Service app by Eyes-Free Project installed. You can download this from http://code.google.com/p/eyes-free/downloads/list

The text-to-speech component has properties you can set to guide the pronunciation of the text to be spoken. These properties use three-letter codes to specify the language and the country in which the language is spoken. For example, you can specify British English or US English. For British English, the language code is eng and the country code is GBR, while for US English, the language code is eng and the country code is USA. The complete list is below.

Properties

Country

The country code for speech production.

Language

The language code for speech production.

Result

Events

AfterSpeaking(Text result)

Signaled after the text is spoken. The argument is the text result that was produced.

BeforeSpeaking()

Signaled just before the text is spoken.

Methods

Speak(Text message)

Speaks the given text.

Here are the language and country codes you can use. The codes are organized first by language; then, in each language section are a list of possible country codes:

• ces (Czech)
  • CZE
• spa (Spanish)
  • ESP
  • USA
• deu (German)
  • AUT
  • BEL
  • CHE
  • DEU
  • LIE
  • LUX
• fra (French)
  • BEL
  • CAN
  • CHE
  • FRA
  • LUX
• nld (Dutch)
  • BEL
  • NLD
• ita (Italian)
  • CHE
  • ITA
• pol (Polish)
  • POL
• eng (English)
  • AUS
  • BEL
  • BWA
  • BLZ
  • CAN
  • GBR
  • HKG
  • IRL
  • IND
  • JAM
  • MHL
  • MLT
  • NAM
  • NZL
  • PHL
  • PAK
  • SGP
  • TTO
  • USA
  • VIR
  • ZAF
  • ZWE

Web

Non-visible component that provides functions for HTTP GET, POST, PUT, and DELETE requests.

Properties

AllowCookies

Whether the cookies from a response should be saved and used in subsequent requests. Cookies are only supported on Android version 2.3 or greater.

RequestHeaders

The request headers, as a list of two-element sublists. The first element of each sublist represents the request header field name. The second element of each sublist represents the request header field values, either a single value or a list containing multiple values.

ResponseFileName

The name of the file where the response should be saved. If SaveResponse is true and ResponseFileName is empty, then a new file name will be generated.

SaveResponse

Whether the response should be saved in a file.

Url

The URL for the web request.

Events

GotFile(text url, number responseCode, text responseType, text fileName)

Event indicating that a request has finished.

GotText(text url, number responseCode, text responseType, text responseContent)

Event indicating that a request has finished.

Methods

text BuildRequestData(list list)

Converts a list of two-element sublists, representing name and value pairs, to a string formatted as application/x-www-form-urlencoded media type, suitable to pass to PostText.

ClearCookies()

Clears all cookies for this Web component.

Delete()

Performs an HTTP DELETE request using the Url property and retrieves the response.
If the SaveResponse property is true, the response will be saved in a file and the GotFile event will be triggered. The ResponseFileName property can be used to specify the name of the file.
If the SaveResponse property is false, the GotText event will be triggered.

Get()

Performs an HTTP GET request using the Url property and retrieves the response. If the SaveResponse property is true, the response will be saved in a file and the GotFile event will be triggered. The ResponseFileName property can be used to specify the name of the file. If the SaveResponse property is false, the GotText event will be triggered.

text HtmlTextDecode(text htmlText)

Decodes the given HTML text value. HTML character entities such as &, <, >, ', and " are changed to &, <, >, ', and ". Entities such as &#xhhhh, and &#nnnn are changed to the appropriate characters.

text JsonTextDecode(text jsonText)

Decodes the given JSON text value. If the given JSON text is surrounded by quotes, the quotes will be removed.

PostFile(text path)

Performs an HTTP POST request using the Url property and data from the specified file. If the SaveResponse property is true, the response will be saved in a file and the GotFile event will be triggered. The ResponseFileName property can be used to specify the name of the file. If the SaveResponse property is false, the GotText event will be triggered.

PostText(text text)

Performs an HTTP POST request using the Url property and the specified text. The characters of the text are encoded using UTF-8 encoding. If the SaveResponse property is true, the response will be saved in a file and the GotFile event will be triggered. The responseFileName property can be used to specify the name of the file. If the SaveResponse property is false, the GotText event will be triggered.

PostTextWithEncoding(text text, text encoding)

Performs an HTTP POST request using the Url property and the specified text. The characters of the text are encoded using the given encoding. If the SaveResponse property is true, the response will be saved in a file and the GotFile event will be triggered. The ResponseFileName property can be used to specify the name of the file. If the SaveResponse property is false, the GotText event will be triggered.

PutFile(text path)

Performs an HTTP PUT request using the Url property and data from the specified file.
If the SaveResponse property is true, the response will be saved in a file and the GotFile event will be triggered. The ResponseFileName property can be used to specify the name of the file.
If the SaveResponse property is false, the GotText event will be triggered.

PutText(text text)

Performs an HTTP PUT request using the Url property and the specified text.
The characters of the text are encoded using UTF-8 encoding.
If the SaveResponse property is true, the response will be saved in a file and the GotFile event will be triggered. The responseFileName property can be used to specify the name of the file.
If the SaveResponse property is false, the GotText event will be triggered.

PutTextWithEncoding(text text, text encoding)

Performs an HTTP PUT request using the Url property and the specified text.
The characters of the text are encoded using the given encoding.
If the SaveResponse property is true, the response will be saved in a file and the GotFile event will be triggered. The ResponseFileName property can be used to specify the name of the file.
If the SaveResponse property is false, the GotText event will be triggered.

text UriEncode(text text)

Encodes the given text value so that it can be used in a URL.