Merge lp:~abreu-alexandre/unity-js-scopes/activate into lp:unity-js-scopes

[Alexandre Abreu]

Improve doc for ActivationQuery

Improve doc for ActivationQuery

Unmerged revisions

143. By Alexandre Abreu on 2016-08-19

Improve doc for ActivationQuery

=== modified file 'examples/simple/simple.js'
--- examples/simple/simple.js	2016-01-11 14:25:28 +0000
+++ examples/simple/simple.js	2016-08-19 17:32:13 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright 2015 Canonical Ltd.
+ * Copyright 2015-2016 Canonical Ltd.
  *
  * This file is part of unity-js-scopes.
  *
@@ -140,6 +140,7 @@
                         new scopes.lib.CategorisedResult(category);
                     categorised_result.set_uri("http://www.ubuntu.com");
                     categorised_result.set_title("'" + qs + "'");
+                    categorised_result.set_intercept_activation();
 
                     var filter_state =
                         new scopes.lib.FilterState();
@@ -162,6 +163,26 @@
                 function() {
                 });
         },
-        preview: function(result, action_metadata) {}
+        preview: function(result, action_metadata) {},
+        activate: function(result, metadata) {
+            return new scopes.lib.ActivationQuery(
+                result,
+                metadata,
+                "",
+                "",
+                // activate
+                function() {
+                    console.log('Activate called');
+
+                    var activation_response = new scopes.lib.ActivationResponse(
+                        scopes.defs.ActivationResponseStatus.NotHandled);
+
+                    return activation_response;
+                },
+                // cancelled
+                function() {
+                }
+            );
+        },
     }
 );
 
=== modified file 'src/bindings/src/activation-query.h'
--- src/bindings/src/activation-query.h	2016-02-13 16:01:06 +0000
+++ src/bindings/src/activation-query.h	2016-08-19 17:32:13 +0000
@@ -39,6 +39,25 @@
 
 --doc:prototype ActivationQuery
 
+--doc:constructor
+ * Constructs an ActivationQuery.
+ * 
+ * To create an ActivationQuery in response to an activate() callback
+ * called from scopes.self.initialize, pass down the result and metadata
+ * received in the activate() callback and empty strings for the other
+ * parameters.
+ * 
+ * To create an ActivationQuery in response to an perform_action() callback
+ * called from scopes.self.initialize, pass down the result, metadata, widget_id
+ * and action_id received in the perform_action() callback.
+ * 
+ * @constructor
+ * @param result Result for the associated result
+ * @param metadata ActionMetadata associated with the result
+ * @param widget_id The widget identifier receiver received by the activation callback (if any)
+ * @param action_id The action identifier receiver received by the activation callback (if any)
+--/doc:constructor
+
 --doc:member
  * Return response to the activation request
  * @method activate