JavaScript Services - Revision history

Reeder.29: /* Reserved errorCode Values */

2014-10-21T03:49:13Z

Reserved errorCode Values

Reeder.29: Added errorCodes returned by PalmBus itself.

2014-10-20T21:22:33Z

Added errorCodes returned by PalmBus itself.

Reeder.29: ref to LG docs

2014-10-14T18:28:22Z

ref to LG docs

Reeder.29: Service Initialization

2014-10-14T18:20:08Z

Service Initialization

Reeder.29 at 14:45, 13 October 2014

2014-10-13T14:45:40Z

Reeder.29 at 03:00, 13 October 2014

2014-10-13T03:00:09Z

Reeder.29: returning values

2014-10-12T03:21:16Z

returning values

Reeder.29: Initial creation

2014-10-11T20:18:37Z

Initial creation

New page

== Some notes to flesh out the [https://developer.palm.com/content/api/dev-guide/js-services/overview.html primary documentation] ==

=== Node versions
* webOS 2: node v0.2.3
* webOS 3.0: node v0.4.12
* webOS TV: ?
* LuneOS (webOS 3.5): node v0.10.?

@@ Line 27: / Line 27: @@
 * 504: command timeout
 * -9999: no errorCode returned by JS service
+* 400 (or -9999 under webOS 3.0.0 and earlier): ? parameters don't match schema
 == Service Initialization ==

@@ Line 13: / Line 13: @@
 To return a failure, set future.exception to an object (often some kind of Error). Best practice is to set both '''message''' and '''errorCode''' properties.
 (If you set the errorCode property of the object, that
 will be the errorCode returned over PalmBus, and the errorText will be copied from the message property.  Otherwise, errorCode will be -9999 and errorText will be "MojoService: no errorCode supplied "+(reply.errorText||""))
 While the Command Assistant run() method is called "inside" the future, it's not clear that you can compose the passed future with others.

← Older revision		Revision as of 18:28, 14 October 2014
Line 1:		Line 1:
−	'''Some notes to flesh out the [https://developer.palm.com/content/api/dev-guide/js-services/overview.html primary documentation]'''	+	'''Some notes to flesh out the [https://developer.palm.com/content/api/dev-guide/js-services/overview.html old primary documentation]''' and the [http://developer.lge.com/webOSTV/develop/js-services/ new primary documentation]

	== Node versions ==		== Node versions ==

← Older revision		Revision as of 18:20, 14 October 2014
Line 19:		Line 19:

	While the Command Assistant run() method is called "inside" the future, it's not clear that you can compose the passed future with others.		While the Command Assistant run() method is called "inside" the future, it's not clear that you can compose the passed future with others.
		+
		+
		+	== Service Initialization ==
		+	If you have common setup which must be done, regardless of which command is called first, define a [https://developer.palm.com/content/api/reference/config/services.json.html Service Assistant]
		+
		+	If you return a Future from the [https://developer.palm.com/content/api/dev-guide/js-services/services-faq.html#setup Service Assistant's setup method]
		+	your Command Assistant will not be called until that Future is resolved. If that Future fails, your Command Assistant will never be called, and the service call will eventually time out. So, ensure the Future always succeeds (storing an error if necessary):
		+
		+	<code><pre>
		+	MyServiceAssistant.prototype.setup = function () {
		+	return this.myAsyncMethod().then(function (f) {
		+	console.log("MyServiceAssistant.setup overall success", f.result);
		+	return f.result = f.result;
		+	}, function (f) {
		+	console.error("MyServiceAssistant.setup overall failure", f.exception);
		+	f.result = {foo: "bar"};
		+	});
		+	};
		+	</pre></code>

@@ Line 2: / Line 2: @@
 == Node versions ==
-* webOS 2: node v0.2.3
+* webOS 1.x: node not present
 * webOS 3.0: node v0.4.12
 * webOS TV: ?
-* LuneOS (webOS 3.5): node v0.10.?
+* LuneOS (webOS 3.5): node v0.10.25
@@ Line 11: / Line 12: @@
 To return a success, set future.result to an object with the desired properties (where future is the future passed to the Command Assistant).
-To return a failure, set future.exception to an object (typically some kind of Error).  If you set the errorCode property of the object, that
+To return a failure, set future.exception to an object (often some kind of Error). Best practice is to set both '''message''' and '''errorCode''' properties.
 will be the errorCode returned over PalmBus, and the errorText will be copied from the message property.  Otherwise, errorCode will be -9999 and errorText will be "MojoService: no errorCode supplied "+(reply.errorText||"")
 While the Command Assistant run() method is called "inside" the future, it's not clear that you can compose the passed future with others.

@@ Line 1: / Line 1: @@
-'''Some notes to flesh out the [https://developer.palm.com/content/api/dev-guide/js-services/overview.html primary documentation] =='''
+== Node versions ==
 * webOS 2: node v0.2.3
 * webOS 3.0: node v0.4.12
@@ Line 9: / Line 8: @@
-== Values returned over the PalmBus
+== Values returned over the PalmBus ==
 To return a success, set future.result to an object with the desired properties (where future is the future passed to the Command Assistant).