XMPP Class

Properties   Methods   Events   Configuration Settings   Errors  

The XMPP Component is used to create a lightweight messaging client using the XMPP (Jabber) protocol.

Class Name

IPWorks_XMPP

Procedural Interface

 ipworks_xmpp_open();
 ipworks_xmpp_close($res);
 ipworks_xmpp_register_callback($res, $id, $function);
 ipworks_xmpp_get_last_error($res);
 ipworks_xmpp_get_last_error_code($res);
 ipworks_xmpp_set($res, $id, $index, $value);
 ipworks_xmpp_get($res, $id, $index);
 ipworks_xmpp_do_add($res, $jabberid, $name, $groups);
 ipworks_xmpp_do_cancel($res, $jabberid);
 ipworks_xmpp_do_changepassword($res, $password);
 ipworks_xmpp_do_changepresence($res, $presencecode, $status);
 ipworks_xmpp_do_config($res, $configurationstring);
 ipworks_xmpp_do_connect($res, $user, $password);
 ipworks_xmpp_do_disconnect($res);
 ipworks_xmpp_do_doevents($res);
 ipworks_xmpp_do_interrupt($res);
 ipworks_xmpp_do_probepresence($res, $jabberid);
 ipworks_xmpp_do_queryregister($res, $xmppserver);
 ipworks_xmpp_do_register($res, $xmppserver);
 ipworks_xmpp_do_remove($res, $jabberid, $name, $group);
 ipworks_xmpp_do_retrieveroster($res);
 ipworks_xmpp_do_sendcommand($res, $command);
 ipworks_xmpp_do_sendfile($res, $jabberid);
 ipworks_xmpp_do_sendmessage($res, $jabberid);
 ipworks_xmpp_do_setuserinfofield($res, $field, $value);
 ipworks_xmpp_do_subscribeto($res, $jabberid);
 ipworks_xmpp_do_unregister($res);
 ipworks_xmpp_do_unsubscribeto($res, $jabberid);

Remarks

A call to the Connect method will perform the entire logon process after which a Connected event will fire indicating connection status. For simplicity, the entire interface is synchronous; the class will not return until a call is completed.

After a successful connection, the class will automatically begin the process of receiving the user's buddy list. The class will parse the XML as it comes in from the server and will set the appropriate properties. Once the entire buddy list has been retrieved, a Sync event will fire.

Sending a message is as simple as calling a single method. One call to the SendMessage method will cause the class to connect if it has not already done so, send the specified message to a specified user, and return to the original connection state.

The XMPP Class interface supports messaging, list and presence management. Other features of the XMPP protocol are supported through the SendCommand method and PITrail event.

Example (Connecting and Sending a Message)

IMControl.Connect("myusername", "mypassword")
IMControl.MessageText = "My Message"
IMControl.SendMessage("ToUser")

IMControl.User = "myusername"
IMControl.Password = "mypassword"
IMControl.MessageText = "My Message"
IMControl.SendMessage("ToUser")