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

nsoftware.IPWorksMQ.XMPP

Remarks

The XMPP component supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (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 through the Config method.

A call to the ConnectTo method will perform the entire logon process after which a Connected event will fire to indicate the 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 1. Connecting and Sending a Message:

IMControl.ConnectTo("myusername", "mypassword") IMControl.MessageText = "My Message" IMControl.SendMessage("ToUser") Example 2. 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)

This property includes the domain under which the user will be authenticated.

Syntax

• C#
• VB.NET

public string AuthDomain { get; set; }

Public Property AuthDomain As String

Default Value

""

Remarks

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

AuthMethods Property (XMPP Component)

This property controls how the component authenticates itself with the XMPP server.

Syntax

• C#
• VB.NET

public string AuthMethods { get; set; }

Public Property AuthMethods As String

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

Buddies Property (XMPP Component)

This property includes a collection of buddies in the buddy list.

Syntax

• C#
• VB.NET

public XMPPBuddyList Buddies { get; }

Public ReadOnly Property Buddies As XMPPBuddyList

Remarks

After a Sync event is fired, this property will contain a collection of all buddies in the buddy list. The buddy list will be updated by the server when a successful call to RetrieveRoster has been made.

This collection is indexed from 0 to count -1.

This property is read-only.

Connected Property (XMPP Component)

This property indicates whether the component is connected and logged in.

Syntax

• C#
• VB.NET

public bool Connected { get; }

Public ReadOnly Property Connected As Boolean

Default Value

False

Remarks

This property indicates whether the component is connected and logged in to the remote host. Use the Connect and Disconnect methods to manage the connection.

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

Firewall Property (XMPP Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

IMPort Property (XMPP Component)

This property includes the server port for XMPP (default 5222).

Syntax

• C#
• VB.NET

public int IMPort { get; set; }

Public Property IMPort As Integer

Default Value

5222

Remarks

For an implicit Secure Sockets Layer (SSL), use port 5223. For more information, please refer to the SSLStartMode property.

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.

IMServer Property (XMPP Component)

This property is the instant messaging server.

Syntax

• C#
• VB.NET

public string IMServer { get; set; }

Public Property IMServer As String

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.

LocalDirectory Property (XMPP Component)

This property includes the directory to which received files are saved.

Syntax

• C#
• VB.NET

public string LocalDirectory { get; set; }

Public Property LocalDirectory As String

Default Value

""

Remarks

This property 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.

LocalFile Property (XMPP Component)

This property includes the path to the file that will be sent.

Syntax

• C#
• VB.NET

public string LocalFile { get; set; }

Public Property LocalFile As String

Default Value

""

Remarks

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

LocalHost Property (XMPP Component)

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

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

Default Value

""

Remarks

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

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 multihomed 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.

MessageHTML Property (XMPP Component)

This property includes the HTML version of the current message.

Syntax

• C#
• VB.NET

public string MessageHTML { get; set; }

Public Property MessageHTML As String

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.

MessageOtherData Property (XMPP Component)

This property contains extra data elements for the current message.

Syntax

• C#
• VB.NET

public string MessageOtherData { get; set; }

Public Property MessageOtherData As String

Default Value

""

Remarks

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

MessageSubject Property (XMPP Component)

This property is the subject of the current message.

Syntax

• C#
• VB.NET

public string MessageSubject { get; set; }

Public Property MessageSubject As String

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.

MessageText Property (XMPP Component)

This property is the plaintext version of the current message.

Syntax

• C#
• VB.NET

public string MessageText { get; set; }

Public Property MessageText As String

Default Value

""

Remarks

MessageText is the plaintext 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.

MessageThread Property (XMPP Component)

This property is the thread name of the current message.

Syntax

• C#
• VB.NET

public string MessageThread { get; set; }

Public Property MessageThread As String

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.

MessageType Property (XMPP Component)

This property is the type of the current message.

Syntax

• C#
• VB.NET

public XMPPMessageTypes MessageType { get; set; }

enum XMPPMessageTypes {
  jmtNormal,
  jmtChat,
  jmtGroupChat,
  jmtHeadline,
  jmtError
}

Public Property MessageType As XmppMessageTypes

Enum XMPPMessageTypes
  jmtNormal
  jmtChat
  jmtGroupChat
  jmtHeadline
  jmtError
End Enum

Default Value

0

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.

Password Property (XMPP Component)

This property is the user's password.

Syntax

• C#
• VB.NET

public string Password { get; set; }

Public Property Password As String

Default Value

""

Remarks

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

Presence Property (XMPP Component)

This property indicates the availability of the entity.

Syntax

• C#
• VB.NET

public XMPPPresences Presence { get; }

enum XMPPPresences {
  pcOffline,
  pcChat,
  pcAway,
  pcXA,
  pcDND
}

Public ReadOnly Property Presence As XmppPresences

Enum XMPPPresences
  pcOffline
  pcChat
  pcAway
  pcXA
  pcDND
End Enum

Default Value

1

Remarks

When the component completes the initial login, it will send information telling other entities subscribed to this entity's presence that it is online.

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.

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, "".

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.

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

Resource Property (XMPP Component)

This property is the resource for the current session.

Syntax

• C#
• VB.NET

public string Resource { get; set; }

Public Property Resource As String

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.

ServerDomain Property (XMPP Component)

This property includes the XMPP server's domain.

Syntax

• C#
• VB.NET

public string ServerDomain { get; set; }

Public Property ServerDomain As String

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.

SSLAcceptServerCert Property (XMPP Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (XMPP Component)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLEnabled Property (XMPP Component)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Syntax

• C#
• VB.NET

public bool SSLEnabled { get; set; }

Public Property SSLEnabled As Boolean

Default Value

False

Remarks

This property 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.

SSLProvider Property (XMPP Component)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C#
• VB.NET

public XMPPSSLProviders SSLProvider { get; set; }

enum XMPPSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As XmppSSLProviders

Enum XMPPSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

Default Value

0

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 as follows:

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, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (XMPP Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

SSLStartMode Property (XMPP Component)

This property determines how the component starts the Secure Sockets Layer (SSL) negotiation.

Syntax

• C#
• VB.NET

public XMPPSSLStartModes SSLStartMode { get; set; }

enum XMPPSSLStartModes {
  sslAutomatic,
  sslImplicit,
  sslExplicit,
  sslNone
}

Public Property SSLStartMode As XmppSSLStartModes

Enum XMPPSSLStartModes
  sslAutomatic
  sslImplicit
  sslExplicit
  sslNone
End Enum

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Status Property (XMPP Component)

This property holds the description of the availability of this entity.

Syntax

• C#
• VB.NET

public string Status { get; }

Public ReadOnly Property Status As String

Default Value

"Available for Chat."

Remarks

When the component completes the initial login, it will send information telling other entities subscribed to this entity's presence that it is online.

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.

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, "".

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.

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

Timeout Property (XMPP Component)

The timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

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 throws an exception.

Note: By default, all timeouts are inactivity timeouts, that is, 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.

User Property (XMPP Component)

This property includes the user portion of this entity's Jabber Id.

Syntax

• C#
• VB.NET

public string User { get; set; }

Public Property User As String

Default Value

""

Remarks

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

UserDomain Property (XMPP Component)

This property gets or sets the domain value used for Jabber Ids.

Syntax

• C#
• VB.NET

public string UserDomain { get; set; }

Public Property UserDomain As String

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 log in.

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

UserInfo Property (XMPP Component)

This property includes the collection of named registration fields.

Syntax

• C#
• VB.NET

public XMPPUserInfoMap UserInfo { get; }

Public Property UserInfo As XMPPUserInfoMap

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 collection 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.

This collection is a hash-table type of collection in which the field string is used as the key to the desired XMPP user info object.

Example. Setting New User Information:

xmpp1.QueryRegister("server"); xmpp1.UserInfo["Username"].Value = "newuser"; xmpp1.UserInfo["Password"].Value = "newpass"; xmpp1.Register("server");

This property is not available at design time.

Add Method (XMPP Component)

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

Syntax

• C#
• VB.NET

public void Add(string jabberId, string name, string groups);

Async Version
public async Task Add(string jabberId, string name, string groups);
public async Task Add(string jabberId, string name, string groups, CancellationToken cancellationToken);

Public Sub Add(ByVal JabberId As String, ByVal Name As String, ByVal Groups As String)

Async Version
Public Sub Add(ByVal JabberId As String, ByVal Name As String, ByVal Groups As String) As Task
Public Sub Add(ByVal JabberId As String, ByVal Name As String, ByVal Groups As String, cancellationToken As CancellationToken) As Task

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 the 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 method will cancel another entity's subscription to this entity's presence.

Syntax

• C#
• VB.NET

public void Cancel(string jabberId);

Async Version
public async Task Cancel(string jabberId);
public async Task Cancel(string jabberId, CancellationToken cancellationToken);

Public Sub Cancel(ByVal JabberId As String)

Async Version
Public Sub Cancel(ByVal JabberId As String) As Task
Public Sub Cancel(ByVal JabberId As String, cancellationToken As CancellationToken) As Task

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

• C#
• VB.NET

public void ChangePassword(string password);

Async Version
public async Task ChangePassword(string password);
public async Task ChangePassword(string password, CancellationToken cancellationToken);

Public Sub ChangePassword(ByVal Password As String)

Async Version
Public Sub ChangePassword(ByVal Password As String) As Task
Public Sub ChangePassword(ByVal Password As String, cancellationToken As CancellationToken) As Task

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

• C#
• VB.NET

public void ChangePresence(int presenceCode, string status);

Async Version
public async Task ChangePresence(int presenceCode, string status);
public async Task ChangePresence(int presenceCode, string status, CancellationToken cancellationToken);

Public Sub ChangePresence(ByVal PresenceCode As Integer, ByVal Status As String)

Async Version
Public Sub ChangePresence(ByVal PresenceCode As Integer, ByVal Status As String) As Task
Public Sub ChangePresence(ByVal PresenceCode As Integer, ByVal Status As String, cancellationToken As CancellationToken) As Task

Remarks

PresenceCode should correspond to the possible values of the Presence property:

By default, the component sets the client presence to pcChat, meaning that the user is available.

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

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

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

• C#
• VB.NET

public void Connect();

Async Version
public async Task Connect();
public async Task Connect(CancellationToken cancellationToken);

Public Sub Connect()

Async Version
Public Sub Connect() As Task
Public Sub Connect(cancellationToken As CancellationToken) As Task

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 Transmission Control Protocol (TCP) connection and again when the XMPP Logon is complete.

ConnectTo Method (XMPP Component)

This method will connect the component to the server.

Syntax

• C#
• VB.NET

public void ConnectTo(string user, string password);

Async Version
public async Task ConnectTo(string user, string password);
public async Task ConnectTo(string user, string password, CancellationToken cancellationToken);

Public Sub ConnectTo(ByVal User As String, ByVal Password As String)

Async Version
Public Sub ConnectTo(ByVal User As String, ByVal Password As String) As Task
Public Sub ConnectTo(ByVal User As String, ByVal Password As String, cancellationToken As CancellationToken) As Task

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 Transmission Control Protocol (TCP) connection and again when the XMPP Logon is complete.

Because 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

• C#
• VB.NET

public void Disconnect();

Async Version
public async Task Disconnect();
public async Task Disconnect(CancellationToken cancellationToken);

Public Sub Disconnect()

Async Version
Public Sub Disconnect() As Task
Public Sub Disconnect(cancellationToken As CancellationToken) As Task

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

• C#
• VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

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)

This method interrupts the current method.

Syntax

• C#
• VB.NET

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);

Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

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

• C#
• VB.NET

public void ProbePresence(string jabberId);

Async Version
public async Task ProbePresence(string jabberId);
public async Task ProbePresence(string jabberId, CancellationToken cancellationToken);

Public Sub ProbePresence(ByVal JabberId As String)

Async Version
Public Sub ProbePresence(ByVal JabberId As String) As Task
Public Sub ProbePresence(ByVal JabberId As String, cancellationToken As CancellationToken) As Task

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

• C#
• VB.NET

public void QueryRegister(string XMPPServer);

Async Version
public async Task QueryRegister(string XMPPServer);
public async Task QueryRegister(string XMPPServer, CancellationToken cancellationToken);

Public Sub QueryRegister(ByVal XMPPServer As String)

Async Version
Public Sub QueryRegister(ByVal XMPPServer As String) As Task
Public Sub QueryRegister(ByVal XMPPServer As String, cancellationToken As CancellationToken) As Task

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 collection 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

• C#
• VB.NET

public void Register(string XMPPServer);

Async Version
public async Task Register(string XMPPServer);
public async Task Register(string XMPPServer, CancellationToken cancellationToken);

Public Sub Register(ByVal XMPPServer As String)

Async Version
Public Sub Register(ByVal XMPPServer As String) As Task
Public Sub Register(ByVal XMPPServer As String, cancellationToken As CancellationToken) As Task

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 collection 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

• C#
• VB.NET

public void Remove(string jabberId, string name, string group);

Async Version
public async Task Remove(string jabberId, string name, string group);
public async Task Remove(string jabberId, string name, string group, CancellationToken cancellationToken);

Public Sub Remove(ByVal JabberId As String, ByVal Name As String, ByVal Group As String)

Async Version
Public Sub Remove(ByVal JabberId As String, ByVal Name As String, ByVal Group As String) As Task
Public Sub Remove(ByVal JabberId As String, ByVal Name As String, ByVal Group As String, cancellationToken As CancellationToken) As Task

Remarks

JabberId is the Jabber Id of the entity to be removed. It should be in the form of "user@host". If no hostname is specified, the component will assume the user's account is with the server in IMServer, and it 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 a subscription of type subscriptionRemove, and the entry will be removed from the Jabber component's internally stored list.

Reset Method (XMPP Component)

This method will reset the component.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

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

• C#
• VB.NET

public void RetrieveRoster();

Async Version
public async Task RetrieveRoster();
public async Task RetrieveRoster(CancellationToken cancellationToken);

Public Sub RetrieveRoster()

Async Version
Public Sub RetrieveRoster() As Task
Public Sub RetrieveRoster(cancellationToken As CancellationToken) As Task

Remarks

After the component connects, it will automatically send a request to the server to retrieve the roster. If, however, 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

• C#
• VB.NET

public void SendCommand(string command);

Async Version
public async Task SendCommand(string command);
public async Task SendCommand(string command, CancellationToken cancellationToken);

Public Sub SendCommand(ByVal Command As String)

Async Version
Public Sub SendCommand(ByVal Command As String) As Task
Public Sub SendCommand(ByVal Command As String, cancellationToken As CancellationToken) As Task

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 be used only by programmers or users who are connecting to nonstandard 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 nonstandard IQ message will be returned by the IQ event. All other responses will be returned by the PITrail event.

SendFile Method (XMPP Component)

This method sends a file to the specified user.

Syntax

• C#
• VB.NET

public void SendFile(string jabberId);

Async Version
public async Task SendFile(string jabberId);
public async Task SendFile(string jabberId, CancellationToken cancellationToken);

Public Sub SendFile(ByVal JabberId As String)

Async Version
Public Sub SendFile(ByVal JabberId As String) As Task
Public Sub SendFile(ByVal JabberId As String, cancellationToken As CancellationToken) As Task

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.

If SetSendStream is called, the stream will be used as the source when sending the file.

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

SendMessage Method (XMPP Component)

This method will send a message to the specified user.

Syntax

• C#
• VB.NET

public string SendMessage(string jabberId);

Async Version
public async Task<string> SendMessage(string jabberId);
public async Task<string> SendMessage(string jabberId, CancellationToken cancellationToken);

Public Function SendMessage(ByVal JabberId As String) As String

Async Version
Public Function SendMessage(ByVal JabberId As String) As Task(Of String)
Public Function SendMessage(ByVal JabberId As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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 associates several properties with messages it receives and sends. When it receives a message, the component will parse out the corresponding values and set these properties before firing a MessageIn event. After the event returns control to the component, the properties will be cleared (i.e., they will be set to the empty string, "").

Before sending a message, the application should set the appropriate properties to be associated with the message. The component will send only properties with nonempty string values ("") and will clear all properties after a successful send.

The associated properties are the following:

If the parameter passed to SendMessage is prefixed with "@" the component will interpret the value as a domain when constructing the message. This allows for sending directly to subdomains.

Note: The XMPP component will generate and return a unique identifier for each message sent. This identifier can be used to track messages in conjunction with various Jabber Extension Protocols.

SetReceiveStream Method (XMPP Component)

This method sets the stream to which the received file data will be written.

Syntax

• C#
• VB.NET

public void SetReceiveStream(System.IO.Stream receiveStream);

Async Version
public async Task SetReceiveStream(System.IO.Stream receiveStream);
public async Task SetReceiveStream(System.IO.Stream receiveStream, CancellationToken cancellationToken);

Public Sub SetReceiveStream(ByVal ReceiveStream As System.IO.Stream)

Async Version
Public Sub SetReceiveStream(ByVal ReceiveStream As System.IO.Stream) As Task
Public Sub SetReceiveStream(ByVal ReceiveStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

This method sets the stream to which the incoming file will be written. This can be set from within the StartTransfer event when a file is received.

The file data will be written to the stream. The stream should be open and normally set to position 0. The component will automatically close this stream if CloseStreamAfterTransfer is True (default). The downloaded content will be written starting at the current position in the stream.

If a download stream is set, the incoming file will not be written to LocalDirectory.

SetSendStream Method (XMPP Component)

This method sets the stream to be sent.

Syntax

• C#
• VB.NET

public void SetSendStream(System.IO.Stream sendStream, string fileName);

Async Version
public async Task SetSendStream(System.IO.Stream sendStream, string fileName);
public async Task SetSendStream(System.IO.Stream sendStream, string fileName, CancellationToken cancellationToken);

Public Sub SetSendStream(ByVal SendStream As System.IO.Stream, ByVal FileName As String)

Async Version
Public Sub SetSendStream(ByVal SendStream As System.IO.Stream, ByVal FileName As String) As Task
Public Sub SetSendStream(ByVal SendStream As System.IO.Stream, ByVal FileName As String, cancellationToken As CancellationToken) As Task

Remarks

This method sets the stream to be sent to the recipient. FileName specifies the name of the file. If an upload stream is set before the SendFile method is called, the content of the stream will be read by the component and sent. The stream should be open and normally set to position 0.

The component will automatically close this stream if CloseStreamAfterTransfer is True (default). If the stream is closed, you will need to call SetSendStream again before calling SendFile again.

The content of the stream will be read from the current position all the way to the end.

Note: SetSendStream and LocalFile will reset the other.

SetUserInfoField Method (XMPP Component)

This method will add a user information field for registration.

Syntax

• C#
• VB.NET

public void SetUserInfoField(string field, string value);

Async Version
public async Task SetUserInfoField(string field, string value);
public async Task SetUserInfoField(string field, string value, CancellationToken cancellationToken);

Public Sub SetUserInfoField(ByVal Field As String, ByVal Value As String)

Async Version
Public Sub SetUserInfoField(ByVal Field As String, ByVal Value As String) As Task
Public Sub SetUserInfoField(ByVal Field As String, ByVal Value As String, cancellationToken As CancellationToken) As Task

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 be 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 collection 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

• C#
• VB.NET

public void SubscribeTo(string jabberId);

Async Version
public async Task SubscribeTo(string jabberId);
public async Task SubscribeTo(string jabberId, CancellationToken cancellationToken);

Public Sub SubscribeTo(ByVal JabberId As String)

Async Version
Public Sub SubscribeTo(ByVal JabberId As String) As Task
Public Sub SubscribeTo(ByVal JabberId As String, cancellationToken As CancellationToken) As Task

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

• C#
• VB.NET

public void Unregister();

Async Version
public async Task Unregister();
public async Task Unregister(CancellationToken cancellationToken);

Public Sub Unregister()

Async Version
Public Sub Unregister() As Task
Public Sub Unregister(cancellationToken As CancellationToken) As Task

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

• C#
• VB.NET

public void UnsubscribeTo(string jabberId);

Async Version
public async Task UnsubscribeTo(string jabberId);
public async Task UnsubscribeTo(string jabberId, CancellationToken cancellationToken);

Public Sub UnsubscribeTo(ByVal JabberId As String)

Async Version
Public Sub UnsubscribeTo(ByVal JabberId As String) As Task
Public Sub UnsubscribeTo(ByVal JabberId As String, cancellationToken As CancellationToken) As Task

Remarks

This method will inform the server of the cancellation of a 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)

This method updates the buddy's associated groups.

Syntax

• C#
• VB.NET

public void UpdateBuddyGroup(int buddyIndex, string group);

Async Version
public async Task UpdateBuddyGroup(int buddyIndex, string group);
public async Task UpdateBuddyGroup(int buddyIndex, string group, CancellationToken cancellationToken);

Public Sub UpdateBuddyGroup(ByVal BuddyIndex As Integer, ByVal Group As String)

Async Version
Public Sub UpdateBuddyGroup(ByVal BuddyIndex As Integer, ByVal Group As String) As Task
Public Sub UpdateBuddyGroup(ByVal BuddyIndex As Integer, ByVal Group As String, cancellationToken As CancellationToken) As Task

Remarks

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

After the Sync event has fired, the Group field 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-separated list of groups the buddy should be associated with. Setting Group to an 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

• C#
• VB.NET

public event OnBuddyUpdateHandler OnBuddyUpdate;

public delegate void OnBuddyUpdateHandler(object sender, XMPPBuddyUpdateEventArgs e);

public class XMPPBuddyUpdateEventArgs : EventArgs {
  public int BuddyIdx { get; }
}

Public Event OnBuddyUpdate As OnBuddyUpdateHandler

Public Delegate Sub OnBuddyUpdateHandler(sender As Object, e As XMPPBuddyUpdateEventArgs)

Public Class XMPPBuddyUpdateEventArgs Inherits EventArgs
  Public ReadOnly Property BuddyIdx As Integer
End Class

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 collection property. The BuddyIdx parameter of this event will be the index of that XMPPBuddy in the collection.

Connected Event (XMPP Component)

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

Syntax

• C#
• VB.NET

public event OnConnectedHandler OnConnected;

public delegate void OnConnectedHandler(object sender, XMPPConnectedEventArgs e);

public class XMPPConnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnected As OnConnectedHandler

Public Delegate Sub OnConnectedHandler(sender As Object, e As XMPPConnectedEventArgs)

Public Class XMPPConnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

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 Transmission Control Protocol (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)

Fired to indicate changes in the connection state.

Syntax

• C#
• VB.NET

public event OnConnectionStatusHandler OnConnectionStatus;

public delegate void OnConnectionStatusHandler(object sender, XMPPConnectionStatusEventArgs e);

public class XMPPConnectionStatusEventArgs : EventArgs {
  public string ConnectionEvent { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnectionStatus As OnConnectionStatusHandler

Public Delegate Sub OnConnectionStatusHandler(sender As Object, e As XMPPConnectionStatusEventArgs)

Public Class XMPPConnectionStatusEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionEvent As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

This 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

• C#
• VB.NET

public event OnDisconnectedHandler OnDisconnected;

public delegate void OnDisconnectedHandler(object sender, XMPPDisconnectedEventArgs e);

public class XMPPDisconnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnDisconnected As OnDisconnectedHandler

Public Delegate Sub OnDisconnectedHandler(sender As Object, e As XMPPDisconnectedEventArgs)

Public Class XMPPDisconnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

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 Transmission Control Protocol (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)

This event is fired when a file transfer completes.

Syntax

• C#
• VB.NET

public event OnEndTransferHandler OnEndTransfer;

public delegate void OnEndTransferHandler(object sender, XMPPEndTransferEventArgs e);

public class XMPPEndTransferEventArgs : EventArgs {
  public int Direction { get; }
  public string FileId { get; }
  public string FileName { get; }
  public bool Success { get; }
}

Public Event OnEndTransfer As OnEndTransferHandler

Public Delegate Sub OnEndTransferHandler(sender As Object, e As XMPPEndTransferEventArgs)

Public Class XMPPEndTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property FileId As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property Success As Boolean
End Class

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

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, XMPPErrorEventArgs e);

public class XMPPErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As XMPPErrorEventArgs)

Public Class XMPPErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

This event 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

• C#
• VB.NET

public event OnIQHandler OnIQ;

public delegate void OnIQHandler(object sender, XMPPIQEventArgs e);

public class XMPPIQEventArgs : EventArgs {
  public string Iq { get; }
  public string Id { get; }
  public string From { get; }
  public string IqType { get; }
  public bool Ignore { get; set; }
}

Public Event OnIQ As OnIQHandler

Public Delegate Sub OnIQHandler(sender As Object, e As XMPPIQEventArgs)

Public Class XMPPIQEventArgs Inherits EventArgs
  Public ReadOnly Property Iq As String
  Public ReadOnly Property Id As String
  Public ReadOnly Property From As String
  Public ReadOnly Property IqType As String
  Public Property Ignore As Boolean
End Class

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 it 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

• C#
• VB.NET

public event OnMessageInHandler OnMessageIn;

public delegate void OnMessageInHandler(object sender, XMPPMessageInEventArgs e);

public class XMPPMessageInEventArgs : EventArgs {
  public string MessageId { get; }
  public string From { get; }
  public string Domain { get; }
  public string Resource { get; }
  public int MessageType { get; }
  public string Subject { get; }
  public string MessageThread { get; }
  public string MessageText { get; }
  public string MessageHTML { get; }
  public string Other { get; }
}

Public Event OnMessageIn As OnMessageInHandler

Public Delegate Sub OnMessageInHandler(sender As Object, e As XMPPMessageInEventArgs)

Public Class XMPPMessageInEventArgs Inherits EventArgs
  Public ReadOnly Property MessageId As String
  Public ReadOnly Property From As String
  Public ReadOnly Property Domain As String
  Public ReadOnly Property Resource As String
  Public ReadOnly Property MessageType As Integer
  Public ReadOnly Property Subject As String
  Public ReadOnly Property MessageThread As String
  Public ReadOnly Property MessageText As String
  Public ReadOnly Property MessageHTML As String
  Public ReadOnly Property Other As String
End Class

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 is the type of message received. See MessageType for a list of possible values. For a message of type "headline", Subject will reflect the subject of the message. For a message of type "chat", Thread will report the conversation thread for which the current message is a follow-up.

Other will contain 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

• C#
• VB.NET

public event OnPITrailHandler OnPITrail;

public delegate void OnPITrailHandler(object sender, XMPPPITrailEventArgs e);

public class XMPPPITrailEventArgs : EventArgs {
  public int Direction { get; }
  public string Pi { get; }
}

Public Event OnPITrail As OnPITrailHandler

Public Delegate Sub OnPITrailHandler(sender As Object, e As XMPPPITrailEventArgs)

Public Class XMPPPITrailEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property Pi As String
End Class

Remarks

The PITrail event is useful for debugging purposes. It shows all the interactions 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

• C#
• VB.NET

public event OnPresenceHandler OnPresence;

public delegate void OnPresenceHandler(object sender, XMPPPresenceEventArgs e);

public class XMPPPresenceEventArgs : EventArgs {
  public string User { get; }
  public string Domain { get; }
  public string Resource { get; }
  public int Availability { get; }
  public string Status { get; }
}

Public Event OnPresence As OnPresenceHandler

Public Delegate Sub OnPresenceHandler(sender As Object, e As XMPPPresenceEventArgs)

Public Class XMPPPresenceEventArgs Inherits EventArgs
  Public ReadOnly Property User As String
  Public ReadOnly Property Domain As String
  Public ReadOnly Property Resource As String
  Public ReadOnly Property Availability As Integer
  Public ReadOnly Property Status As String
End Class

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.

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

• C#
• VB.NET

public event OnReadyToSendHandler OnReadyToSend;

public delegate void OnReadyToSendHandler(object sender, XMPPReadyToSendEventArgs e);

public class XMPPReadyToSendEventArgs : EventArgs {
}

Public Event OnReadyToSend As OnReadyToSendHandler

Public Delegate Sub OnReadyToSendHandler(sender As Object, e As XMPPReadyToSendEventArgs)

Public Class XMPPReadyToSendEventArgs Inherits EventArgs
End Class

Remarks

The ReadyToSend event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed SendBytes. 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

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, XMPPSSLServerAuthenticationEventArgs e);

public class XMPPSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As XMPPSSLServerAuthenticationEventArgs)

Public Class XMPPSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

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)

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, XMPPSSLStatusEventArgs e);

public class XMPPSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As XMPPSSLStatusEventArgs)

Public Class XMPPSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

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

StartTransfer Event (XMPP Component)

This event is fired when a file transfer begins.

Syntax

• C#
• VB.NET

public event OnStartTransferHandler OnStartTransfer;

public delegate void OnStartTransferHandler(object sender, XMPPStartTransferEventArgs e);

public class XMPPStartTransferEventArgs : EventArgs {
  public int Direction { get; }
  public string FileId { get; }
  public string User { get; }
  public string Domain { get; }
  public string Resource { get; }
  public string FileName { get; set; }
  public string Datetime { get; }
  public long Size { get; }
  public bool Accept { get; set; }
}

Public Event OnStartTransfer As OnStartTransferHandler

Public Delegate Sub OnStartTransferHandler(sender As Object, e As XMPPStartTransferEventArgs)

Public Class XMPPStartTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property FileId As String
  Public ReadOnly Property User As String
  Public ReadOnly Property Domain As String
  Public ReadOnly Property Resource As String
  Public Property FileName As String
  Public ReadOnly Property Datetime As String
  Public ReadOnly Property Size As Long
  Public Property Accept As Boolean
End Class

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 or call SetReceiveStream.

When 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

• C#
• VB.NET

public event OnSubscriptionRequestHandler OnSubscriptionRequest;

public delegate void OnSubscriptionRequestHandler(object sender, XMPPSubscriptionRequestEventArgs e);

public class XMPPSubscriptionRequestEventArgs : EventArgs {
  public string From { get; }
  public string Domain { get; }
  public bool Accept { get; set; }
}

Public Event OnSubscriptionRequest As OnSubscriptionRequestHandler

Public Delegate Sub OnSubscriptionRequestHandler(sender As Object, e As XMPPSubscriptionRequestEventArgs)

Public Class XMPPSubscriptionRequestEventArgs Inherits EventArgs
  Public ReadOnly Property From As String
  Public ReadOnly Property Domain As String
  Public Property Accept As Boolean
End Class

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. It is not necessary to know which resource sent the request, because 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

• C#
• VB.NET

public event OnSyncHandler OnSync;

public delegate void OnSyncHandler(object sender, XMPPSyncEventArgs e);

public class XMPPSyncEventArgs : EventArgs {
}

Public Event OnSync As OnSyncHandler

Public Delegate Sub OnSyncHandler(sender As Object, e As XMPPSyncEventArgs)

Public Class XMPPSyncEventArgs Inherits EventArgs
End Class

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 collection will be filled out accordingly:

Note: Please refer to Buddies collection property for more information.

Transfer Event (XMPP Component)

This event is fired during file transfer.

Syntax

• C#
• VB.NET

public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, XMPPTransferEventArgs e);

public class XMPPTransferEventArgs : EventArgs {
  public int Direction { get; }
  public string FileId { get; }
  public string FileName { get; }
  public long BytesTransferred { get; }
  public int PercentDone { get; }
  public string Text { get; }
  public byte[] TextB { get; }
  public bool Cancel { get; set; }
}

Public Event OnTransfer As OnTransferHandler

Public Delegate Sub OnTransferHandler(sender As Object, e As XMPPTransferEventArgs)

Public Class XMPPTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property FileId As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property PercentDone As Integer
  Public ReadOnly Property Text As String
  Public ReadOnly Property TextB As Byte()
  Public Property Cancel As Boolean
End Class

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 cannot 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.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

• C#
• VB.NET

public Certificate(byte[] encoded);

Public Certificate(ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

• C#
• VB.NET

public Firewall();

Public Firewall()

XMPPBuddy Type

This type describes a buddy in the XMPP buddy list.

Remarks

This type describes a buddy in the user's buddy list. Each buddy in the list has certain properties associated with it, such as names and Id.

Fields

Constructors

• C#
• VB.NET

public XMPPBuddy();

Public XMPPBuddy()

XMPPUserInfo Type

This type describes a named registration field.

Remarks

This type describes the user information that must be sent to the server during registration.

Fields

Constructors

• C#
• VB.NET

public XMPPUserInfo();

Public XMPPUserInfo()

• C#
• VB.NET

public XMPPUserInfo(string field, string value);

Public XMPPUserInfo(ByVal Field As String, ByVal Value As String)

Config Settings (XMPP Component)

XMPP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket 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