[TIMOB-24510] Android: Support for custom quick settings tiles. #9310

ypbnv · 2017-08-14T11:14:07Z

JIRA: https://jira.appcelerator.org/browse/TIMOB-24510

Description:
Add support for custom quick settings tiles in Android N and above:
https://developer.android.com/about/versions/nougat/android-7.0.html#tile_api

Due to that being handled by a service, usage is very similar to JS file services. A file needs to be created in proper folder for Classic/Alloy projects and added in the element of tiapp.xml. For every tile you want to have you must create a new service. This service is of special type - 'quicksettings' providing two new attributes:

tiapp.xml:
<service url="quicksettingstileservice.js" label='Label' icon='logo.png' type="quicksettings"/>

Label and icon for the tile. By default they are using the application name and icon.

quicksettingstileservice.js

// Grab a reference to the service and it's intent
var service = Ti.Android.currentService;
service.addEventListener('tileadded', function () {
	Ti.API.info('On Tile Added!');
});
service.addEventListener('tileremoved', function () {
	Ti.API.info('On Tile Removed!');
});
service.addEventListener('startlistening', function () {
	Ti.API.info('Started Listening');
});
service.addEventListener('stoplistening', function () {
	Ti.API.info('Stopped listening');
});

// tile's event listeners
service.addEventListener('tiledialogoptionselected', function (e){Ti.API.info('Option selected:' + e.itemIndex)});
service.addEventListener('tiledialogcancelled', function (){Ti.API.info('Tile_DIALOG cancelled')});
service.addEventListener('tiledialogpositive', function (){Ti.API.info('Tile_DIALOG positive')});
service.addEventListener('tiledialogneutral', function (){Ti.API.info('Tile_DIALOG neutral')});
service.addEventListener('tiledialognegative', function (){Ti.API.info('Tile_DIALOG negative')});

service.addEventListener('click', function () {
	Ti.API.info('On tile clicked!');
        // device state listeners
	Ti.API.info('Is device locked - ' + service.isLocked());
	Ti.API.info('Is device secure - ' + service.isSecure());

        //tile state updating
	/*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();
	Ti.API.info(service.getState());
	Ti.API.info(service.getLabel());*/

        //alert dialog creating
	/*var opts = {
		message: 'Lorem ipsum',
		options: ['Confirm', 'Help', 'Cancel'],
		title: 'Delete File?',
		selectedIndex: 1,
		buttonNames: ['Yes', 'Cancel', 'No']
	};
	service.showDialog(opts);*/

        //launching an intent
	/*var intent = Ti.Android.createIntent({
    	action: Ti.Android.ACTION_GET_CONTENT,
    	type: "vnd.android.cursor.item/phone"
	});
	service.startActivityAndCollapse(intent);*/

        //unlock and run JS code
       /*service.unlockAndRun('Ti.API.info("JS run test")');*/
});

Documentation is on the way.

garymathews · 2017-08-14T13:52:34Z

...es/android/src/java/ti/modules/titanium/android/quicksettings/QuickSettingsServiceProxy.java

+			builder.setMessage(krollDict.getString(TiC.PROPERTY_MESSAGE));
+		}
+		if (krollDict.containsKey(TiC.PROPERTY_BUTTON_NAMES))
+		{


garymathews · 2017-08-14T13:53:47Z

...es/android/src/java/ti/modules/titanium/android/quicksettings/QuickSettingsServiceProxy.java

+					builder.setPositiveButton(text, new DialogInterface.OnClickListener() {
+						@Override
+						public void onClick(DialogInterface dialog, int which) {
+							fireEvent(TiC.EVENT_TILE_DIALOG_POSITIVE,null);


spacing of ,

same below

garymathews · 2017-08-14T13:56:49Z

android/cli/commands/_build.js

+			if (service.type == 'quicksettings') {
+				s = {};
+				var serviceName = this.appid + '.' + service.classname;
+				var icon = '@drawable/' + this.tiapp.icon.replace(/((\.9)?\.(png|jpg))$/, '');


var icon = '@drawable/' + (service.label || this.tiapp).icon.replace(/((\.9)?\.(png|jpg))$/, '');

garymathews · 2017-08-14T13:57:36Z

android/cli/commands/_build.js

 				}
-			});
+				var label = this.tiapp.name;


var label = service.label || this.tiapp.name;

garymathews

see above

Optimize default label and icon code in build script.

ypbnv · 2017-08-14T15:20:31Z

@garymathews Updated.

sgtcoolguy · 2017-08-23T15:59:47Z

android/cli/commands/_build.js

@@ -3381,6 +3385,28 @@ AndroidBuilder.prototype.generateTheme = function generateTheme(next) {
 	next();
 };

+function serviceParser(serviceNode, result) {


I don't like that you're passing in an object to modify as a side-effect of calling the method. I prefer to explicitly alter a copy of an object and return the modified copy as return value. Calling methods with the intention of causing side-effect modifications on the arguments is non-obvious.

sgtcoolguy · 2017-08-23T16:01:23Z

android/cli/commands/_build.js

+					label: label
+				});
+				const doc = new DOMParser().parseFromString(serviceXML, 'text/xml');
+				serviceParser(doc.firstChild, s);


How about serviceParser doesn't get passed in s, since it's an empty object, and instead just creates an empty object to start from and returns the built object, with we then assign to s here?
s = serviceParser(doc.firstChild);

It would mean that line 3629 would need to change to let s = {};.

Fix parameters.

Add returns.

Fix default icon code. Fix parity.html template.

ypbnv · 2017-09-13T10:10:34Z

@sgtcoolguy Updated the PR.

hansemannn · 2017-09-13T12:36:51Z

apidoc/Titanium/Android/QuickSettingsService.yml

+                service.setLabel('Active');
+                service.setIcon('active.png');
+              }
+            service.updateTile();


Indentation is messed here.

hansemannn · 2017-09-13T12:37:36Z

apidoc/Titanium/Android/QuickSettingsService.yml

+    summary: Prompts the user to unlock the device and runs the JS code
+    parameters:
+      - name: jsCode
+        summary: JavaScript code to be evaluated


Missing . at the end. Please also fix the other occurrences above.

hansemannn · 2017-09-13T12:37:57Z

apidoc/Titanium/Android/QuickSettingsService.yml

+      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.


Break the line after message/options. already.

hansemannn · 2017-09-13T12:40:20Z

apidoc/Titanium/Android/QuickSettingsService.yml

+  - name: tiledialogneutral
+    summary: Dispatched when the neutral (index 1) button has been clicked.
+
+  - name: tiledialognegative


While I do understand that we also used lowercase-only event naming-conventions, I'd like to discuss to move away from that. We should have camel-cased event-driven event-names, like tileRemoved and tileDialogOptionSelected. It would also look better on Alloy, e.g. on="tileRemoved". Any downsides?

If you are talking about using camel-cased event-names everywhere (not only for this service) we may have some trouble with deprecated event-names which are camel-cased. I had a case where the runtime does not behave consistently when two events with the same name (one lowercased, one camel-cased) are dispatched at the same time.

ypbnv · 2017-09-13T13:39:27Z

@hansemannn Updated docs formatting.

lokeshchdhry · 2017-11-09T02:51:08Z

FR Passed.

custom quick settings tiles works as expected. Properties, methods etc works successfully on android N & above.

Studio Ver: 4.10.0.201709271713
SDK Ver: 7.0.0 local build
OS Ver: 10.12.3
Xcode Ver: Xcode 8.3.3
Appc NPM: 4.2.10
Appc CLI: 6.3.0
Ti CLI Ver: 5.0.14
Alloy Ver: 1.10.7
Node Ver: 7.10.1
Java Ver: 1.8.0_101
Devices: ⇨ google Nexus 6P --- Android 8.0.0
⇨ google pixel --- Android 7.1.1

build · 2017-11-09T03:14:44Z

	Fails
🚫	🔬 There are library changes, but no changes to the unit tests. That's OK as long as you're refactoring existing code, but will require an admin to merge this PR. Please see README.md#unit-tests for docs on unit testing.

Generated by 🚫 dangerJS

lokeshchdhry · 2017-11-10T00:10:07Z

@ypbnv, If possible can you please add some unit tests. Jenkins is blocking merging because of it.

ypbnv · 2017-11-10T14:13:13Z

@lokeshchdhry No unit tests can be added for this feature.
@sgtcoolguy Could you merge it, please?

Support for QuickSettings tiles.

e32cffd

ypbnv added android feature needs docs 🚨 labels Aug 14, 2017

ypbnv added this to the 7.0.0 milestone Aug 14, 2017

ypbnv requested review from garymathews and cb1kenobi August 14, 2017 11:14

Add documentation.

63b6d44

ypbnv removed the needs docs 🚨 label Aug 14, 2017

garymathews reviewed Aug 14, 2017

View reviewed changes

garymathews suggested changes Aug 14, 2017

View reviewed changes

Formatting.

adc20e4

Optimize default label and icon code in build script.

Merge branch 'master' into TIMOB-24510

4458c41

sgtcoolguy reviewed Aug 23, 2017

View reviewed changes

ypbnv and others added 11 commits August 24, 2017 11:27

Merge branch 'master' into TIMOB-24510

841a992

Merge branch 'master' into TIMOB-24510

4e60faf

Fix indentation.

46dde07

Fix indentation again.

92d67a5

Add constants.

dab4c15

Fix parameters.

Add names.

cd739ef

Extract dictionary with dialog show params.

320e0f9

Add returns.

Fix return types.

e3a018a

More indentation.

ff8fd53

Last attempt.

bd004e2

Update QuickSettingsService.yml

471dd9d

ypbnv added 7 commits August 28, 2017 11:19

Merge branch 'master' into TIMOB-24510

c8674b8

Merge branch 'master' into TIMOB-24510

39da0e0

Merge branch 'master' into TIMOB-24510

cee7856

Merge branch 'master' into TIMOB-24510

fd4316d

Merge branch 'master' into TIMOB-24510

1d4ae40

Merge branch 'master' into TIMOB-24510

58b5c2b

Change serviceParser.

7047aba

Fix default icon code. Fix parity.html template.

hansemannn reviewed Sep 13, 2017

View reviewed changes

Docs formatting.

c665af6

ypbnv added the Android N label Sep 13, 2017

Merge branch 'master' into TIMOB-24510

20cf427

build added android docs labels Nov 9, 2017

Merge branch 'master' into TIMOB-24510

0cee779

build added android docs labels Nov 9, 2017

sgtcoolguy merged commit 50f7a4c into tidev:master Nov 10, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TIMOB-24510] Android: Support for custom quick settings tiles. #9310

[TIMOB-24510] Android: Support for custom quick settings tiles. #9310

ypbnv commented Aug 14, 2017 •

edited by garymathews

garymathews Aug 14, 2017

garymathews Aug 14, 2017 •

edited

garymathews Aug 14, 2017 •

edited

garymathews Aug 14, 2017 •

edited

garymathews left a comment

ypbnv commented Aug 14, 2017

sgtcoolguy Aug 23, 2017

sgtcoolguy Aug 23, 2017

ypbnv commented Sep 13, 2017

hansemannn Sep 13, 2017

hansemannn Sep 13, 2017

hansemannn Sep 13, 2017

hansemannn Sep 13, 2017

ypbnv Sep 13, 2017

ypbnv commented Sep 13, 2017

lokeshchdhry commented Nov 9, 2017

build commented Nov 9, 2017 •

edited

lokeshchdhry commented Nov 10, 2017

ypbnv commented Nov 10, 2017

[TIMOB-24510] Android: Support for custom quick settings tiles. #9310

[TIMOB-24510] Android: Support for custom quick settings tiles. #9310

Conversation

ypbnv commented Aug 14, 2017 • edited by garymathews

Choose a reason for hiding this comment

garymathews Aug 14, 2017 • edited

Choose a reason for hiding this comment

garymathews Aug 14, 2017 • edited

Choose a reason for hiding this comment

garymathews Aug 14, 2017 • edited

Choose a reason for hiding this comment

garymathews left a comment

Choose a reason for hiding this comment

ypbnv commented Aug 14, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ypbnv commented Sep 13, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ypbnv commented Sep 13, 2017

lokeshchdhry commented Nov 9, 2017

build commented Nov 9, 2017 • edited

lokeshchdhry commented Nov 10, 2017

ypbnv commented Nov 10, 2017

ypbnv commented Aug 14, 2017 •

edited by garymathews

garymathews Aug 14, 2017 •

edited

garymathews Aug 14, 2017 •

edited

garymathews Aug 14, 2017 •

edited

build commented Nov 9, 2017 •

edited