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
b79c946c
Commit
b79c946c
authored
Sep 03, 2018
by
JC Brand
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Don't show old API in the table of contents
parent
f5d41db1
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
11 additions
and
6 deletions
+11
-6
docs/source/api/index.rst
docs/source/api/index.rst
+3
-3
docs/source/development.rst
docs/source/development.rst
+0
-1
docs/source/jsdoc_intro.md
docs/source/jsdoc_intro.md
+8
-2
No files found.
docs/source/api/index.rst
View file @
b79c946c
...
...
@@ -2,9 +2,9 @@
<div id="banner"><a href="https://github.com/jcbrand/converse.js/blob/master/docs/source/theming.rst">Edit me on GitHub</a></div>
=====================
====
The
new
API documentation
=====================
====
=====================
The API documentation
=====================
This document is a stub. It shouldn't show at all, instead it's a hack in order
to link to the JSDoc output.
...
...
docs/source/development.rst
View file @
b79c946c
...
...
@@ -23,7 +23,6 @@ or add new functionality to Converse.
style_guide
plugin_development
api/index
developer_api
events
other_frameworks
builds
docs/source/jsdoc_intro.md
View file @
b79c946c
# 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
Converse has a public API and a private API.
r
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
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
available to all JavaScript running in the page.
The private API is only accessible to plugins, which have been whitelisted and
T
e
he private API is only accessible to plugins, which have been whitelisted and
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
)
section for more info on writing plugins.
...
...
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