IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

XMPP Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

ipworks.xmpp()

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")
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 class with short descriptions. Click on the links for further details.

AuthDomainThe domain under which the user will be authenticated.
AuthMethodsControls how the component authenticates itself with the XMPP server.
BuddyCountThe number of records in the Buddy arrays.
BuddyGroupThis is a comma-separated list of the buddy's associated groups.
BuddyIdThis is the jabber id of the buddy.
BuddyNickNameThe nickname of the buddy, if one exists.
BuddyRealNameThe real name of the buddy.
BuddySubscriptionThis is a list of the subscription status for the buddy.
ConnectedThis indicates the component's login status.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IMPortThe server port for XMPP (default 5222).
IMServerThis is the instant messaging server.
LocalDirectoryThe directory to which received files are saved.
LocalFileThe path to the file that will be sent.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MessageHTMLThis is the HTML version of the current message.
MessageOtherDataThis property contains extra data elements for the current message.
MessageSubjectThis is the subject of the current message.
MessageTextThis is the plain text of the current message.
MessageThreadThis is the thread name of the current message.
MessageTypeThis is the type of the current message.
PasswordThis is the user's password.
PresenceThis is the availability of the entity.
ResourceThis is the resource for the current session.
ServerDomainThe XMPP server's domain.
StatusDescription of the availability of this entity.
TimeoutA timeout for the component.
UserThe user portion of this entity's Jabber ID.
UserDomainGets or sets the domain value used for Jabber IDs.
UserInfoCountThe number of records in the UserInfo arrays.
UserInfoFieldThis is the name of the current property necessary for registration.
UserInfoValueThis is the value for the current registration property, and should be set after calling QueryRegister and before calling Register .

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

AddThis method will add an entity to this entity's roster.
CancelThis will cancel another entity's subscription to this entity's presence.
ChangePasswordThis method will change the current user's password.
ChangePresenceThis method will set the availability and status of this entity.
ConfigSets or retrieves a configuration setting .
ConnectThis method will connect the component to the server.
DisconnectThis method disconnects the component from the server.
DoEventsThis method processes events from the internal message queue.
InterruptInterrupt the current method.
ProbePresenceUse this method to probe for another entity's presence.
QueryRegisterThis method queries a server for the necessary registration fields.
RegisterThis method registers an account with a server.
RemoveThis method will remove an entity from this entity's roster.
RetrieveRosterThis method will retrieve this entity's roster from the server.
SendCommandThis method sends a command to the server.
SendFileSends a file to the specified user.
SendMessageThis method will send a message to the specified user.
SetUserInfoFieldThis method will add a user information field for registration.
SubscribeToUse this method to subscribe to another entity's presence.
UnregisterThis method cancels an account with the host.
UnsubscribeToThis method will cancel a subscription to another entity's presence.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

BuddyUpdateThis event is fired whenever a roster entry is updated.
ConnectedThis event is fired when a connection to the IM Server is completed.
ConnectionStatusFired to indicate changes in connection state.
DisconnectedThis event is fired when the chat service connection is lost.
EndTransferFired when a file transfer completes.
ErrorThis event is fired when the server sends a protocol error message.
IQThis event is fired for IQ messages not normally supported by the component.
MessageInThis event is fired upon receipt of a message.
PITrailThis event is fired for all protocol messages.
PresenceThis event is fired when the presence of a subscribed entity changes.
ReadyToSendFired when IPPort is ready to send data.
StartTransferFired when a file transfer begins.
SubscriptionRequestThis event fires when a subscription request is received.
SyncThis event fires upon a complete information synchronization with the server.
TransferFired during file transfer.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

AccessTokenThe OAuth access token used for authentication.
ClientIdThe OAuth client Id used for authentication.
MessageXMLReturns the last root-level element received by the component.
ParseHTMLTells XMPP whether or not to parse MessageHTML when it's set.
RetrieveRosterWhether to automatically retrieve the roster when logging in.
SendSubscriptionResponseDetermines whether a response will be sent to a Subscription Request.
UseCompressionSpecified whether or not stream compression is used.
OverwriteSpecifies whether or not to overwrite received files.
BlockSizeSpecifies the block size for file transfers.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0