| Candy | Chats are not dead yet. |
© 2011 Amiado Group AG. All rights reserved.
| core.js | |
| Candy.Core | Candy Chat Core |
| Variables | |
| autojoin | If set to `true` try to get the bookmarks and autojoin the rooms (supported by Openfire). |
| Functions | |
| init | Initialize Core. |
| connect | Connect to the jabber host. |
| attach | Attach an already binded & connected session to the server |
| disconnect | Leave all rooms and disconnect |
| addHandler | Wrapper for Strophe.Connection.addHandler() to add a stanza handler for the connection. |
| getUser | Gets current user |
| setUser | Set current user. |
| getConnection | Gets Strophe connection |
| getRooms | Gets all joined rooms |
| isAnonymousConnection | Returns true if Candy.Core.connect was first called with a domain instead of a jid as the first param. |
| getOptions | Gets options |
| getRoom | Gets a specific room |
| onWindowUnload | window.onbeforeunload event which disconnects the client from the Jabber server. |
| rawInput | (Overridden from Strophe.Connection.rawInput) |
| log | Overridden to do something useful if debug is set to true. |
Candy Chat Core
| (Candy.Core) self | itself |
| (Strophe) Strophe | Strophe JS |
| (jQuery) $ | jQuery |
| Variables | |
| autojoin | If set to `true` try to get the bookmarks and autojoin the rooms (supported by Openfire). |
| Functions | |
| init | Initialize Core. |
| connect | Connect to the jabber host. |
| attach | Attach an already binded & connected session to the server |
| disconnect | Leave all rooms and disconnect |
| addHandler | Wrapper for Strophe.Connection.addHandler() to add a stanza handler for the connection. |
| getUser | Gets current user |
| setUser | Set current user. |
| getConnection | Gets Strophe connection |
| getRooms | Gets all joined rooms |
| isAnonymousConnection | Returns true if Candy.Core.connect was first called with a domain instead of a jid as the first param. |
| getOptions | Gets options |
| getRoom | Gets a specific room |
| onWindowUnload | window.onbeforeunload event which disconnects the client from the Jabber server. |
| rawInput | (Overridden from Strophe.Connection.rawInput) |
| log | Overridden to do something useful if debug is set to true. |
autojoin: true
If set to `true` try to get the bookmarks and autojoin the rooms (supported by Openfire). You may want to define an array of rooms to autojoin: `[‘room1@conference.host.tld’, ‘room2...]` (ejabberd, Openfire, ...)
self.connect = function( jidOrHost, password, nick )
Connect to the jabber host.
| connect(‘JID’, ‘password’) | Connect a registered user |
| connect(‘domain’) | Connect anonymously to the domain. The user should receive a random JID. |
| connect(‘domain’, null, ‘nick’) | Connect anonymously to the domain. The user should receive a random JID but with a nick set. |
| connect(‘JID’) | Show login form and prompt for password. JID input is hidden. |
| connect() | Show login form and prompt for JID and password. |
Candy.Core.attach() for attaching an already established session.
| (String) jidOrHost | JID or Host |
| (String) password | Password of the user |
| (String) nick | Nick of the user. Set one if you want to anonymously connect but preset a nick. If jidOrHost is a domain and this param is not set, Candy will prompt for a nick. |
self.addHandler = function( handler, ns, name, type, id, from, options )
Wrapper for Strophe.Connection.addHandler() to add a stanza handler for the connection.
| (Function) handler | The user callback. |
| (String) ns | The namespace to match. |
| (String) name | The stanza name to match. |
| (String) type | The stanza type attribute to match. |
| (String) id | The stanza id attribute to match. |
| (String) from | The stanza from attribute to match. |
| (String) options | The handler options |
A reference to the handler that can be used to remove it.
self.isAnonymousConnection = function()
Returns true if Candy.Core.connect was first called with a domain instead of a jid as the first param.
(Boolean)
If set to `true` try to get the bookmarks and autojoin the rooms (supported by Openfire).
autojoin: true
Initialize Core.
self.init = function( service, options )
Connect to the jabber host.
self.connect = function( jidOrHost, password, nick )
Attach an already binded & connected session to the server
self.attach = function( jid, sid, rid )
Leave all rooms and disconnect
self.disconnect = function()
Wrapper for Strophe.Connection.addHandler() to add a stanza handler for the connection.
self.addHandler = function( handler, ns, name, type, id, from, options )
Gets current user
self.getUser = function()
Set current user.
self.setUser = function( user )
Gets Strophe connection
self.getConnection = function()
Gets all joined rooms
self.getRooms = function()
Returns true if Candy.Core.connect was first called with a domain instead of a jid as the first param.
self.isAnonymousConnection = function()
Gets options
self.getOptions = function()
Gets a specific room
self.getRoom = function( roomJid )
window.onbeforeunload event which disconnects the client from the Jabber server.
self.onWindowUnload = function()
(Overridden from Strophe.Connection.rawInput)
self.rawInput = function( data )
Overridden to do something useful if debug is set to true.
self.log = function()