Android service for creating custom quick settings tiles and handling user's interaction with them.
A special kind of service providing access to a tile in the quick settings menu. Used for customization and event handling of the tile. Usage is similar to default Titanium.Android.Service but with the addition of some specific attributes and methods. This service is not started from within the application with the help of an Intent, but instead whenever the custom tile is added in the quick settings menu by the user. Applications can have multiple tiles in the quick settigs menu, but a Titanium.Android.QuickSettingsService corresponds to a single one - you need separate service file for every tile.
To create a service file:
Register the service in your tiapp.xml file. Refer to the example below.
Icons used for the 'icon' attribute in the service declaration in tiapp.xml must
be in the Android drawables folder, so they you should be put under
platform/android/res/drawable
Icons added with the setIcon method can be outside the directory.
To get a reference to the Service inside the JavaScript service code, use the
Titanium.Android.currentService property to retrieve a reference to the service,
Further Reading:
This example shows how to create a service in JavaScript. It will update the Tile in quick settings according to the user's interaction.
File: updatequicksettings.js:
var service = Ti.Android.currentService;
service.addEventListener('click', function () {
if (service.getState() == Ti.Android.TILE_STATE_ACTIVE) {
service.setState(Ti.Android.TILE_STATE_INACTIVE);
service.setLabel('Inactive');
service.setIcon('inactive.png');
} else {
service.setState(Ti.Android.TILE_STATE_ACTIVE);
service.setLabel('Active');
service.setIcon('active.png');
}
service.updateTile();
}
Register the service in tiapp.xml:
<ti:app>
<android xmlns:android="http://schemas.android.com/apk/res/android">
<services>
<service url="updatequicksettings.js" type="quicksettings" label="Active" icon="active.png"/>
</services>
</android>
</ti:app>
The name of the API that this proxy corresponds to.
The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Button
returns Ti.UI.Button.
Indicates if the proxy will bubble an event to its parent.
Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.
Default: true
The intent used to start or bind to the Service.
The intent used to start or bind to the Service.
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.
A service can be started more than once -- this number (based on an incrementing integer) indicates which "start number" in the sequence the current service instance is.
Adds the specified callback as an event listener for the named event.
Name of the event.
Callback function to invoke when the event is fired.
Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.
A dictionary of properties to apply.
Fires a synthesized event to any registered listeners.
Name of the event.
A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.
Returns the Tile's current state.
This API can be assigned the following constants:
Returns 'true' if the device is in secure state, 'false' otherwise.
Removes the specified callback as an event listener for the named event.
Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.
When adding a listener, you must save a reference to the callback function in order to remove the listener later:
var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);
To remove the listener, pass in a reference to the callback function:
window.removeEventListener('click', listener);
Name of the event.
Callback function to remove. Must be the same function passed to addEventListener.
Sets the value of the bubbleParent property.
New value for the property.
Changes the Tile's icon.
If no image is passed as Tile icon it will use the Application's one.
Source of the icon image
Changes the Tile's label.
If no label is set the Tile uses the Application name.
String to be used.
Sets the value of the lifecycleContainer property.
New value for the property.
Sets the state of the Tile.
State can be one of the following: TILE_STATE_UNAVAILABLE, TILE_STATE_INACTIVE, TILE_STATE_ACTIVE
State to be set.
This API can be assigned the following constants:
Opens an Alert dialog.
Creates and shows a default Alert dialog with the provided options dictionary.
Note: Alert dialog only supports one of the following: message/options.
If you pass both - only message will be shown.
Dictionary containing the options for the dialog.
Starts the Service.
Effective only if this instance of Titanium.Android.Service was created with Titanium.Android.createService.
Colapses the quick settings menu and starts an activity for the passed Intent.
Intent to be fired.
Stops this running instance of the Service.
Prompts the user to unlock the device and runs the JS code.
JavaScript code to be evaluated.
Applies current tile's properties.
Updates the Tile's with it's current label, icon and state.
For Javascript-based services that you create, pause fires after each time the JavaScript
code executes.
The resume and pause events occur in pairs, with resume firing just before your
JavaScript service code executes, and pause just after.
Incrementing integer indicating which iteration of an interval-based Service is pausing. For example, if you have an interval-based Service running every 10 seconds, iteration 3 would occur at about 30 seconds after you start the instance (assuming your service code runs quickly).
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
For JavaScript-based Services which you create, resume fires each time the JavaScript
code executes.
For example, if your Service runs on an interval of 10000 (10 seconds), you would expect
to see resume fired every 10 seconds, just as the JavaScript service code you wrote is
about to execute.
Incrementing integer indicating which iteration of an interval-based Service is pausing. For example, if you have an interval-based Service running every 10 seconds, iteration 3 would occur at about 30 seconds after you start the instance (assuming your service code runs quickly).
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the bound service instance starts.
Bound service instances are created via Titanium.Android.createService.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Tile is listening for events.
Dispatched whenever the user has opened the quick setting menu and the Tile is added in there.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the bound service instance stops.
The service stops when stop or Titanium.Android.stopService is called and there are no more bound, un-stopped clients.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Tile has stopped listening for events.
Dispatched whenever the user has collapsed the quick setting menu and the Tile is not visible.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the task that comes from the service's application has been removed.
This event is fired if the service is currently running and the user has removed a task that comes from the service's application, eg. the user swipes the application away from the recent applications list. It only works for unbound service which is started using Titanium.Android.startService.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
The Tile has been added in the quick menu.
Dispatched wheneved the user has moved the Tile for this service in the quick settings menu.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Dispatched when the alert dialog has been cancelled.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Dispatched when the negative (index 2) button has been clicked.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Dispatched when the neutral (index 1) button has been clicked.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
An item from the signle choice menu has been selected.
Index of the selected item from the single choice menu in the dialog.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Dispatched when the positive (index 0) button has been clicked.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
The Tile has been removed from the quick menu.
Dispatched wheneved the user has removed the Tile for this service from the quick settings menu.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.