Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
converse.js
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
converse.js
Commits
a954ab91
Commit
a954ab91
authored
Jun 05, 2019
by
JC Brand
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Remove old API and events docs
parent
38a232fd
Changes
5
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
5 changed files
with
10 additions
and
1965 deletions
+10
-1965
docs/source/configuration.rst
docs/source/configuration.rst
+0
-4
docs/source/developer_api.rst
docs/source/developer_api.rst
+0
-1360
docs/source/events.rst
docs/source/events.rst
+0
-590
docs/source/jsdoc_intro.md
docs/source/jsdoc_intro.md
+0
-3
docs/source/plugin_development.rst
docs/source/plugin_development.rst
+10
-8
No files found.
docs/source/configuration.rst
View file @
a954ab91
...
...
@@ -18,10 +18,6 @@ an example of how this is done, please see the bottom of the *./index.html* page
Please refer to the `Configuration settings`_ section below for info on
all the available configuration settings.
After you have configured Converse, you'll have to regenerate the minified
JavaScript file so that it will include the new settings. Please refer to the
:ref:`minification` section for more info on how to do this.
.. _`configuration-settings`:
Configuration settings
...
...
docs/source/developer_api.rst
deleted
100644 → 0
View file @
38a232fd
This diff is collapsed.
Click to expand it.
docs/source/events.rst
deleted
100644 → 0
View file @
38a232fd
This diff is collapsed.
Click to expand it.
docs/source/jsdoc_intro.md
View file @
a954ab91
...
...
@@ -3,9 +3,6 @@
Welcome to the new Converse API documentation, generated with
[
JSDoc
](
http://usejsdoc.org/
)
.
This documentation replaces the (increasingly out of date and incomplete)
[
old API documentation
](
/docs/html/developer_api.html
)
and
[
old "Events and Promises" documentation
](
/docs/html/events.html
)
.
## The public and private API
Converse has a public API and a private API only available to plugins.
...
...
docs/source/plugin_development.rst
View file @
a954ab91
...
...
@@ -332,24 +332,26 @@ Converse comes with various :ref:`configuration-settings` that can be used to
modify its functionality and behavior.
All configuration settings have default values which can be overridden when
`converse.initialize` (see :ref:`initialize`) gets called.
`converse.initialize` (see `converse.initialize </docs/html/api/converse.html#.initialize>`_)
gets called.
Plugins often need their own additional configuration settings and you can add
these settings with the `_converse.api.settings.update
` method (see
:ref:`settings-update`)
.
these settings with the `_converse.api.settings.update
</docs/html/api/-_converse.api.settings.html#.update>`_
method
.
Exposing promises
-----------------
Converse has a `
`waitUntil`` API method (see :ref:`waituntil-grouping`)
Converse has a `
waitUntil </docs/html/api/-_converse.api.html#.waitUntil>`_ API method
which allows you to wait for various promises to resolve before executing a
piece of code.
You can add new promises for your plugin by calling
`
`_converse.api.promises.add`` (see :ref:`promises-grouping`)
.
`
_converse.api.promises.add </docs/html/api/-_converse.api.promises.html#.add>`_
.
Generally, your plugin will then also be responsible for making sure these
promises are resolved. You do this by calling ``_converse.api.emit``, which not
promises are resolved. You do this by calling
`_converse.api.trigger </docs/html/api/-_converse.api.html#.trigger>`_, which not
only resolves the plugin but will also emit an event with the same name.
Dealing with asynchronicity
...
...
@@ -429,8 +431,8 @@ Finding the right promises and/or events to listen to, can be a bit
challenging, and sometimes it might be necessary to create new events or
promises.
Please refer to the
:ref:`events-API` section of the documentation for an
overview of what's available to you. If you need new events or promises, then
Please refer to the
`API documentation </docs/html/api/http://localhost:8008/docs/html/api/>`_
for an
overview of what's available to you. If you need new events or promises, then
`please open an issue or make a pull request on Github <https://github.com/jcbrand/converse.js>`_
A full example plugin
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment