A JavaScript library for writing XMPP clients.
This library uses either Bidirectional-streams Over Synchronous HTTP (BOSH) to emulate a persistent, stateful, two-way connection to an XMPP server or alternatively WebSockets.
More information on BOSH can be found in XEP 124. For more information on XMPP-over WebSocket see this RFC: http://tools.ietf.org/html/rfc7395
| strophe.js | A JavaScript library for writing XMPP clients. |
| Functions | |
| Function. | Bind a function to an instance. |
| Array. | This is a polyfill for the ES5 Array.isArray method. |
| Array. | Return the index of an object in an array. |
| Array. | This function is not available in IE < 9 |
| $build | Create a Strophe.Builder. |
| $msg | Create a Strophe.Builder with a <message/> element as the root. |
| $iq | Create a Strophe.Builder with an <iq/> element as the root. |
| $pres | Create a Strophe.Builder with a <presence/> element as the root. |
| Strophe | An object container for all Strophe library functions. |
| Constants | |
| VERSION | |
| XMPP Namespace Constants | Common namespace constants from the XMPP RFCs and XEPs. |
| XHTML_IM Namespace | contains allowed tags, tag attributes, and css properties. |
| Functions | |
| XHTML. | Utility method to determine whether a tag is allowed in the XHTML_IM namespace. |
| XHTML. | Utility method to determine whether an attribute is allowed as recommended per XEP-0071 |
| Constants | |
| Connection Status Constants | Connection status constants for use by the connection handler callback. |
| Log Level Constants | Logging level indicators. |
| Functions | |
| addNamespace | This function is used to extend the current namespaces in Strophe.NS. |
| forEachChild | Map a function over some or all child elements of a given element. |
| isTagEqual | Compare an element’s tag name with a string. |
| xmlGenerator | Get the DOM document to generate elements. |
| xmlElement | Create an XML DOM element. |
| xmlescape | Excapes invalid xml characters. |
| xmlunescape | Unexcapes invalid xml characters. |
| xmlTextNode | Creates an XML DOM text node. |
| xmlHtmlNode | Creates an XML DOM html node. |
| getText | Get the concatenation of all text children of an element. |
| copyElement | Copy an XML DOM element. |
| createHtml | Copy an HTML DOM element into an XML DOM. |
| escapeNode | Escape the node part (also called local part) of a JID. |
| unescapeNode | Unescape a node part (also called local part) of a JID. |
| getNodeFromJid | Get the node portion of a JID String. |
| getDomainFromJid | Get the domain portion of a JID String. |
| getResourceFromJid | Get the resource portion of a JID String. |
| getBareJidFromJid | Get the bare JID from a JID String. |
| log | User overrideable logging function. |
| debug | Log a message at the Strophe.LogLevel.DEBUG level. |
| info | Log a message at the Strophe.LogLevel.INFO level. |
| warn | Log a message at the Strophe.LogLevel.WARN level. |
| error | Log a message at the Strophe.LogLevel.ERROR level. |
| fatal | Log a message at the Strophe.LogLevel.FATAL level. |
| serialize | Render a DOM element and all descendants to a String. |
| addConnectionPlugin | Extends the Strophe.Connection object with the given plugin. |
| Strophe. | XML DOM builder. |
| Functions | |
| Strophe. | Create a Strophe.Builder object. |
| tree | Return the DOM tree. |
| toString | Serialize the DOM tree to a String. |
| up | Make the current parent element the new current element. |
| root | Make the root element the new current element. |
| attrs | Add or modify attributes of the current element. |
| c | Add a child to the current element and make it the new current element. |
| cnode | Add a child to the current element and make it the new current element. |
| t | Add a child text element. |
| h | Replace current element contents with the HTML passed in. |
| Strophe. | XMPP Connection manager. |
| Functions | |
| Strophe. | Create and initialize a Strophe.Connection object. |
| reset | Reset the connection. |
| pause | Pause the request manager. |
| resume | Resume the request manager. |
| getUniqueId | Generate a unique ID for use in <iq/> elements. |
| addProtocolErrorHandler | Register a handler function for when a protocol (websocker or HTTP) error occurs. |
| connect | Starts the connection process. |
| Variables | |
| authzid | Authorization identity. |
| authcid | Authentication identity (User name). |
| pass | Authentication identity (User password). |
| servtype | Digest MD5 compatibility. |
| Functions | |
| attach | Attach to an already created and authenticated BOSH session. |
| restore | Attempt to restore a cached BOSH session. |
| xmlInput | User overrideable function that receives XML data coming into the connection. |
| xmlOutput | User overrideable function that receives XML data sent to the connection. |
| rawInput | User overrideable function that receives raw data coming into the connection. |
| rawOutput | User overrideable function that receives raw data sent to the connection. |
| nextValidRid | User overrideable function that receives the new valid rid. |
| send | Send a stanza. |
| flush | Immediately send any pending outgoing data. |
| sendPresence | Helper function to send presence stanzas. |
| sendIQ | Helper function to send IQ stanzas. |
| addTimedHandler | Add a timed handler to the connection. |
| deleteTimedHandler | Delete a timed handler for a connection. |
| addHandler | Add a stanza handler for the connection. |
| deleteHandler | Delete a stanza handler for a connection. |
| registerSASLMechanisms | Register the SASL mechanisms which will be supported by this instance of Strophe.Connection (i.e. |
| registerSASLMechanism | Register a single SASL mechanism, to be supported by this client. |
| disconnect | Start the graceful disconnection process. |
| sortMechanismsByPriority | Sorts an array of objects with prototype SASLMechanism according to their priorities. |
| authenticate | Set up authentication |
| Strophe. | encapsulates SASL authentication mechanisms. |
| Variables | |
| priority | Determines which SASLMechanism is chosen for authentication (Higher is better). |
| Functions | |
| test | Checks if mechanism able to run. |
| Constants | |
| SASL mechanisms | Available authentication mechanisms |
| Strophe.Bosh | Private helper class that handles BOSH Connections |
| Files | |
| bosh.js | A JavaScript library to enable BOSH in Strophejs. |
| Variables | |
| strip | BOSH-Connections will have all stanzas wrapped in a <body> tag when passed to Strophe.Connection.xmlInput or Strophe.Connection.xmlOutput. |
| Strophe. | Private helper class that handles WebSocket Connections |
| Files | |
| websocket.js | A JavaScript library to enable XMPP over Websocket in Strophejs. |
if ( !Function.prototype.bind )
Bind a function to an instance.
This Function object extension method creates a bound method similar to those in Python. This means that the ‘this’ object will point to the instance you want. See MDC’s bind() documentation and Bound Functions and Function Imports in JavaScript for a complete explanation.
This extension already exists in some browsers (namely, Firefox 3), but we provide it to support those that don’t.
| (Object) obj | The object that will become ‘this’ in the bound function. |
| (Object) argN | An option argument that will be prepended to the arguments given for the function call |
The bound function.
if ( !Array.prototype.indexOf )
Return the index of an object in an array.
This function is not supplied by some JavaScript implementations, so we provide it if it is missing. This code is from: http://developer.mozilla.org
| (Object) elt | The object to look for. |
| (Integer) from | The index from which to start looking. (optional). |
The index of elt in the array or -1 if not found.
An object container for all Strophe library functions.
This class is just a container for all the objects and constants used in the library. It is not meant to be instantiated, but to provide a namespace for library objects, constants, and functions.
| Constants | |
| VERSION | |
| XMPP Namespace Constants | Common namespace constants from the XMPP RFCs and XEPs. |
| XHTML_IM Namespace | contains allowed tags, tag attributes, and css properties. |
| Functions | |
| XHTML. | Utility method to determine whether a tag is allowed in the XHTML_IM namespace. |
| XHTML. | Utility method to determine whether an attribute is allowed as recommended per XEP-0071 |
| Constants | |
| Connection Status Constants | Connection status constants for use by the connection handler callback. |
| Log Level Constants | Logging level indicators. |
| Functions | |
| addNamespace | This function is used to extend the current namespaces in Strophe.NS. |
| forEachChild | Map a function over some or all child elements of a given element. |
| isTagEqual | Compare an element’s tag name with a string. |
| xmlGenerator | Get the DOM document to generate elements. |
| xmlElement | Create an XML DOM element. |
| xmlescape | Excapes invalid xml characters. |
| xmlunescape | Unexcapes invalid xml characters. |
| xmlTextNode | Creates an XML DOM text node. |
| xmlHtmlNode | Creates an XML DOM html node. |
| getText | Get the concatenation of all text children of an element. |
| copyElement | Copy an XML DOM element. |
| createHtml | Copy an HTML DOM element into an XML DOM. |
| escapeNode | Escape the node part (also called local part) of a JID. |
| unescapeNode | Unescape a node part (also called local part) of a JID. |
| getNodeFromJid | Get the node portion of a JID String. |
| getDomainFromJid | Get the domain portion of a JID String. |
| getResourceFromJid | Get the resource portion of a JID String. |
| getBareJidFromJid | Get the bare JID from a JID String. |
| log | User overrideable logging function. |
| debug | Log a message at the Strophe.LogLevel.DEBUG level. |
| info | Log a message at the Strophe.LogLevel.INFO level. |
| warn | Log a message at the Strophe.LogLevel.WARN level. |
| error | Log a message at the Strophe.LogLevel.ERROR level. |
| fatal | Log a message at the Strophe.LogLevel.FATAL level. |
| serialize | Render a DOM element and all descendants to a String. |
| addConnectionPlugin | Extends the Strophe.Connection object with the given plugin. |
Common namespace constants from the XMPP RFCs and XEPs.
contains allowed tags, tag attributes, and css properties. Used in the createHtml function to filter incoming html into the allowed XHTML-IM subset. See http://xmpp.org
Connection status constants for use by the connection handler callback.
addNamespace: function ( name, value )
This function is used to extend the current namespaces in Strophe.NS. It takes a key and a value with the key being the name of the new namespace, with its actual value. For example: Strophe.addNamespace(‘PUBSUB’, “http://jabber.org/protocol/pubsub”);
| (String) name | The name under which the namespace will be referenced under Strophe.NS |
| (String) value | The actual namespace. |
forEachChild: function ( elem, elemName, func )
Map a function over some or all child elements of a given element.
This is a small convenience function for mapping a function over some or all of the children of an element. If elemName is null, all children will be passed to the function, otherwise only children whose tag names match elemName will be passed.
| (XMLElement) elem | The element to operate on. |
| (String) elemName | The child element tag name filter. |
| (Function) func | The function to apply to each child. This function should take a single argument, a DOM element. |
xmlElement: function ( name )
Create an XML DOM element.
This function creates an XML DOM element correctly across all implementations. Note that these are not HTML DOM elements, which aren’t appropriate for XMPP stanzas.
| (String) name | The name for the element. |
| (Array|Object) attrs | An optional array or object containing key/value pairs to use as element attributes. The object should be in the format {‘key’: ‘value’} or {key: ‘value’}. The array should have the format [[‘key1’, ‘value1’], [‘key2’, ‘value2’]]. |
| (String) text | The text child data for the element. |
A new XML DOM element.
log: function ( level, msg )
User overrideable logging function.
This function is called whenever the Strophe library calls any of the logging functions. The default implementation of this function logs only fatal errors. If client code wishes to handle the logging messages, it should override this with
Strophe.log = function (level, msg) {
(user code here)
};Please note that data sent and received over the wire is logged via Strophe.Connection.rawInput() and Strophe.Connection.rawOutput().
The different levels and their meanings are
| DEBUG | Messages useful for debugging purposes. |
| INFO | Informational messages. This is mostly information like ‘disconnect was called’ or ‘SASL auth succeeded’. |
| WARN | Warnings about potential problems. This is mostly used to report transient connection errors like request timeouts. |
| ERROR | Some error occurred. |
| FATAL | A non-recoverable fatal error occurred. |
| (Integer) level | The log level of the log message. This will be one of the values in Strophe.LogLevel. |
| (String) msg | The log message. |
XML DOM builder.
This object provides an interface similar to JQuery but for building DOM elements easily and rapidly. All the functions except for toString() and tree() return the object, so calls can be chained. Here’s an example using the $iq() builder helper.
$iq({to: 'you', from: 'me', type: 'get', id: '1'})
.c('query', {xmlns: 'strophe:example'})
.c('example')
.toString()The above generates this XML fragment
<iq to='you' from='me' type='get' id='1'>
<query xmlns='strophe:example'>
<example/>
</query>
</iq>The corresponding DOM manipulations to get a similar fragment would be a lot more tedious and probably involve several helper variables.
Since adding children makes new operations operate on the child, up() is provided to traverse up the tree. To add two children, do
builder.c('child1', ...).up().c('child2', ...)The next operation on the Builder will be relative to the second child.
| Functions | |
| Strophe. | Create a Strophe.Builder object. |
| tree | Return the DOM tree. |
| toString | Serialize the DOM tree to a String. |
| up | Make the current parent element the new current element. |
| root | Make the root element the new current element. |
| attrs | Add or modify attributes of the current element. |
| c | Add a child to the current element and make it the new current element. |
| cnode | Add a child to the current element and make it the new current element. |
| t | Add a child text element. |
| h | Replace current element contents with the HTML passed in. |
Strophe.Builder = function ( name, attrs )
Create a Strophe.Builder object.
The attributes should be passed in object notation. For example
var b = new Builder('message', {to: 'you', from: 'me'});or
var b = new Builder('messsage', {'xml:lang': 'en'});| (String) name | The name of the root element. |
| (Object) attrs | The attributes for the root element in object notation. |
A new Strophe.Builder.
c: function ( name, attrs, text )
Add a child to the current element and make it the new current element.
This function moves the current element pointer to the child, unless text is provided. If you need to add another child, it is necessary to use up() to go back to the parent in the tree.
| (String) name | The name of the child. |
| (Object) attrs | The attributes of the child in object notation. |
| (String) text | The text to add to the child. |
The Strophe.Builder object.
cnode: function ( elem )
Add a child to the current element and make it the new current element.
This function is the same as c() except that instead of using a name and an attributes object to create the child it uses an existing DOM element object.
| (XMLElement) elem | A DOM element. |
The Strophe.Builder object.
XMPP Connection manager.
This class is the main part of Strophe. It manages a BOSH or websocket connection to an XMPP server and dispatches events to the user callbacks as data arrives. It supports SASL PLAIN, SASL DIGEST-MD5, SASL SCRAM-SHA1 and legacy authentication.
After creating a Strophe.Connection object, the user will typically call connect() with a user supplied callback to handle connection level events like authentication failure, disconnection, or connection complete.
The user will also have several event handlers defined by using addHandler() and addTimedHandler(). These will allow the user code to respond to interesting stanzas or do something periodically with the connection. These handlers will be active once authentication is finished.
To send data to the connection, use send().
| Functions | |
| Strophe. | Create and initialize a Strophe.Connection object. |
| reset | Reset the connection. |
| pause | Pause the request manager. |
| resume | Resume the request manager. |
| getUniqueId | Generate a unique ID for use in <iq/> elements. |
| addProtocolErrorHandler | Register a handler function for when a protocol (websocker or HTTP) error occurs. |
| connect | Starts the connection process. |
| Variables | |
| authzid | Authorization identity. |
| authcid | Authentication identity (User name). |
| pass | Authentication identity (User password). |
| servtype | Digest MD5 compatibility. |
| Functions | |
| attach | Attach to an already created and authenticated BOSH session. |
| restore | Attempt to restore a cached BOSH session. |
| xmlInput | User overrideable function that receives XML data coming into the connection. |
| xmlOutput | User overrideable function that receives XML data sent to the connection. |
| rawInput | User overrideable function that receives raw data coming into the connection. |
| rawOutput | User overrideable function that receives raw data sent to the connection. |
| nextValidRid | User overrideable function that receives the new valid rid. |
| send | Send a stanza. |
| flush | Immediately send any pending outgoing data. |
| sendPresence | Helper function to send presence stanzas. |
| sendIQ | Helper function to send IQ stanzas. |
| addTimedHandler | Add a timed handler to the connection. |
| deleteTimedHandler | Delete a timed handler for a connection. |
| addHandler | Add a stanza handler for the connection. |
| deleteHandler | Delete a stanza handler for a connection. |
| registerSASLMechanisms | Register the SASL mechanisms which will be supported by this instance of Strophe.Connection (i.e. |
| registerSASLMechanism | Register a single SASL mechanism, to be supported by this client. |
| disconnect | Start the graceful disconnection process. |
| sortMechanismsByPriority | Sorts an array of objects with prototype SASLMechanism according to their priorities. |
| authenticate | Set up authentication |
Strophe.Connection = function ( service, options )
Create and initialize a Strophe.Connection object.
The transport-protocol for this connection will be chosen automatically based on the given service parameter. URLs starting with “ws://” or “wss://” will use WebSockets, URLs starting with “http://”, “https://” or without a protocol will use BOSH.
To make Strophe connect to the current host you can leave out the protocol and host part and just pass the path, e.g.
var conn = new Strophe.Connection("/http-bind/");The cookies option allows you to pass in cookies to be added to the document. These cookies will then be included in the BOSH XMLHttpRequest or in the websocket connection.
The passed in value must be a map of cookie names and string values.
{ "myCookie": {
"value": "1234",
"domain": ".example.org",
"path": "/",
"expires": expirationDate
}
}Note that cookies can’t be set in this way for other domains (i.e. cross-domain). Those cookies need to be set under those domains, for example they can be set server-side by making a XHR call to that domain to ask it to set any necessary cookies.
The mechanisms option allows you to specify the SASL mechanisms that this instance of Strophe.Connection (and therefore your XMPP client) will support.
The value must be an array of objects with Strophe.SASLMechanism prototypes.
If nothing is specified, then the following mechanisms (and their priorities) are registered:
| SCRAM-SHA1 | 70 |
| DIGEST-MD5 | 60 |
| PLAIN | 50 |
| OAUTH-BEARER | 40 |
| OAUTH-2 | 30 |
| ANONYMOUS | 20 |
| EXTERNAL | 10 |
If you want to connect to the current host with a WebSocket connection you can tell Strophe to use WebSockets through a “protocol” attribute in the optional options parameter. Valid values are “ws” for WebSocket and “wss” for Secure WebSocket. So to connect to “wss://CURRENT_HOSTNAME/xmpp-websocket” you would call
var conn = new Strophe.Connection("/xmpp-websocket/", {protocol: "wss"});Note that relative URLs NOT starting with a “/” will also include the path of the current site.
Also because downgrading security is not permitted by browsers, when using relative URLs both BOSH and WebSocket connections will use their secure variants if the current connection to the site is also secure (https).
By adding “sync” to the options, you can control if requests will be made synchronously or not. The default behaviour is asynchronous. If you want to make requests synchronous, make “sync” evaluate to true.
var conn = new Strophe.Connection("/http-bind/", {sync: true});You can also toggle this on an already established connection.
conn.options.sync = true;
The customHeaders option can be used to provide custom HTTP headers to be included in the XMLHttpRequests made.
The keepalive option can be used to instruct Strophe to maintain the current BOSH session across interruptions such as webpage reloads.
It will do this by caching the sessions tokens in sessionStorage, and when “restore” is called it will check whether there are cached tokens with which it can resume an existing session.
The withCredentials option should receive a Boolean value and is used to indicate wether cookies should be included in ajax requests (by default they’re not). Set this value to true if you are connecting to a BOSH service and for some reason need to send cookies to it. In order for this to work cross-domain, the server must also enable credentials by setting the Access-Control-Allow-Credentials response header to “true”. For most usecases however this setting should be false (which is the default). Additionally, when using Access-Control-Allow-Credentials, the Access-Control-Allow-Origin header can’t be set to the wildcard “*”, but instead must be restricted to actual domains.
The contentType option can be set to change the default Content-Type of “text/xml; charset=utf-8”, which can be useful to reduce the amount of CORS preflight requests that are sent to the server.
| (String) service | The BOSH or WebSocket service URL. |
| (Object) options | A hash of configuration options |
A new Strophe.Connection object.
pause: function ()
Pause the request manager.
This will prevent Strophe from sending any more requests to the server. This is very useful for temporarily pausing BOSH-Connections while a lot of send() calls are happening quickly. This causes Strophe to send the data in a single request, saving many request trips.
getUniqueId: function( suffix )
Generate a unique ID for use in <iq/> elements.
All <iq/> stanzas are required to have unique id attributes. This function makes creating these easy. Each connection instance has a counter which starts from zero, and the value of this counter plus a colon followed by the suffix becomes the unique id. If no suffix is supplied, the counter is used as the unique id.
Suffixes are used to make debugging easier when reading the stream data, and their use is recommended. The counter resets to 0 for every new connection for the same reason. For connections to the same server that authenticate the same way, all the ids should be the same, which makes it easy to see changes. This is useful for automated testing as well.
| (String) suffix | A optional suffix to append to the id. |
A unique string to be used for the id attribute.
addProtocolErrorHandler: function( protocol, status_code, callback )
Register a handler function for when a protocol (websocker or HTTP) error occurs.
NOTE: Currently only HTTP errors for BOSH requests are handled. Patches that handle websocket errors would be very welcome.
| (String) protocol | ’HTTP’ or ‘websocket’ |
| (Integer) status_code | Error status code (e.g 500, 400 or 404) |
| (Function) callback | Function that will fire on Http error |
function onError(err_code){ //do stuff }
var conn = Strophe.connect(‘http://example.com/http-bind’); conn.addProtocolErrorHandler(‘HTTP’, 500, onError); // Triggers HTTP 500 error and onError handler will be called conn.connect(‘user_jid@incorrect_jabber_host’, ‘secret’, onConnect);
connect: function ( jid, pass, callback, wait, hold, route, authcid )
Starts the connection process.
As the connection process proceeds, the user supplied callback will be triggered multiple times with status updates. The callback should take two arguments - the status code and the error condition.
The status code will be one of the values in the Strophe.Status constants. The error condition will be one of the conditions defined in RFC 3920 or the condition ‘strophe-parsererror’.
The Parameters wait, hold and route are optional and only relevant for BOSH connections. Please see XEP 124 for a more detailed explanation of the optional parameters.
| (String) jid | The user’s JID. This may be a bare JID, or a full JID. If a node is not supplied, SASL OAUTHBEARER or SASL ANONYMOUS authentication will be attempted (OAUTHBEARER will process the provided password value as an access token). |
| (String) pass | The user’s password. |
| (Function) callback | The connect callback function. |
| (Integer) wait | The optional HTTPBIND wait value. This is the time the server will wait before returning an empty result for a request. The default setting of 60 seconds is recommended. |
| (Integer) hold | The optional HTTPBIND hold value. This is the number of connections the server will hold at one time. This should almost always be set to 1 (the default). |
| (String) route | The optional route value. |
| (String) authcid | The optional alternative authentication identity (username) if intending to impersonate another user. When using the SASL-EXTERNAL authentication mechanism, for example with client certificates, then the authcid value is used to determine whether an authorization JID (authzid) should be sent to the server. The authzid should not be sent to the server if the authzid and authcid are the same. So to prevent it from being sent (for example when the JID is already contained in the client certificate), set authcid to that same JID. See XEP-178 for more details. |
attach: function ( jid, sid, rid, callback, wait, hold, wind )
Attach to an already created and authenticated BOSH session.
This function is provided to allow Strophe to attach to BOSH sessions which have been created externally, perhaps by a Web application. This is often used to support auto-login type features without putting user credentials into the page.
| (String) jid | The full JID that is bound by the session. |
| (String) sid | The SID of the BOSH session. |
| (String) rid | The current RID of the BOSH session. This RID will be used by the next request. (Function) callback The connect callback function. |
| (Integer) wait | The optional HTTPBIND wait value. This is the time the server will wait before returning an empty result for a request. The default setting of 60 seconds is recommended. Other settings will require tweaks to the Strophe.TIMEOUT value. |
| (Integer) hold | The optional HTTPBIND hold value. This is the number of connections the server will hold at one time. This should almost always be set to 1 (the default). |
| (Integer) wind | The optional HTTBIND window value. This is the allowed range of request ids that are valid. The default is 5. |
restore: function ( jid, callback, wait, hold, wind )
Attempt to restore a cached BOSH session.
This function is only useful in conjunction with providing the “keepalive”:true option when instantiating a new Strophe.Connection.
When “keepalive” is set to true, Strophe will cache the BOSH tokens RID (Request ID) and SID (Session ID) and then when this function is called, it will attempt to restore the session from those cached tokens.
This function must therefore be called instead of connect or attach.
For an example on how to use it, please see examples/restore.js
| (String) jid | The user’s JID. This may be a bare JID or a full JID. |
| (Function) callback | The connect callback function. |
| (Integer) wait | The optional HTTPBIND wait value. This is the time the server will wait before returning an empty result for a request. The default setting of 60 seconds is recommended. |
| (Integer) hold | The optional HTTPBIND hold value. This is the number of connections the server will hold at one time. This should almost always be set to 1 (the default). |
| (Integer) wind | The optional HTTBIND window value. This is the allowed range of request ids that are valid. The default is 5. |
User overrideable function that receives XML data coming into the connection.
The default function does nothing. User code can override this with
Strophe.Connection.xmlInput = function (elem) {
(user code)
};Due to limitations of current Browsers’ XML-Parsers the opening and closing <stream> tag for WebSocket-Connoctions will be passed as selfclosing here.
BOSH-Connections will have all stanzas wrapped in a <body> tag. See Strophe.Bosh.strip if you want to strip this tag.
| (XMLElement) elem | The XML data received by the connection. |
User overrideable function that receives XML data sent to the connection.
The default function does nothing. User code can override this with
Strophe.Connection.xmlOutput = function (elem) {
(user code)
};Due to limitations of current Browsers’ XML-Parsers the opening and closing <stream> tag for WebSocket-Connoctions will be passed as selfclosing here.
BOSH-Connections will have all stanzas wrapped in a <body> tag. See Strophe.Bosh.strip if you want to strip this tag.
| (XMLElement) elem | The XMLdata sent by the connection. |
send: function ( elem )
Send a stanza.
This function is called to push data onto the send queue to go out over the wire. Whenever a request is sent to the BOSH server, all pending data is sent and the queue is flushed.
(XMLElement | [XMLElement] | Strophe.Builder) elem - The stanza to send.
sendPresence: function( elem, callback, errback, timeout )
Helper function to send presence stanzas. The main benefit is for sending presence stanzas for which you expect a responding presence stanza with the same id (for example when leaving a chat room).
| (XMLElement) elem | The stanza to send. |
| (Function) callback | The callback function for a successful request. |
| (Function) errback | The callback function for a failed or timed out request. On timeout, the stanza will be null. |
| (Integer) timeout | The time specified in milliseconds for a timeout to occur. |
The id used to send the presence.
sendIQ: function( elem, callback, errback, timeout )
Helper function to send IQ stanzas.
| (XMLElement) elem | The stanza to send. |
| (Function) callback | The callback function for a successful request. |
| (Function) errback | The callback function for a failed or timed out request. On timeout, the stanza will be null. |
| (Integer) timeout | The time specified in milliseconds for a timeout to occur. |
The id used to send the IQ.
addTimedHandler: function ( period, handler )
Add a timed handler to the connection.
This function adds a timed handler. The provided handler will be called every period milliseconds until it returns false, the connection is terminated, or the handler is removed. Handlers that wish to continue being invoked should return true.
Because of method binding it is necessary to save the result of this function if you wish to remove a handler with deleteTimedHandler().
Note that user handlers are not active until authentication is successful.
| (Integer) period | The period of the handler. |
| (Function) handler | The callback function. |
A reference to the handler that can be used to remove it.
deleteTimedHandler: function ( handRef )
Delete a timed handler for a connection.
This function removes a timed handler from the connection. The handRef parameter is not the function passed to addTimedHandler(), but is the reference returned from addTimedHandler().
| (Strophe.TimedHandler) handRef | The handler reference. |
addHandler: function ( handler, ns, name, type, id, from, options )
Add a stanza handler for the connection.
This function adds a stanza handler to the connection. The handler callback will be called for any stanza that matches the parameters. Note that if multiple parameters are supplied, they must all match for the handler to be invoked.
The handler will receive the stanza that triggered it as its argument. The handler should return true if it is to be invoked again; returning false will remove the handler after it returns.
As a convenience, the ns parameters applies to the top level element and also any of its immediate children. This is primarily to make matching /iq/query elements easy.
Options
With the options argument, you can specify boolean flags that affect how matches are being done.
connection.addHandler(
handler,
'http://jabber.org/protocol/muc',
null, null, null, null,
{'ignoreNamespaceFragment': true}
);Then a stanza with XML namespace of ‘http://jabber.org/protocol/muc#user’ will also be matched. If ‘ignoreNamespaceFragment’ is false, then only stanzas with ‘http://jabber.org/protocol/muc’ will be matched.
Deleting the handler
The return value should be saved if you wish to remove the handler with deleteHandler().
| (Function) handler | The user callback. |
| (String) ns | The namespace to match. |
| (String) name | The stanza name to match. |
| (String|Array) type | The stanza type (or types if an array) 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.
deleteHandler: function ( handRef )
Delete a stanza handler for a connection.
This function removes a stanza handler from the connection. The handRef parameter is not the function passed to addHandler(), but is the reference returned from addHandler().
| (Strophe.Handler) handRef | The handler reference. |
disconnect: function ( reason )
Start the graceful disconnection process.
This function starts the disconnection process. This process starts by sending unavailable presence and sending BOSH body of type terminate. A timeout handler makes sure that disconnection happens even if the BOSH server does not respond. If the Connection object isn’t connected, at least tries to abort all pending requests so the connection object won’t generate successful requests (which were already opened).
The user supplied connection callback will be notified of the progress as this process happens.
| (String) reason | The reason the disconnect is occuring. |
authenticate: function ( matched )
Set up authentication
Continues the initial connection request by setting up authentication handlers and starting the authentication process.
SASL authentication will be attempted if available, otherwise the code will fall back to legacy authentication.
| (Array) matched | Array of SASL mechanisms supported. |
encapsulates SASL authentication mechanisms.
User code may override the priority for each mechanism or disable it completely. See priority for information about changing priority and test for informatian on how to disable a mechanism.
By default, all mechanisms are enabled and the priorities are
| OAUTHBEARER | 60 |
| SCRAM-SHA1 | 50 |
| DIGEST-MD5 | 40 |
| PLAIN | 30 |
| ANONYMOUS | 20 |
| EXTERNAL | 10 |
See: Strophe.Connection.addSupportedSASLMechanisms
| Variables | |
| priority | Determines which SASLMechanism is chosen for authentication (Higher is better). |
| Functions | |
| test | Checks if mechanism able to run. |
| Constants | |
| SASL mechanisms | Available authentication mechanisms |
this.priority
Determines which SASLMechanism is chosen for authentication (Higher is better). Users may override this to prioritize mechanisms differently.
In the default configuration the priorities are
| SCRAM-SHA1 | 40 |
| DIGEST-MD5 | 30 |
| Plain | 20 |
Example: (This will cause Strophe to choose the mechanism that the server sent first)
Strophe.SASLMD5.priority = Strophe.SASLSHA1.priority;
See SASL mechanisms for a list of available mechanisms.
Checks if mechanism able to run. To disable a mechanism, make this return false;
To disable plain authentication run
Strophe.SASLPlain.test = function() {
return false;
}See SASL mechanisms for a list of available mechanisms.
| (Strophe.Connection) connection | Target Connection. |
(Boolean) If mechanism was able to run.
Available authentication mechanisms
Private helper class that handles BOSH Connections
The Strophe.Bosh class is used internally by Strophe.Connection to encapsulate BOSH sessions. It is not meant to be used from user’s code.
| Files | |
| bosh.js | A JavaScript library to enable BOSH in Strophejs. |
| Variables | |
| strip | BOSH-Connections will have all stanzas wrapped in a <body> tag when passed to Strophe.Connection.xmlInput or Strophe.Connection.xmlOutput. |
strip: null
BOSH-Connections will have all stanzas wrapped in a <body> tag when passed to Strophe.Connection.xmlInput or Strophe.Connection.xmlOutput. To strip this tag, User code can set Strophe.Bosh.strip to “body”:
Strophe.Bosh.prototype.strip = "body";
This will enable stripping of the body tag in both Strophe.Connection.xmlInput and Strophe.Connection.xmlOutput.
Private helper class that handles WebSocket Connections
The Strophe.WebSocket class is used internally by Strophe.Connection to encapsulate WebSocket sessions. It is not meant to be used from user’s code.
| Files | |
| websocket.js | A JavaScript library to enable XMPP over Websocket in Strophejs. |
A JavaScript library to enable XMPP over Websocket in Strophejs.
This file implements XMPP over WebSockets for Strophejs. If a Connection is established with a Websocket url (ws://...) Strophe will use WebSockets. For more information on XMPP-over-WebSocket see RFC 7395: http://tools.ietf.org/html/rfc7395
WebSocket support implemented by Andreas Guth (andreas.guth@rwth-aachen.de)
Bind a function to an instance.
if ( !Function.prototype.bind )
This is a polyfill for the ES5 Array.isArray method.
if ( !Array.isArray )
Return the index of an object in an array.
if ( !Array.prototype.indexOf )
This function is not available in IE < 9
if ( !Array.prototype.forEach )
Create a Strophe.Builder.
function $build( name, attrs )
Create a Strophe.Builder with a message/ element as the root.
function $msg( attrs )
Create a Strophe.Builder with an iq/ element as the root.
function $iq( attrs )
Create a Strophe.Builder with a presence/ element as the root.
function $pres( attrs )
This function is used to extend the current namespaces in Strophe.NS.
addNamespace: function ( name, value )
Map a function over some or all child elements of a given element.
forEachChild: function ( elem, elemName, func )
Compare an element’s tag name with a string.
isTagEqual: function ( el, name )
Get the DOM document to generate elements.
xmlGenerator: function ()
Create an XML DOM element.
xmlElement: function ( name )
Excapes invalid xml characters.
xmlescape: function( text )
Unexcapes invalid xml characters.
xmlunescape: function( text )
Creates an XML DOM text node.
xmlTextNode: function ( text )
Creates an XML DOM html node.
xmlHtmlNode: function ( html )
Get the concatenation of all text children of an element.
getText: function ( elem )
Copy an XML DOM element.
copyElement: function ( elem )
Copy an HTML DOM element into an XML DOM.
createHtml: function ( elem )
Escape the node part (also called local part) of a JID.
escapeNode: function ( node )
Unescape a node part (also called local part) of a JID.
unescapeNode: function ( node )
Get the node portion of a JID String.
getNodeFromJid: function ( jid )
Get the domain portion of a JID String.
getDomainFromJid: function ( jid )
Get the resource portion of a JID String.
getResourceFromJid: function ( jid )
Get the bare JID from a JID String.
getBareJidFromJid: function ( jid )
User overrideable logging function.
log: function ( level, msg )
Log a message at the Strophe.LogLevel.DEBUG level.
debug: function( msg )
Log a message at the Strophe.LogLevel.INFO level.
info: function ( msg )
Log a message at the Strophe.LogLevel.WARN level.
warn: function ( msg )
Log a message at the Strophe.LogLevel.ERROR level.
error: function ( msg )
Log a message at the Strophe.LogLevel.FATAL level.
fatal: function ( msg )
Render a DOM element and all descendants to a String.
serialize: function ( elem )
Extends the Strophe.Connection object with the given plugin.
addConnectionPlugin: function ( name, ptype )
Create a Strophe.Builder object.
Strophe.Builder = function ( name, attrs )
Return the DOM tree.
tree: function ()
Serialize the DOM tree to a String.
toString: function ()
Make the current parent element the new current element.
up: function ()
Make the root element the new current element.
root: function ()
Add or modify attributes of the current element.
attrs: function ( moreattrs )
Add a child to the current element and make it the new current element.
c: function ( name, attrs, text )
Add a child to the current element and make it the new current element.
cnode: function ( elem )
Add a child text element.
t: function ( text )
Replace current element contents with the HTML passed in.
h: function ( html )
Create and initialize a Strophe.Connection object.
Strophe.Connection = function ( service, options )
Reset the connection.
reset: function ()
Pause the request manager.
pause: function ()
Resume the request manager.
resume: function ()
Generate a unique ID for use in iq/ elements.
getUniqueId: function( suffix )
Register a handler function for when a protocol (websocker or HTTP) error occurs.
addProtocolErrorHandler: function( protocol, status_code, callback )
Starts the connection process.
connect: function ( jid, pass, callback, wait, hold, route, authcid )
Authorization identity.
this.authzid
Authentication identity (User name).
this.authcid
Authentication identity (User password).
this.pass
Digest MD5 compatibility.
this.servtype
Attach to an already created and authenticated BOSH session.
attach: function ( jid, sid, rid, callback, wait, hold, wind )
Attempt to restore a cached BOSH session.
restore: function ( jid, callback, wait, hold, wind )
Send a stanza.
send: function ( elem )
Immediately send any pending outgoing data.
flush: function ()
Helper function to send presence stanzas.
sendPresence: function( elem, callback, errback, timeout )
Helper function to send IQ stanzas.
sendIQ: function( elem, callback, errback, timeout )
Add a timed handler to the connection.
addTimedHandler: function ( period, handler )
Delete a timed handler for a connection.
deleteTimedHandler: function ( handRef )
Add a stanza handler for the connection.
addHandler: function ( handler, ns, name, type, id, from, options )
Delete a stanza handler for a connection.
deleteHandler: function ( handRef )
Register the SASL mechanisms which will be supported by this instance of Strophe.Connection (i.e.
registerSASLMechanisms: function ( mechanisms )
Register a single SASL mechanism, to be supported by this client.
registerSASLMechanism: function ( mechanism )
Start the graceful disconnection process.
disconnect: function ( reason )
Sorts an array of objects with prototype SASLMechanism according to their priorities.
sortMechanismsByPriority: function ( mechanisms )
Set up authentication
authenticate: function ( matched )
Determines which SASLMechanism is chosen for authentication (Higher is better).
this.priority
BOSH-Connections will have all stanzas wrapped in a body tag when passed to Strophe.Connection.xmlInput or Strophe.Connection.xmlOutput.
strip: null