|
@@ -1,9 +1,15 @@
|
|
# The Converse API documentation
|
|
# The Converse API documentation
|
|
|
|
|
|
|
|
+Welcome to the new Converse API documentation, generated with
|
|
|
|
+[JSDoc](http://usejsdoc.org/).
|
|
|
|
+
|
|
|
|
+The old (increasingly out of date and incomplete) API documentation is
|
|
|
|
+currently still [available here](/docs/htmls/developer_api.html).
|
|
|
|
+
|
|
## The public and private API
|
|
## The public and private API
|
|
|
|
|
|
Converse has a public API and a private API.
|
|
Converse has a public API and a private API.
|
|
-
|
|
|
|
|
|
+r
|
|
The reason we make this distinction between public and private is so that API
|
|
The reason we make this distinction between public and private is so that API
|
|
methods which might can be used to "impersonate" the user, for example by
|
|
methods which might can be used to "impersonate" the user, for example by
|
|
sending messages on their behalf, are not available to random scripts running
|
|
sending messages on their behalf, are not available to random scripts running
|
|
@@ -12,7 +18,7 @@ in the websites.
|
|
The public API is accessible via the `window.converse` global and is therefore
|
|
The public API is accessible via the `window.converse` global and is therefore
|
|
available to all JavaScript running in the page.
|
|
available to all JavaScript running in the page.
|
|
|
|
|
|
-The private API is only accessible to plugins, which have been whitelisted and
|
|
|
|
|
|
+Tehe private API is only accessible to plugins, which have been whitelisted and
|
|
registered before `converse.initialize` (which is a public API method) has been
|
|
registered before `converse.initialize` (which is a public API method) has been
|
|
called. See the [plugin development](https://conversejs.org/docs/html/plugin_development.html)
|
|
called. See the [plugin development](https://conversejs.org/docs/html/plugin_development.html)
|
|
section for more info on writing plugins.
|
|
section for more info on writing plugins.
|