XMPP Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TiotXMPP

Remarks

The XMPP component supports both plaintext and SSL/TLS connections. When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method.

A call to the ConnectTo 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.ConnectTo("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 further details.

Method List

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

Event List

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

Config Settings

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

AuthDomain Property (XMPP Component)

The domain under which the user will be authenticated.

Syntax

__property String AuthDomain = { read=FAuthDomain, write=FSetAuthDomain };

Default Value

""

Remarks

Set this value if the user must authenticate via a third party authentication service that requires a different domain than the XMPP user's registered domain.

Data Type

String

AuthMethods Property (XMPP Component)

Controls how the component authenticates itself with the XMPP server.

Syntax

__property String AuthMethods = { read=FAuthMethods, write=FSetAuthMethods };

Default Value

"*"

Remarks

AuthMethods is a comma-separated list of authentication methods to be enabled on the component, listed in order of preference. When authenticating, the component will pick the first method in the list that is supported by the server.

The special value * (default) may be supplied to cause the component to enable all supported authentication methods in order of presumed security. The XMPP component currently supports the following values for AuthMethods, listed in order of most secure to least secure:

• SASL/DIGEST-MD5
• AuthIQ/Digest
• SASL/CRAM-MD5
• SASL/PLAIN
• AuthIQ/Plaintext
• SASL/NTLM

Data Type

String

BuddyCount Property (XMPP Component)

The number of records in the Buddy arrays.

Syntax

__property int BuddyCount = { read=FBuddyCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• BuddyGroup
• BuddyId
• BuddyNickName
• BuddyRealName
• BuddySubscription

The array indices start at 0 and end at BuddyCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

BuddyGroup Property (XMPP Component)

This is a comma-separated list of the buddy's associated groups.

Syntax

__property String BuddyGroup[int BuddyIndex] = { read=FBuddyGroup, write=FSetBuddyGroup };

Default Value

""

Remarks

This is a comma-separated list of the buddy's associated groups.

After the Sync event has fired, this property will contain a comma-separated list of groups for the associated BuddyId. Changing this value will cause the buddy's group associations to change. Setting it to the empty string ("") will cause the buddy to be completely disassociated from all groups.

Note: It is recommended to use the UpdateBuddyGroup method instead of setting this property.

The BuddyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BuddyCount property.

This property is not available at design time.

Data Type

String

BuddyId Property (XMPP Component)

This is the jabber id of the buddy.

Syntax

__property String BuddyId[int BuddyIndex] = { read=FBuddyId };

Default Value

""

Remarks

This is the jabber id of the buddy.

After a Sync event is fired, this property will contain the user id associated with the corresponding entry in the buddy list. If a buddy has multiple entries (e.g., if the buddy is listed in several groups) more than one entry will be the same.

The BuddyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BuddyCount property.

This property is read-only and not available at design time.

Data Type

String

BuddyNickName Property (XMPP Component)

The nickname of the buddy, if one exists.

Syntax

__property String BuddyNickName[int BuddyIndex] = { read=FBuddyNickName, write=FSetBuddyNickName };

Default Value

""

Remarks

The nickname of the buddy, if one exists.

The BuddyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BuddyCount property.

This property is not available at design time.

Data Type

String

BuddyRealName Property (XMPP Component)

The real name of the buddy.

Syntax

__property String BuddyRealName[int BuddyIndex] = { read=FBuddyRealName };

Default Value

""

Remarks

The real name of the buddy.

The BuddyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BuddyCount property.

This property is read-only and not available at design time.

Data Type

String

BuddySubscription Property (XMPP Component)

This is a list of the subscription status for the buddy.

Syntax

__property TiotXMPPBuddySubscriptions BuddySubscription[int BuddyIndex] = { read=FBuddySubscription };

enum TiotXMPPBuddySubscriptions {
  stNone=0,
  stTo=1,
  stFrom=2,
  stBoth=3,
  stRemove=4
};

Default Value

stNone

Remarks

This is a list of the subscription status for the buddy.

After a Sync event is fired, this property will contain all of the types of subscriptions for the buddy. They are defined as follows:

The BuddyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BuddyCount property.

This property is read-only and not available at design time.

Data Type

Integer

Connected Property (XMPP Component)

This indicates the component's login status.

Syntax

__property bool Connected = { read=FConnected, write=FSetConnected };

Default Value

False

Remarks

This value shows whether or not the component has successfully logged into the IMServer. It will not be true until a successful Connected event has fired.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

FirewallAutoDetect Property (XMPP Component)

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

Syntax

__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };

Default Value

False

Remarks

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (XMPP Component)

This property determines the type of firewall to connect through.

Syntax

__property TiotXMPPFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TiotXMPPFirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (XMPP Component)

This property contains the name or IP address of firewall (optional).

Syntax

__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component raises an exception.

Data Type

String

FirewallPassword Property (XMPP Component)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception.

Data Type

String

FirewallPort Property (XMPP Component)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (XMPP Component)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.

Data Type

String

IMPort Property (XMPP Component)

The server port for XMPP (default 5222).

Syntax

__property int IMPort = { read=FIMPort, write=FSetIMPort };

Default Value

5222

Remarks

For implicit SSL, use port 5223 (please refer to the SSLStartMode property for more information).

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

Data Type

Integer

IMServer Property (XMPP Component)

This is the instant messaging server.

Syntax

__property String IMServer = { read=FIMServer, write=FSetIMServer };

Default Value

""

Remarks

This is the instant messaging server to which the component will connect when the Connect method is called. The IMServer property must contain a valid XMPP (Jabber) server, or any subsequent calls to the Connect method will fail.

Data Type

String

LocalDirectory Property (XMPP Component)

The directory to which received files are saved.

Syntax

__property String LocalDirectory = { read=FLocalDirectory, write=FSetLocalDirectory };

Default Value

""

Remarks

This setting specifies the directory on disk to which received files will be saved. If this property is not set and a file is received the file data will be available through the Transfer event parameters. This property may also be set when the StartTransfer event fires.

Data Type

String

LocalFile Property (XMPP Component)

The path to the file that will be sent.

Syntax

__property String LocalFile = { read=FLocalFile, write=FSetLocalFile };

Default Value

""

Remarks

This property specifies the local file that will be sent when calling SendFile. This property must be set before calling SendFile.

Data Type

String

LocalHost Property (XMPP Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

__property String LocalHost = { read=FLocalHost, write=FSetLocalHost };

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

MessageHTML Property (XMPP Component)

This is the HTML version of the current message.

Syntax

__property String MessageHTML = { read=FMessageHTML, write=FSetMessageHTML };

Default Value

""

Remarks

If the user wishes to send any HTML as a part of the message, it must be set in the MessageHTML property. The HTML must be an entire HTML document, including the <html> and <body> tags. If the HTML has unbalanced tags, the XMPP component will fail with an error.

This property is not available at design time.

Data Type

String

MessageOtherData Property (XMPP Component)

This property contains extra data elements for the current message.

Syntax

__property String MessageOtherData = { read=FMessageOtherData, write=FSetMessageOtherData };

Default Value

""

Remarks

MessageOtherData will contain zero or more complete XML elements associated with the message, but which are not defined in the Jabber specification.

Data Type

String

MessageSubject Property (XMPP Component)

This is the subject of the current message.

Syntax

__property String MessageSubject = { read=FMessageSubject, write=FSetMessageSubject };

Default Value

""

Remarks

MessageSubject will contain any subject associated with the message. Most Jabber clients will ignore the subject unless the message is of type "headline".

This property is not available at design time.

Data Type

String

MessageText Property (XMPP Component)

This is the plain text of the current message.

Syntax

__property String MessageText = { read=FMessageText, write=FSetMessageText };

Default Value

""

Remarks

MessageText is the plain text version of the current message, taken from the message's "body" child element. The text in this property is automatically escaped to ensure valid XML parsing on the other end.

This property is not available at design time.

Data Type

String

MessageThread Property (XMPP Component)

This is the thread name of the current message.

Syntax

__property String MessageThread = { read=FMessageThread, write=FSetMessageThread };

Default Value

""

Remarks

MessageThread will contain the name of the thread associated with the message. Threads are useful for tracking messages of type "chat" or "groupchat".

This property is not available at design time.

Data Type

String

MessageType Property (XMPP Component)

This is the type of the current message.

Syntax

__property TiotXMPPMessageTypes MessageType = { read=FMessageType, write=FSetMessageType };

enum TiotXMPPMessageTypes {
  jmtNormal=0,
  jmtChat=1,
  jmtGroupChat=2,
  jmtHeadline=3,
  jmtError=4
};

Default Value

jmtNormal

Remarks

MessageType is the type of the message as specified in the XMPP RFC. The possible values are defined in the protocol specification as follows:

This property is not available at design time.

Data Type

Integer

Password Property (XMPP Component)

This is the user's password.

Syntax

__property String Password = { read=FPassword, write=FSetPassword };

Default Value

""

Remarks

This must be set before a connection is attempted. If a call to the Connect method is made specifying a password, the Password property will contain that password.

Data Type

String

Presence Property (XMPP Component)

This is the availability of the entity.

Syntax

__property TiotXMPPPresences Presence = { read=FPresence, write=FSetPresence };

enum TiotXMPPPresences {
  pcOffline=0,
  pcChat=1,
  pcAway=2,
  pcXA=3,
  pcDND=4
};

Default Value

pcChat

Remarks

When the component completes the initial log in, it will send information telling other entities subscribed to this entity's presence that it is online. The application must provide different status and availability information as the user changes them.

The Presence property has one of four values representing general information about the user's status as defined in the Jabber protocol specification:

By default, the component sets the client presence to pcChat, meaning that the user is available. To change the initial status sent by the component set Presence to the desired presence before calling Connect.

Note: offline is not officially supported by the XMPP specification, however some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an Error.

The Status property is a pure-text string representing the user's presence information. Its value maybe be any random string, including the empty string, "".

Whenever the value in Presence or Status are changed, the component will send that information to the server. If the application or user wishes to associate a specific status message with a new presence value, it should use the ChangePresence method. ChangePresence will update both the Presence and Status properties, and then send that information to the server.

Note: It is recommended to use the ChangePresence method instead of setting this property.

This property is not available at design time.

Data Type

Integer

Resource Property (XMPP Component)

This is the resource for the current session.

Syntax

__property String Resource = { read=FResource, write=FSetResource };

Default Value

"IPWorks XMPP Agent"

Remarks

Whenever an entity logs in to an XMPP (Jabber) server, it must provide account information as well as a resource. Resources allow multiple clients to log in using the same account. The server will forward all messages and PI data aimed at a specific resource to that resource. If a command or message is to be sent to a Jabber ID with no specified resource, the server will push that command or message out to all connected resources.

Data Type

String

ServerDomain Property (XMPP Component)

The XMPP server's domain.

Syntax

__property String ServerDomain = { read=FServerDomain, write=FSetServerDomain };

Default Value

""

Remarks

The domain of the XMPP server itself. Set this value if the domain of the server is different from the DNS name of the IMServer.

Data Type

String

SSLAcceptServerCertEncoded Property (XMPP Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SSLCertEncoded Property (XMPP Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SSLCertStore Property (XMPP Component)

This is the name of the certificate store for the client certificate.

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Byte Array

SSLCertStorePassword Property (XMPP Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (XMPP Component)

This is the type of certificate store for this certificate.

Syntax

__property TiotXMPPSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TiotXMPPSSLCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (XMPP Component)

This is the subject of the certificate used for client authentication.

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLEnabled Property (XMPP Component)

Whether TLS/SSL is enabled.

Syntax

__property bool SSLEnabled = { read=FSSLEnabled, write=FSetSSLEnabled };

Default Value

False

Remarks

This setting specifies whether TLS/SSL is enabled in the component. When False (default) the component operates in plaintext mode. When True TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (XMPP Component)

This specifies the SSL/TLS implementation to use.

Syntax

__property TiotXMPPSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TiotXMPPSSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

Default Value

sslpAutomatic

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (XMPP Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Byte Array

SSLStartMode Property (XMPP Component)

Determines how the component starts the SSL negotiation.

Syntax

__property TiotXMPPSSLStartModes SSLStartMode = { read=FSSLStartMode, write=FSetSSLStartMode };

enum TiotXMPPSSLStartModes {
  sslAutomatic=0,
  sslImplicit=1,
  sslExplicit=2,
  sslNone=3
};

Default Value

sslNone

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

Status Property (XMPP Component)

Description of the availability of this entity.

Syntax

__property String Status = { read=FStatus, write=FSetStatus };

Default Value

"Available for Chat."

Remarks

When the component completes the initial log in, it will send information telling other entities subscribed to this entity's presence that it is online. The application must provide different status and availability information as the user changes them.

The Presence property has one of four values representing general information about the user's status as defined in the Jabber protocol specification:

By default, the component sets the client presence to pcChat, meaning that the user is available. To change the initial status sent by the component set Presence to the desired presence before calling Connect.

Note: offline is not officially supported by the XMPP specification, however some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an Error.

The Status property is a pure-text string representing the user's presence information. Its value maybe be any random string, including the empty string, "".

Whenever the value in Presence or Status are changed, the component will send that information to the server. If the application or user wishes to associate a specific status message with a new presence value, it should use the ChangePresence method. ChangePresence will update both the Presence and Status properties, and then send that information to the server.

Note: It is recommended to use the ChangePresence method instead of setting this property.

This property is not available at design time.

Data Type

String

Timeout Property (XMPP Component)

A timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the component raises an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

User Property (XMPP Component)

The user portion of this entity's Jabber ID.

Syntax

__property String User = { read=FUser, write=FSetUser };

Default Value

""

Remarks

The User property is a unique username associated with this entity and set at time of registration under the field "user".

Data Type

String

UserDomain Property (XMPP Component)

Gets or sets the domain value used for Jabber IDs.

Syntax

__property String UserDomain = { read=FUserDomain, write=FSetUserDomain };

Default Value

""

Remarks

A Jabber ID (JID) is a unique identifier of the format "User@Domain/Resource". user@domain denotes the account by username and domain. The Resource is given during the login process to distinguish individual connections under the same account. If the IMServer contains multiple domains, this property setting allows the user to specify the domain under which to login.

If Domain is empty, the value in IMServer is used by default when creating the client's JID.

Data Type

String

UserInfoCount Property (XMPP Component)

The number of records in the UserInfo arrays.

Syntax

__property int UserInfoCount = { read=FUserInfoCount, write=FSetUserInfoCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• UserInfoField
• UserInfoValue

The array indices start at 0 and end at UserInfoCount - 1.

This property is not available at design time.

Data Type

Integer

UserInfoField Property (XMPP Component)

This is the name of the current property necessary for registration.

Syntax

__property String UserInfoField[int FieldIndex] = { read=FUserInfoField, write=FSetUserInfoField };

Default Value

""

Remarks

This is the name of the current property necessary for registration.

Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server, and will populate the UserInfo properties accordingly. After a successful query, all entries in UserInfo values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification as follows:

After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.

If the component is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserInfoCount property.

This property is not available at design time.

Data Type

String

UserInfoValue Property (XMPP Component)

This is the value for the current registration property, and should be set after calling QueryRegister and before calling Register .

Syntax

__property String UserInfoValue[int FieldIndex] = { read=FUserInfoValue, write=FSetUserInfoValue };

Default Value

""

Remarks

This is the value for the current registration field, and should be set after calling QueryRegister and before calling Register.

Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server, and will populate the UserInfo properties accordingly. After a successful query, all entries in UserInfo values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification as follows:

After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.

If the component is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserInfoCount property.

This property is not available at design time.

Data Type

String

Add Method (XMPP Component)

This method will add an entity to this entity's roster.

Syntax

void __fastcall Add(String JabberId, String Name, String Groups);

Remarks

JabberId is the Jabber ID of the entity to be added. It should be of form "user@host". If no hostname is specified, the component will assume the user's account is with the server in IMServer, and will append that hostname to JabberId before sending the request.

Name will contain the name that is to be associated with JabberId in this entity's roster. It may be the empty string, "".

Groups is either the empty string ("") or a comma- separated list of groups to which JabberId is to be added. If JabberId already exists in the buddy list, it will be updated to exist only in the specified groups. A buddy's group list can also be modified by the Buddies property.

The Add method will make a subscription request to the presence of the specified JabberId. Upon receiving this request, the server will add an entry into this user's buddy list with a subscription of type subscriptionNone (0) if there was no previous entry (if this user has already allowed JabberId to subscribe to this user's presence, there will already be an entry of type subscriptionFrom (2)). If the contact chooses to allow the subscription, the server will update the entry and a BuddyUpdate event will fire with the new subscription value (subscriptionTo (1) if this is a new contact, or subscriptionBoth (3) if the contact is now mutual).

The XMPP protocol permits XMPP (Jabber) clients to communicate with foreign IM networks such as AIM, MSN, SMS, and others through the use of gateway servers that translate between the foreign protocol and XMPP. When sending or receiving presence information, messages, or subscription requests, Domain will be a gateway for the foreign network on which the contact resides and with which this user has registered an account for that foreign network. The Register method can be used to register with a foreign network gateway.

Cancel Method (XMPP Component)

This will cancel another entity's subscription to this entity's presence.

Syntax

void __fastcall Cancel(String JabberId);

Remarks

If for any reason the user should want to undo a previously granted subscription, this can be achieved through the Cancel method. The method will unsubscribe the target from this user's presence, thus preventing the target from seeing this user in the future.

ChangePassword Method (XMPP Component)

This method will change the current user's password.

Syntax

void __fastcall ChangePassword(String Password);

Remarks

This method changes the current user's password to the password that is specified. The component must be connected to the server when this method is called.

ChangePresence Method (XMPP Component)

This method will set the availability and status of this entity.

Syntax

void __fastcall ChangePresence(int PresenceCode, String Status);

Remarks

PresenceCode should correspond the possible values of the Presence property:

By default, the component sets the client presence to pcChat, meaning that the user is available. To change the initial status sent by the component set Presence to the desired presence before calling Connect.

Note: offline is not officially supported by the XMPP specification, however some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an Error.

Status can be any random string, including the empty string "".

Config Method (XMPP Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (XMPP Component)

This method will connect the component to the server.

Syntax

void __fastcall Connect();

Remarks

The Connect method performs the entire connection routine. This includes connection to the IMServer, authenticating with the specified User and Password, and session initialization.

The Connected event will fire once for the initial TCP connection and again when the XMPP Logon is complete.

ConnectTo Method (XMPP Component)

This method will connect the component to the server.

Syntax

void __fastcall ConnectTo(String User, String Password);

Remarks

The ConnectTo method performs the entire connection routine. This includes connection to the IMServer, user logon and authentication, and session initialization.

The Connected event will fire once for the initial TCP connection and again when the XMPP Logon is complete.

Since ConnectTo is called with a user and password specified, the User and Password properties will updated accordingly.

Disconnect Method (XMPP Component)

This method disconnects the component from the server.

Syntax

void __fastcall Disconnect();

Remarks

The Disconnect method will send the disconnect command to the notification server. Upon disconnection, a Disconnected event will be fired.

DoEvents Method (XMPP Component)

This method processes events from the internal message queue.

Syntax

void __fastcall DoEvents();

Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Interrupt Method (XMPP Component)

Interrupt the current method.

Syntax

void __fastcall Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ProbePresence Method (XMPP Component)

Use this method to probe for another entity's presence.

Syntax

void __fastcall ProbePresence(String JabberId);

Remarks

In the case that the user needs to update a particular entity's presence this method can be used to retrieve it. After a successful call, the server will either respond with the last known presence for Jabber, or will send a presence element of type "error". In either case, the respond will be returned by a Presence event.

QueryRegister Method (XMPP Component)

This method queries a server for the necessary registration fields.

Syntax

void __fastcall QueryRegister(String XMPPServer);

Remarks

Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server, and will populate the UserInfo properties accordingly. After a successful query, all entries in UserInfo values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification as follows:

After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.

If the component is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

Register Method (XMPP Component)

This method registers an account with a server.

Syntax

void __fastcall Register(String XMPPServer);

Remarks

Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server, and will populate the UserInfo properties accordingly. After a successful query, all entries in UserInfo values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification as follows:

After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.

If the component is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

A new account can be registered at any time, including while the component is logged into the host under an existing account.

Remove Method (XMPP Component)

This method will remove an entity from this entity's roster.

Syntax

void __fastcall Remove(String JabberId, String Name, String Group);

Remarks

JabberId is the Jabber ID of the entity to be removed. It should be of form "user@host". If no hostname is specified, the component will assume the user's account is with the server in IMServer, and will append that hostname to JabberId before sending the request.

Name should contain the name that is to be associated with JabberId in this entity's roster. It may be the empty string, "".

Groups may be either the empty string ("") or a comma- separated list of groups from which JabberId is to be removed. If no group is specified, the buddy will be completely removed from the buddy list.

After calling the Remove method, the server will remove the entry from the server-side roster, and will push the result out to all connected resources. A BuddyUpdate event will fire with subscription of type subscriptionRemove, and the entry will be removed from the Jabber component's internally stored list.

Reset Method (XMPP Component)

Reset the component.

Syntax

void __fastcall Reset();

Remarks

This method will reset the component's properties to their default values.

RetrieveRoster Method (XMPP Component)

This method will retrieve this entity's roster from the server.

Syntax

void __fastcall RetrieveRoster();

Remarks

After the component connects, it will automatically send a request to the server to retrieve the roster. However, should the user or application wish to update the entire roster, this method may be used to do so.

After a successful call to the RetrieveRoster method, the server will respond with this entity's roster. The component will parse the roster and fire the Sync event once per item. This event may also fire for each entity added to or removed from the roster.

SendCommand Method (XMPP Component)

This method sends a command to the server.

Syntax

void __fastcall SendCommand(String Command);

Remarks

The SendCommand method will send the Command parameter to the server. The command must be in valid XML format, and must be recognizable to the IMServer.

The SendCommand method should only be used by programmers or users who are connecting to non-standard servers whose command list is not covered by the component. Any responses that are defined in the protocol specification will be returned by the appropriate event. Any non-standard IQ message will be returned by the IQ event. All other responses will be returned by the PITrail event.

SendFile Method (XMPP Component)

Sends a file to the specified user.

Syntax

void __fastcall SendFile(String JabberId);

Remarks

This method sends the file specified by LocalFile to the user specified by the JabberId parameter.

JabberId is the intended recipient of the message. It is of the form user@domain/resource. If a resource is not supplied, all logged-in instances of the user's account will receive the message.

The component supports sending files using In-Band Bystestreams as defined in XEP-0047 and XEP-0096.

SendMsg Method (XMPP Component)

This method will send a message to the specified user.

Syntax

String __fastcall SendMsg(String JabberId);

Remarks

SetUserInfoField Method (XMPP Component)

This method will add a user information field for registration.

Syntax

void __fastcall SetUserInfoField(String Field, String Value);

Remarks

This method will search through UserInfo for the field name in Field and set the corresponding value to Value. If the field was not previously contained in UserInfo, it will automatically added.

Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server, and will populate the UserInfo properties accordingly. After a successful query, all entries in UserInfo values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification as follows:

After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.

If the component is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

SubscribeTo Method (XMPP Component)

Use this method to subscribe to another entity's presence.

Syntax

void __fastcall SubscribeTo(String JabberId);

Remarks

This method will send a request for a subscription to JabberId's presence. If the entity allows the subscription, a new item will be stored in the buddy list with the appropriate subscription type. Otherwise, no change will take place.

Unregister Method (XMPP Component)

This method cancels an account with the host.

Syntax

void __fastcall Unregister();

Remarks

If the user or application wishes to terminate an account with the IMServer it should make a call to this method. After a successful call, the account will be canceled and the component will be logged off the server, but not disconnected.

UnsubscribeTo Method (XMPP Component)

This method will cancel a subscription to another entity's presence.

Syntax

void __fastcall UnsubscribeTo(String JabberId);

Remarks

This method will inform the server of the cancellation of subscription to JabberId's presence. After a successful call the subscription type of the associated buddy list item will be updated.

UpdateBuddyGroup Method (XMPP Component)

Updates the buddy's associatd groups.

Syntax

void __fastcall UpdateBuddyGroup(int BuddyIndex, String Group);

Remarks

This method updates the associated groups for the buddy specified by BuddyIndex.

After the Sync event has fired the BuddyGroup property is populated with a comma-separated list of groups for each buddy. To update the groups for a buddy call this method with the buddy's index and the comma-separate list of groups the buddy should be associated with. Setting Group to empty string ("") will cause the buddy to be completely disassociated from all groups.

BuddyUpdate Event (XMPP Component)

This event is fired whenever a roster entry is updated.

Syntax

typedef struct {
  int BuddyIdx;
} TiotXMPPBuddyUpdateEventParams;
typedef void __fastcall (__closure *TiotXMPPBuddyUpdateEvent)(System::TObject* Sender, TiotXMPPBuddyUpdateEventParams *e);
__property TiotXMPPBuddyUpdateEvent OnBuddyUpdate = { read=FOnBuddyUpdate, write=FOnBuddyUpdate };

Remarks

The BuddyUpdate event will fire whenever a new buddy list entry is added or an old entry is updated. The updated information can be retrieved through the Buddies properties property. The BuddyIdx parameter of this event will be the index of that XMPPBuddy in the properties.

Connected Event (XMPP Component)

This event is fired when a connection to the IM Server is completed.

Syntax

typedef struct {
  int StatusCode;
  String Description;
} TiotXMPPConnectedEventParams;
typedef void __fastcall (__closure *TiotXMPPConnectedEvent)(System::TObject* Sender, TiotXMPPConnectedEventParams *e);
__property TiotXMPPConnectedEvent OnConnected = { read=FOnConnected, write=FOnConnected };

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

If the connection fails, StatusCode has the error code returned by the TCP/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (XMPP Component)

This event is fired to indicate changes in the connection state.

Syntax

typedef struct {
  String ConnectionEvent;
  int StatusCode;
  String Description;
} TiotXMPPConnectionStatusEventParams;
typedef void __fastcall (__closure *TiotXMPPConnectionStatusEvent)(System::TObject* Sender, TiotXMPPConnectionStatusEventParams *e);
__property TiotXMPPConnectionStatusEvent OnConnectionStatus = { read=FOnConnectionStatus, write=FOnConnectionStatus };

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Disconnected Event (XMPP Component)

This event is fired when the chat service connection is lost.

Syntax

typedef struct {
  int StatusCode;
  String Description;
} TiotXMPPDisconnectedEventParams;
typedef void __fastcall (__closure *TiotXMPPDisconnectedEvent)(System::TObject* Sender, TiotXMPPDisconnectedEventParams *e);
__property TiotXMPPDisconnectedEvent OnDisconnected = { read=FOnDisconnected, write=FOnDisconnected };

Remarks

If the connection is broken normally, StatusCode is 0, and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the TCP/IP subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (XMPP Component)

Fired when a file transfer completes.

Syntax

typedef struct {
  int Direction;
  String FileId;
  String Filename;
  bool Success;
} TiotXMPPEndTransferEventParams;
typedef void __fastcall (__closure *TiotXMPPEndTransferEvent)(System::TObject* Sender, TiotXMPPEndTransferEventParams *e);
__property TiotXMPPEndTransferEvent OnEndTransfer = { read=FOnEndTransfer, write=FOnEndTransfer };

Remarks

When a file transfer completes this event will fire.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (XMPP Component)

This event is fired when the server sends a protocol error message.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TiotXMPPErrorEventParams;
typedef void __fastcall (__closure *TiotXMPPErrorEvent)(System::TObject* Sender, TiotXMPPErrorEventParams *e);
__property TiotXMPPErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

This is fired whenever there is a protocol error. ErrorCode will contain the error code string sent by the server. Description will contain the Xmpp component's interpretation of the code.

IQ Event (XMPP Component)

This event is fired for IQ messages not normally supported by the component.

Syntax

typedef struct {
  String Iq;
  String Id;
  String From;
  String IqType;
  bool Ignore;
} TiotXMPPIQEventParams;
typedef void __fastcall (__closure *TiotXMPPIQEvent)(System::TObject* Sender, TiotXMPPIQEventParams *e);
__property TiotXMPPIQEvent OnIQ = { read=FOnIQ, write=FOnIQ };

Remarks

Some servers may wish to gather some data from the client in ways not specified by the XMPP RFC. This event will contain any IQ message that is not a part of the Jabber specification. The Iq parameter will contain an entire XML entity, and thus will require both knowledge of XML and knowledge of the possible contents of the IQ message to parse. Id will contain the transaction id of the IQ message. From will contain the sender's Jabber ID. IqType will have one of the following values:

Note: to respond to these IQs, you may use the SendCommand method.

MessageIn Event (XMPP Component)

This event is fired upon receipt of a message.

Syntax

typedef struct {
  String MessageId;
  String From;
  String Domain;
  String Resource;
  int MessageType;
  String Subject;
  String MessageThread;
  String MessageText;
  String MessageHTML;
  String Other;
} TiotXMPPMessageInEventParams;
typedef void __fastcall (__closure *TiotXMPPMessageInEvent)(System::TObject* Sender, TiotXMPPMessageInEventParams *e);
__property TiotXMPPMessageInEvent OnMessageIn = { read=FOnMessageIn, write=FOnMessageIn };

Remarks

When a message is received, the XMPP component will parse the sender's Jabber ID into the From, Domain, and Resource fields. These parameters can be used to track the exact instance of a user's account that originated the message.

MessageId can be used with Jabber extension protocols. The MessageText parameter is the plaintext portion of the message body. MessageHTML will contain any HTML from the message.

Type the type of message received. See MessageType for a list of possible values. For message of type "headline", Subject will reflect the subject of the message. For messages of type "chat", Thread will report the conversation thread for which the current message is a follow-up.

Other will contains any extra data associated with the message but not defined by the XMPP-IM protocol.

PITrail Event (XMPP Component)

This event is fired for all protocol messages.

Syntax

typedef struct {
  int Direction;
  String Pi;
} TiotXMPPPITrailEventParams;
typedef void __fastcall (__closure *TiotXMPPPITrailEvent)(System::TObject* Sender, TiotXMPPPITrailEventParams *e);
__property TiotXMPPPITrailEvent OnPITrail = { read=FOnPITrail, write=FOnPITrail };

Remarks

The PITrail event is useful for debugging purposes. It shows all the interaction between the client and the server, line by line.

SessionId will hold the session number that originated the PI. A value of 0 is reserved for all PI dealing with the IMServer.

The direction parameter shows the originator of the message:

The Pi parameter contains the PI message.

Presence Event (XMPP Component)

This event is fired when the presence of a subscribed entity changes.

Syntax

typedef struct {
  String User;
  String Domain;
  String Resource;
  int Availability;
  String Status;
} TiotXMPPPresenceEventParams;
typedef void __fastcall (__closure *TiotXMPPPresenceEvent)(System::TObject* Sender, TiotXMPPPresenceEventParams *e);
__property TiotXMPPPresenceEvent OnPresence = { read=FOnPresence, write=FOnPresence };

Remarks

This event contains the availability and status information of a particular Jabber entity to whom this entity has a subscription.

Because a user can log in multiple times using the same account, the XMPP component will parse the user's Jabber ID into the User, Domain and Resource parameters so that the client can easily track which instance of the account sent the presence.

The XMPP protocol permits XMPP (Jabber) clients to communicate with foreign IM networks such as AIM, MSN, SMS, and others through the use of gateway servers that translate between the foreign protocol and XMPP. When sending or receiving presence information, messages, or subscription requests, Domain will be a gateway for the foreign network on which the contact resides and with which this user has registered an account for that foreign network. The Register method can be used to register with a foreign network gateway.

Availability corresponds to the Presence property of the component, with the same possible values:

By default, the component sets the client presence to pcChat, meaning that the user is available. To change the initial status sent by the component set Presence to the desired presence before calling Connect.

Note: offline is not officially supported by the XMPP specification, however some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an Error.

Status corresponds to the Status property. This value may be any random string, including the empty string, "".

ReadyToSend Event (XMPP Component)

This event is fired when the component is ready to send data.

Syntax

typedef struct {
} TiotXMPPReadyToSendEventParams;
typedef void __fastcall (__closure *TiotXMPPReadyToSendEvent)(System::TObject* Sender, TiotXMPPReadyToSendEventParams *e);
__property TiotXMPPReadyToSendEvent OnReadyToSend = { read=FOnReadyToSend, write=FOnReadyToSend };

Remarks

The ReadyToSend event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed DataToSend. This event also is fired immediately after a connection to the remote host is established.

SSLServerAuthentication Event (XMPP Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TiotXMPPSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TiotXMPPSSLServerAuthenticationEvent)(System::TObject* Sender, TiotXMPPSSLServerAuthenticationEventParams *e);
__property TiotXMPPSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (XMPP Component)

Shows the progress of the secure connection.

Syntax

typedef struct {
  String Message;
} TiotXMPPSSLStatusEventParams;
typedef void __fastcall (__closure *TiotXMPPSSLStatusEvent)(System::TObject* Sender, TiotXMPPSSLStatusEventParams *e);
__property TiotXMPPSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (XMPP Component)

Fired when a file transfer begins.

Syntax

typedef struct {
  int Direction;
  String FileId;
  String User;
  String Domain;
  String Resource;
  String Filename;
  String Datetime;
  __int64 Size;
  bool Accept;
} TiotXMPPStartTransferEventParams;
typedef void __fastcall (__closure *TiotXMPPStartTransferEvent)(System::TObject* Sender, TiotXMPPStartTransferEventParams *e);
__property TiotXMPPStartTransferEvent OnStartTransfer = { read=FOnStartTransfer, write=FOnStartTransfer };

Remarks

When a file is received, the XMPP component will parse the sender's Jabber ID into the User, Domain, and Resource fields. The FileId and Filename parameters identify the current transfer. Within this event you may override the Filename by setting the Filename parameter. At this time you may also set LocalDirectory if it is not already set.

When a sending a file, the XMPP component will parse the receiver's Jabber ID into the User, Domain, and Resource fields.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

SubscriptionRequest Event (XMPP Component)

This event fires when a subscription request is received.

Syntax

typedef struct {
  String From;
  String Domain;
  bool Accept;
} TiotXMPPSubscriptionRequestEventParams;
typedef void __fastcall (__closure *TiotXMPPSubscriptionRequestEvent)(System::TObject* Sender, TiotXMPPSubscriptionRequestEventParams *e);
__property TiotXMPPSubscriptionRequestEvent OnSubscriptionRequest = { read=FOnSubscriptionRequest, write=FOnSubscriptionRequest };

Remarks

This event fires whenever another XMPP entity requests a subscription to this entity's presence. The XMPP component will parse the requesting entity's Jabber ID into the From and Domain parameters. There is no need to know which resource sent the request, since all instances of the requesting entity's account have access to the same roster.

Accept will initially be false, but setting it to true will cause the XMPP component to allow the remote subscription. Otherwise, the XMPP component will actively deny the subscription request.

Sync Event (XMPP Component)

This event fires upon a complete information synchronization with the server.

Syntax

typedef struct {
} TiotXMPPSyncEventParams;
typedef void __fastcall (__closure *TiotXMPPSyncEvent)(System::TObject* Sender, TiotXMPPSyncEventParams *e);
__property TiotXMPPSyncEvent OnSync = { read=FOnSync, write=FOnSync };

Remarks

The Sync event will fire after each successful call to the RetrieveRoster method. When the event fires, the buddy list, or roster, will be completely retrieved and the Buddies properties will be filled out accordingly:

Please refer to Buddies properties property for more information.

Transfer Event (XMPP Component)

Fired during file transfer.

Syntax

typedef struct {
  int Direction;
  String FileId;
  String Filename;
  __int64 BytesTransferred;
  int PercentDone;
  String Text;
  DynamicArray<Byte> TextB;
  bool Cancel;
} TiotXMPPTransferEventParams;
typedef void __fastcall (__closure *TiotXMPPTransferEvent)(System::TObject* Sender, TiotXMPPTransferEventParams *e);
__property TiotXMPPTransferEvent OnTransfer = { read=FOnTransfer, write=FOnTransfer };

Remarks

This event will fire when sending or receiving. One or more Transfer events are fired during file transfer.

The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (XMPP Component)

XMPP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (XMPP Component)

XMPP Errors

The component may also return one of the following error codes, which are inherited from other components.

TCPClient Errors

SSL Errors

TCP/IP Errors