Merge pull request #281 from kuzzleio/fix-android-prototypes

Replace JSONArray with native Arrays for arguments and returned values

Author: benoitvidis

src/api-documentation/controller-memory-storage/hscan.md

@@ -4,7 +4,7 @@ algolia: true
 language-tab:
   js: HTTP
   json: Other protocols
-title: hmset
+title: hscan
 ---
 
 # hscan

src/api-documentation/controller-security/search-profiles.md

@@ -22,7 +22,7 @@ title: searchProfiles
 
 ```js
 {
-  // A roles array containing a list of role Ids can be added
+  // An array of roles used by the searched profiles
   "roles": [
     "firstRoleId",
     "admin"
@@ -41,7 +41,7 @@ title: searchProfiles
   "controller": "security",
   "action": "searchProfiles",
   "body": {
-    "policies": [
+    "roles": [
       "myRoleId",
       "admin"
     ]
@@ -108,7 +108,7 @@ Retrieves profiles referring to a given set of roles in their policies.
 
 Optional arguments:
 
-* `body.policies` contains an array of role identifiers used to filters the search results
+* `body.roles` contains an array of role identifiers used to filters the search results
 * `size` controls the maximum number of documents returned in the response
 * `from` is usually used with the `size` argument, and defines the offset from the first result you want to fetch
 * `scroll` allows to fetch large result sets, and it must be set with a [time duration](https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#time-units). If set, a forward-only cursor will be created (and automatically destroyed at the end of the set duration), and its identifier will be returned in the `scrollId` property, along with the first page of results. This cursor can then be moved forward using the [`scrollProfiles` API action]({{ site_base_path }}api-documentation/controller-security/scroll-profiles)

src/sdk-reference/kuzzle/get-all-statistics.md

@@ -31,7 +31,7 @@ kuzzle
 ```java
 kuzzle.getAllStatistics(new ResponseListener<JSONArray>() {
   @Override
-  public void onSuccess(JSONArray object) {
+  public void onSuccess(JSONObject[] frames) {
     // loop through all returned frames
   }
 

src/sdk-reference/kuzzle/get-my-rights.md

@@ -14,32 +14,30 @@ title: getMyRights
 // Using callbacks (NodeJS or Web Browser)
 kuzzle
   .security
-  .getMyRights(function(error, result) {
-    // result is a JSON object
+  .getMyRights(function(error, rights) {
+    // result is an array of objects
   });
 
 // Using promises (NodeJS)
 kuzzle
   .security
   .getMyRightsPromise()
-  .then((result) => {
-    // result is a JSON object
+  .then(rights => {
+    // result is an array of objects
   });
 ```
 
 ```java
 
 kuzzle
   .security
-  .getMyRights(new ResponseListener<JSONObject>() {
+  .getMyRights(new ResponseListener<JSONObject[]>() {
     @Override
-    public void onSuccess(JSONObject rights) {
-        // result is a JSON object
+    public void onSuccess(JSONObject[] rights) {
     }
 
     @Override
     public void onError(JSONObject error) {
-        // Handle error
     }
   });
 ```
@@ -49,22 +47,28 @@ kuzzle
 use \Kuzzle\Kuzzle;
 
 $kuzzle = new Kuzzle('localhost');
-$result = $kuzzle->security()->getMyRights();
+$rights = $kuzzle->security()->getMyRights();
 
-// $result is an array
+// $rights is an array of associative arrays
 ```
 
-> Callback response example:
+> Callback response
 
-```js
+```json
 [
   {
-    controller: 'my-controller', action: 'my-action', index: '*', collection: '*',
-    value: 'allowed'
+    "controller": "my-controller",
+    "action": "my-action",
+    "index": "*",
+    "collection": "*",
+    "value": "allowed"
   },
   {
-    controller: 'another-controller', action: '*', index: 'my-index', collection: '*',
-    value: 'conditional'
+    "controller": "another-controller",
+    "action": "*",
+    "index": "my-index",
+    "collection": "*",
+    "value": "conditional"
   }
 ]
 ```
@@ -92,4 +96,4 @@ Gets the rights of the current user
 
 ## Callback response
 
-Resolves to a `JSON` object.
+Resolves to an array of rights.

src/sdk-reference/kuzzle/get-statistics.md

@@ -14,22 +14,20 @@ title: getStatistics
 
 ```js
 // Using callbacks (NodeJS or Web Browser)
-kuzzle.getStatistics(function (err, stats) {
-  // ...
+kuzzle.getStatistics(function (err, statistics) {
 });
 
 // Using promises (NodeJS only)
 kuzzle
   .getStatisticsPromise()
-  .then(stats => {
-    // ...
+  .then(statistics => {
   });
 ```
 
 ```java
 kuzzle.getStatistics(new ResponseListener<JSONObject>() {
   @Override
-  public void onSuccess(JSONObject object) {
+  public void onSuccess(JSONObject[] statistics) {
     // ...
   }
 
@@ -45,19 +43,23 @@ kuzzle.getStatistics(new ResponseListener<JSONObject>() {
 use \Kuzzle\Kuzzle;
 
 $kuzzle = new Kuzzle('localhost');
-$result = $kuzzle->getStatistics();
+$statistics = $kuzzle->getStatistics();
 
-// $result is an array
+// $statistics is an array of statistics
 ```
 
 > Callback response:
 
 ```json
-[{ "connections": { "socketio": 1 },
+[
+  { 
+    "connections": { "socketio": 1 },
     "ongoingRequests": { "rest": 0, "socketio": 0 },
     "completedRequests": { "mqtt": 37, "socketio": 17 },
     "failedRequests": { "socketio": 1 },
-    "timestamp": "1453110641308" }]
+    "timestamp": "1453110641308" 
+  }
+]
 ```
 
 > When providing a timestamp, retrieves all frames recorded after that timestamp:
@@ -67,23 +69,23 @@ $result = $kuzzle->getStatistics();
 var ts = Date.parse('2015-10-26T12:19:10.213Z');
 
 // Using callbacks (NodeJS or Web Browser)
-kuzzle.getStatistics(ts, function (err, stats) {
-  // ...
+kuzzle.getStatistics(ts, function (error, statistics) {
+
 });
 
 // Using promises (NodeJS only)
 kuzzle
   .getStatisticsPromise(ts)
-  .then(stats => {
-    // ...
+  .then(statistics => {
+
   });
 ```
 
 ```java
 // Date can be either in ISO format or a timestamp (utc, in milliseconds)
-kuzzle.getStatistics("2015-11-15T13:36:45.558Z", new KuzzleResponseListener<JSONArray>() {
+kuzzle.getStatistics("2015-11-15T13:36:45.558Z", new ResponseListener<JSONObject[]>() {
   @Override
-  public void onSuccess(JSONArray results) {
+  public void onSuccess(JSONObject[] statistics) {
     // ...
   }
 
@@ -101,29 +103,37 @@ use \Kuzzle\Kuzzle;
 $kuzzle = new Kuzzle('localhost');
 // Date can be either in ISO format or a timestamp (utc, in milliseconds)
 $date = time() * 1000;
-$result = $kuzzle->getStatistics($date);
+$statistics = $kuzzle->getStatistics($date);
 
-// $result is an array
+// $statistics is an array of statistics objects
 ```
 
-> Callback response:
+> Callback response
 
 ```json
-[{ "connections": { "socketio": 1 },
+[
+  { 
+    "connections": { "socketio": 1 },
     "ongoingRequests": { "rest": 0, "socketio": 0 },
     "completedRequests": { "mqtt": 37, "socketio": 17 },
     "failedRequests": { "socketio": 1 },
-    "timestamp": "1453110641308" },
-  { "connections": { "socketio": 1 },
+    "timestamp": "1453110641308" 
+  },
+  { 
+    "connections": { "socketio": 1 },
     "ongoingRequests": { "rest": 0, "socketio": 0 },
     "completedRequests": { "socketio": 34 },
     "failedRequests": { "socketio": 3 },
-    "timestamp": "1453110642308" },
-  { "connections": {},
+    "timestamp": "1453110642308" 
+  },
+  { 
+    "connections": {},
     "ongoingRequests": { "rest": 0, "socketio": 0 },
     "completedRequests": { "socketio": 40 },
     "failedRequests": {},
-    "timestamp": "1453110643308" }]
+    "timestamp": "1453110643308" 
+  }
+]
 ```
 
 Kuzzle monitors active connections, and ongoing/completed/failed requests.  

src/sdk-reference/kuzzle/list-collections.md

@@ -25,9 +25,9 @@ kuzzle
 ```
 
 ```java
-kuzzle.listCollections("index", new ResponseListener<JSONObject>() {
+kuzzle.listCollections("index", new ResponseListener<JSONObject[]>() {
   @Override
-  public void onSuccess(JSONObject object) {
+  public void onSuccess(JSONObject[] collections) {
     // ...
   }
 
@@ -95,4 +95,4 @@ If no `index` argument is provided, the `defaultIndex` property is used. If no d
 
 ## Callback response
 
-Resolves to a `JSON object` containing the list of stored and/or realtime collections on the provided index.
+Resolves to an array of JSON objects containing the list of stored and/or realtime collections on the provided index.

src/sdk-reference/memory-storage/bitop.md

@@ -24,7 +24,8 @@ kuzzle.memoryStorage.bitopPromise('key', 'AND', ['srckey1', 'srckey2', '...'])
 ```
 
 ```java
-JSONArray sourceKeys = new JSONArray().put("srckey1").put("srckey2").put("...");
+String[] sourceKeys = {"srckey1", "srckey2", "..."};
+
 kuzzle.memoryStorage.bitop("key", "AND", sourceKeys, new ResponseListener<Long>() {
   @Override
   public void onSuccess(int length) {

src/sdk-reference/memory-storage/del.md

@@ -24,7 +24,8 @@ kuzzle.memoryStorage.delPromise(['key1', 'key2', '...'])
 ```
 
 ```java
-JSONArray keys = new JSONArray().put("key1").put("key2").put("...");
+String[] keys = {"key1", "key2", "..."};
+
 kuzzle.memoryStorage.del(keys, new ResponseListener<Long>() {
   @Override
   public void onSuccess(int count) {

src/sdk-reference/memory-storage/exists.md

@@ -24,7 +24,8 @@ kuzzle.memoryStorage.existsPromise(['key1', 'key2', '...'])
 ```
 
 ```java
-JSONArray keys = new JSONArray().put("key1").put("key2").put("...");
+String[] keys = {"key1", "key2", "..."};
+
 kuzzle.memoryStorage.exists(keys, new ResponseListener<Long>() {
   @Override
   public void onSuccess(int count) {

src/sdk-reference/memory-storage/geoadd.md

@@ -37,17 +37,16 @@ kuzzle.memoryStorage.geoaddPromise('key', points)
 ```
 
 ```java
-JSONArray points = new JSONArray()
-  .put(new JSONObject()
+JSONObject[] points = new JSONObject[]{
+  new JSONObject()
     .put("lon", 13.361389)
     .put("lat", 38.115556)
-    .put("name", "Palermo")
-  )
-  .put(new JSONObject()
+    .put("name", "Palermo"),
+  new JSONObject()
     .put("lon", 15.087269)
     .put("lat", 37.502669)
     .put("name", "Catania")
-  );
+};
 
 kuzzle.memoryStorage.geoadd("key", points, new ResponseListener<Long>() {
   @Override