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
9d4d651d
Commit
9d4d651d
authored
Apr 25, 2013
by
JC Brand
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update docs regarding bosh_service_url setting
parent
93d31f26
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
23 additions
and
7 deletions
+23
-7
docs/NOTES.rst
docs/NOTES.rst
+23
-7
No files found.
docs/NOTES.rst
View file @
9d4d651d
...
...
@@ -9,14 +9,14 @@ Converse.js configuration variables:
Prebind
========
Use this option
if you don't want to render the login form on the chat control
box
.
Use this option
when you want to attach to an existing XMPP connection that was
already authenticated (usually on the backend before page load)
.
When set to true, the onConnected method needs to be called manually, together
with a Strophe connection object
.
This is useful when you don't want to render the login form on the chat control
box with each page load
.
The most likely usecase is if you want to already authenticate on the backend
and merely attach to that connection in the browser
.
When set to true, you'll need to make sure that the onConnected method is
called, and passed to it a Strophe connection object
.
Besides requiring the back-end to authenticate you, you'll also
have to write a Javascript snippet to attach to the set up connection::
...
...
@@ -24,16 +24,28 @@ have to write a Javascript snippet to attach to the set up connection::
$.JSON({
'url': 'mysite.com/xmpp-authenticate',
'success': function (data) {
connection = new Strophe.Connection(
data.BOSH_SERVICE_URL
);
connection = new Strophe.Connection(
bosh_service_url
);
connection.attach(data.jid, data.sid, data.rid, converse.onConnected);
}
The backend must authenticate for you, and then return a SID (session ID) and
RID (Request ID), which you use when you attach to the connection.
fullname
========
If you are using prebinding, you need to specify the fullname of the currently
logged in user.
bosh_service_url
================
Connections to an XMPP server depend on a BOSH connection manager which acts as
a middle man between HTTP and XMPP.
See `here`_ for more information.
xhr_user_search
===============
...
...
@@ -55,3 +67,7 @@ animate
=======
Show animations, for example when opening and closing chat boxes.
.. _`here`: http://metajack.im/2008/09/08/which-bosh-server-do-you-need/l
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