Recent changes to ADIC_API

WikiPage ADIC_API modified by Kevin Cox

Kevin Cox — Mon, 30 Jul 2012 23:45:42 -0000

--- v8
+++ v9
@@ -3,7 +3,7 @@
 ADIC has an API that is available to all addons.  The API is in the file `chrome://adic/content/adic.jsm`.  Some functions use callbacks because the underlying API's use callbacks.
 
 ## ADIC.checkID(id, callback)
-`id` is the id of an extension and callback will be called with one argument.  The argument will be `0` if the addon doesn't exist, `1` if the addon exists but does not have an `adic.jsm` file or `2` if it does have an `adic.jsm`.
+`id` is the id of an extension and callback will be called with one argument.  The argument will be `ADIC.NO_ADDON` (which is equal to `0`) if the addon doesn't exist, `ADIC.ADDON_FOUND` if the addon exists but does not have an `adic.jsm` file or `ADIC.ADIC_ENABLED` if it does have an `adic.jsm`.
 
 ## ADIC.checkCode(code)
 **DEPRECIATED - this will be removed in the future.**

WikiPage ADIC_API modified by Kevin Cox

Kevin Cox — Mon, 30 Jul 2012 23:40:44 -0000

--- v7
+++ v8
@@ -6,6 +6,8 @@
 `id` is the id of an extension and callback will be called with one argument.  The argument will be `0` if the addon doesn't exist, `1` if the addon exists but does not have an `adic.jsm` file or `2` if it does have an `adic.jsm`.
 
 ## ADIC.checkCode(code)
+**DEPRECIATED - this will be removed in the future.**
+
 Returns true if `"extensions."+code+"."` has preferences under it.
 
 ## ADIC.gatherInfo(id, callback, extra)

WikiPage ADIC_API modified by Kevin Cox

Kevin Cox — Mon, 30 Jul 2012 23:37:19 -0000

--- v6
+++ v7
@@ -8,12 +8,12 @@
 ## ADIC.checkCode(code)
 Returns true if `"extensions."+code+"."` has preferences under it.
 
-## ADIC.gatherInfo(id, code, callback, extra)
+## ADIC.gatherInfo(id, callback, extra)
 Calls callback with a string argument, and an object.  The  first argument is the resulting info, the second argument is extra data.  The following values are present in the data object.
 
  - `warnFiles` is an array of strings that are odd files that the extension has requested.
 
-`id` and `code` are the extension id and preference prefix code respectively.  If the extension given by `id` has an `adic.jsm` file `code` is ignored.
+`id` is  extension id as a string.
 
 `extra` is an optional object.  The following values are used (if present).

WikiPage ADIC_API modified by Kevin Cox

Kevin Cox — Mon, 09 Jul 2012 00:03:18 -0000

--- v5
+++ v6
@@ -9,7 +9,9 @@
 Returns true if `"extensions."+code+"."` has preferences under it.
 
 ## ADIC.gatherInfo(id, code, callback, extra)
-Calls callback with a string argument, and an array of strings.  The  first argument is the resulting info, the second argument is a list of dangerous files that are included in the output.
+Calls callback with a string argument, and an object.  The  first argument is the resulting info, the second argument is extra data.  The following values are present in the data object.
+
+ - `warnFiles` is an array of strings that are odd files that the extension has requested.
 
 `id` and `code` are the extension id and preference prefix code respectively.  If the extension given by `id` has an `adic.jsm` file `code` is ignored.

WikiPage ADIC_API modified by Kevin Cox

Kevin Cox — Sun, 08 Jul 2012 02:37:55 -0000

--- v4
+++ v5
@@ -3,7 +3,7 @@
 ADIC has an API that is available to all addons.  The API is in the file `chrome://adic/content/adic.jsm`.  Some functions use callbacks because the underlying API's use callbacks.
 
 ## ADIC.checkID(id, callback)
-`id` is the id of an extension and callback will be called with one argument.  The argument will be `0` if the addon doesn't exist, `1` if the addon exists but does not have an `adic.json` file or `2` if it does have an `adic.json`.
+`id` is the id of an extension and callback will be called with one argument.  The argument will be `0` if the addon doesn't exist, `1` if the addon exists but does not have an `adic.jsm` file or `2` if it does have an `adic.jsm`.
 
 ## ADIC.checkCode(code)
 Returns true if `"extensions."+code+"."` has preferences under it.
@@ -11,9 +11,9 @@
 ## ADIC.gatherInfo(id, code, callback, extra)
 Calls callback with a string argument, and an array of strings.  The  first argument is the resulting info, the second argument is a list of dangerous files that are included in the output.
 
-`id` and `code` are the extension id and preference prefix code respectively.  If the extension given by `id` has an `adic.json` file `code` is ignored.
+`id` and `code` are the extension id and preference prefix code respectively.  If the extension given by `id` has an `adic.jsm` file `code` is ignored.
 
 `extra` is an optional object.  The following values are used (if present).
 
- - `overide` is an object exactly equivalent to the one from [adic.json](ADIC_json) where any defined values will be used instead of the ones in `adic.json`.
- - `merge` is an object that has the list or object values in [adic.json](ADIC_json) where any defined values will be appended to the ones in `adic.json`.
+ - `overide` is an object exactly equivalent to the one from [adic.jsm](ADIC_jsm) where any defined values will be used instead of the ones in `adic.jsm`.
+ - `merge` is an object that has the list or object values in [adic.jsm](ADIC_jsm) where any defined values will be appended to the ones in `adic.jsm`.

WikiPage ADIC_API modified by Kevin Cox

Kevin Cox — Sun, 08 Jul 2012 02:36:52 -0000

--- v3
+++ v4
@@ -3,13 +3,13 @@
 ADIC has an API that is available to all addons.  The API is in the file `chrome://adic/content/adic.jsm`.  Some functions use callbacks because the underlying API's use callbacks.
 
 ## ADIC.checkID(id, callback)
-`id` is the id of an extension and callback will be called with one argument.  The argument will be `0` if the addon doesn't exist, `1` if the addon exists but does not have an `adic.json` file or `2` if it does have and `adic.json`.
+`id` is the id of an extension and callback will be called with one argument.  The argument will be `0` if the addon doesn't exist, `1` if the addon exists but does not have an `adic.json` file or `2` if it does have an `adic.json`.
 
 ## ADIC.checkCode(code)
 Returns true if `"extensions."+code+"."` has preferences under it.
 
 ## ADIC.gatherInfo(id, code, callback, extra)
-Calls callback with a single string argument.  This argument is the resulting info.
+Calls callback with a string argument, and an array of strings.  The  first argument is the resulting info, the second argument is a list of dangerous files that are included in the output.
 
 `id` and `code` are the extension id and preference prefix code respectively.  If the extension given by `id` has an `adic.json` file `code` is ignored.

WikiPage ADIC_API modified by Kevin Cox

Kevin Cox — Fri, 13 Jan 2012 23:37:03 -0000

--- v2 
+++ v3 
@@ -16,4 +16,4 @@
 `extra` is an optional object.  The following values are used (if present).
 
  - `overide` is an object exactly equivalent to the one from [adic.json](ADIC_json) where any defined values will be used instead of the ones in `adic.json`.
- - `merge` is an object that has the list values in [adic.json](ADIC_json) where any defined values will be appended to the ones in `adic.json`.
+ - `merge` is an object that has the list or object values in [adic.json](ADIC_json) where any defined values will be appended to the ones in `adic.json`.

WikiPage ADIC_API modified by Kevin Cox

Kevin Cox — Fri, 13 Jan 2012 23:35:36 -0000

--- v1 
+++ v2 
@@ -15,5 +15,5 @@
 
 `extra` is an optional object.  The following values are used (if present).
 
- - `overide` is an object exactly equivalent to the one from [adic.json](ADIC_JSON) where any defined values will be used instead of the ones in `adic.json`.
- - `merge` is an object that has the list values in [adic.json](ADIC_JSON) where any defined values will be appended to the ones in `adic.json`.
+ - `overide` is an object exactly equivalent to the one from [adic.json](ADIC_json) where any defined values will be used instead of the ones in `adic.json`.
+ - `merge` is an object that has the list values in [adic.json](ADIC_json) where any defined values will be appended to the ones in `adic.json`.

WikiPage ADIC_API modified by Kevin Cox

Kevin Cox — Fri, 13 Jan 2012 23:34:28 -0000

# ADIC API ADIC has an API that is available to all addons. The API is in the file `chrome://adic/content/adic.jsm`. Some functions use callbacks because the underlying API's use callbacks. ## ADIC.checkID(id, callback) `id` is the id of an extension and callback will be called with one argument. The argument will be `0` if the addon doesn't exist, `1` if the addon exists but does not have an `adic.json` file or `2` if it does have and `adic.json`. ## ADIC.checkCode(code) Returns true if `"extensions."+code+"."` has preferences under it. ## ADIC.gatherInfo(id, code, callback, extra) Calls callback with a single string argument. This argument is the resulting info. `id` and `code` are the extension id and preference prefix code respectively. If the extension given by `id` has an `adic.json` file `code` is ignored. `extra` is an optional object. The following values are used (if present). - `overide` is an object exactly equivalent to the one from [adic.json](ADIC_JSON) where any defined values will be used instead of the ones in `adic.json`. - `merge` is an object that has the list values in [adic.json](ADIC_JSON) where any defined values will be appended to the ones in `adic.json`.