IP*Works! Jabber Component : Jabber OCX, Jabber .NET Component, Jabber Class, Jabber Bean, Jabber Object

Available in: IP*WORKS! | SSH | SSL

Xmpp Class

XMPP Component [IP*Works! V8]

Properties Methods Events Configuration Settings

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

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

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 component will not return until a call is completed.

After a successful connection, the component will automatically begin the process of receiving the user's buddy list. The component 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 component 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 component 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")
Example (Sending a Single Message)

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

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.


AuthDomain	The domain under which the user will be authenticated.
AuthMethods	Controls how the component authenticates itself with the XMPP server.
Buddies	Collection of buddies in the buddy list.
Connected	This indicates the component's login status.
Firewall	A set of properties related to firewall access.
IMPort	The server port for XMPP (default 5222).
IMServer	This is the instant messaging server.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MessageHTML	This is the HTML version of the current message.
MessageOtherData	This properties contains extra data elements for the current message.
MessageSubject	This is the subject of the current message.
MessageText	This is the plain text of the current message.
MessageThread	This is the thread name of the current message.
MessageType	This is the type of the current message.
Password	This is the user's password.
Presence	This is the availability of the this entity.
Resource	This is the resource for the current session.
ServerDomain	The XMPP server's domain.
Status	Description of the availability of this entity.
Timeout	A timeout for the component.
User	The user portion of this entity's Jabber ID.
UserDomain	Gets or sets the domain value used for Jabber IDs
UserInfo	Collection of named registration fields.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.


Add	This method will add an entity to this entity's roster.
Cancel	This will cancel another entity's subscription to this entity's presence.
ChangePassword	This method will change the current user's password.
ChangePresence	This method will set the availability and status of this entity.
Config	Sets or retrieves a component configuration setting.
Connect	This method will connect the component to the server.
Disconnect	This method disconnects the component from the server.
DoEvents	This method processes events from the internal message queue.
Interrupt	Interrupt the current method.
ProbePresence	Use this method to probe for another entity's presence.
QueryRegister	This method queries a server for the necessary registration fields.
Register	This method registers an account with a server.
Remove	This method will remove an entity from this entity's roster.
RetrieveRoster	This method will retrieve this entity's roster from the server.
SendCommand	This method sends a command to the server.
SendMessage	This method will send a message to the specified user.
SetUserInfoField	This method will add a user information field for registration.
SubscribeTo	Use this method to subscribe to another entity's presence.
Unregister	This method cancels an account with the host.
UnsubscribeTo	This method will cancel a subscription to another entity's presence.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.


BuddyUpdate	This event is fired whenever a roster entry is updated.
Connected	This event is fired when a connection to the IM Server is completed.
ConnectionStatus	Fired to indicate changes in connection state.
Disconnected	This event is fired when the chat service connection is lost.
Error	This event is fired when the server sends a protocol error message.
IQ	This event is fired for IQ messages not normally supported by the component.
MessageIn	This event is fired upon receipt of a message.
PITrail	This event is fired for all protocol messages.
Presence	This event is fired when the presence of a subscribed entity changes.
SubscriptionRequest	This event fires when a subscription request is received.
Sync	This event fires upon a complete information synchronization with the server.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.


AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
FirewallData	Used to send extra data to the firewall.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
InBufferSize	The size in bytes of the incoming queue of the socket.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MessageXML	Returns the last root-level element received by the component
OutBufferSize	The size in bytes of the outgoing queue of the socket.
ParseHTML	Tells XMPP whether or not to parse MessageHTML when it's set
TcpNoDelay	Whether or not to delay when sending packets