XMPP Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

XMPP

Remarks

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

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

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

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

Example (Connecting and Sending a Message)

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

Method List

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

Event List

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

Config Settings

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

AuthDomain Property (XMPP Class)

The domain under which the user will be authenticated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthDomain();
int SetAuthDomain(const char* lpszAuthDomain);

Unicode (Windows)
LPWSTR GetAuthDomain();
INT SetAuthDomain(LPCWSTR lpszAuthDomain);

char* ipworks_xmpp_getauthdomain(void* lpObj);
int ipworks_xmpp_setauthdomain(void* lpObj, const char* lpszAuthDomain);

QString GetAuthDomain();
int SetAuthDomain(QString qsAuthDomain);

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 Class)

Controls how the class authenticates itself with the XMPP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthMethods();
int SetAuthMethods(const char* lpszAuthMethods);

Unicode (Windows)
LPWSTR GetAuthMethods();
INT SetAuthMethods(LPCWSTR lpszAuthMethods);

char* ipworks_xmpp_getauthmethods(void* lpObj);
int ipworks_xmpp_setauthmethods(void* lpObj, const char* lpszAuthMethods);

QString GetAuthMethods();
int SetAuthMethods(QString qsAuthMethods);

Default Value

"*"

Remarks

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

The special value * (default) may be supplied to cause the class to enable all supported authentication methods in order of presumed security. The XMPP class 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 Class)

The number of records in the Buddy arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBuddyCount();

Unicode (Windows)
INT GetBuddyCount();

int ipworks_xmpp_getbuddycount(void* lpObj);

int GetBuddyCount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBuddyGroup(int iBuddyIndex);
int SetBuddyGroup(int iBuddyIndex, const char* lpszBuddyGroup);

Unicode (Windows)
LPWSTR GetBuddyGroup(INT iBuddyIndex);
INT SetBuddyGroup(INT iBuddyIndex, LPCWSTR lpszBuddyGroup);

char* ipworks_xmpp_getbuddygroup(void* lpObj, int buddyindex);
int ipworks_xmpp_setbuddygroup(void* lpObj, int buddyindex, const char* lpszBuddyGroup);

QString GetBuddyGroup(int iBuddyIndex);
int SetBuddyGroup(int iBuddyIndex, QString qsBuddyGroup);

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 Class)

This is the jabber id of the buddy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBuddyId(int iBuddyIndex);

Unicode (Windows)
LPWSTR GetBuddyId(INT iBuddyIndex);

char* ipworks_xmpp_getbuddyid(void* lpObj, int buddyindex);

QString GetBuddyId(int iBuddyIndex);

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 Class)

The nickname of the buddy, if one exists.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBuddyNickName(int iBuddyIndex);
int SetBuddyNickName(int iBuddyIndex, const char* lpszBuddyNickName);

Unicode (Windows)
LPWSTR GetBuddyNickName(INT iBuddyIndex);
INT SetBuddyNickName(INT iBuddyIndex, LPCWSTR lpszBuddyNickName);

char* ipworks_xmpp_getbuddynickname(void* lpObj, int buddyindex);
int ipworks_xmpp_setbuddynickname(void* lpObj, int buddyindex, const char* lpszBuddyNickName);

QString GetBuddyNickName(int iBuddyIndex);
int SetBuddyNickName(int iBuddyIndex, QString qsBuddyNickName);

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 Class)

The real name of the buddy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBuddyRealName(int iBuddyIndex);

Unicode (Windows)
LPWSTR GetBuddyRealName(INT iBuddyIndex);

char* ipworks_xmpp_getbuddyrealname(void* lpObj, int buddyindex);

QString GetBuddyRealName(int iBuddyIndex);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBuddySubscription(int iBuddyIndex);

Unicode (Windows)
INT GetBuddySubscription(INT iBuddyIndex);

ST_NONE(0), 
ST_TO(1), 
ST_FROM(2), 
ST_BOTH(3), 
ST_REMOVE(4)

int ipworks_xmpp_getbuddysubscription(void* lpObj, int buddyindex);

int GetBuddySubscription(int iBuddyIndex);

Default Value

0

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 Class)

This indicates the class's login status.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();
int SetConnected(int bConnected);

Unicode (Windows)
BOOL GetConnected();
INT SetConnected(BOOL bConnected);

int ipworks_xmpp_getconnected(void* lpObj);
int ipworks_xmpp_setconnected(void* lpObj, int bConnected);

bool GetConnected();
int SetConnected(bool bConnected);

Default Value

FALSE

Remarks

This value shows whether or not the class 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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int ipworks_xmpp_getfirewallautodetect(void* lpObj);
int ipworks_xmpp_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

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

Data Type

Boolean

FirewallType Property (XMPP Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int ipworks_xmpp_getfirewalltype(void* lpObj);
int ipworks_xmpp_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (XMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* ipworks_xmpp_getfirewallhost(void* lpObj);
int ipworks_xmpp_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

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 class fails with an error.

Data Type

String

FirewallPassword Property (XMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* ipworks_xmpp_getfirewallpassword(void* lpObj);
int ipworks_xmpp_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

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 class fails with an error.

Data Type

String

FirewallPort Property (XMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int ipworks_xmpp_getfirewallport(void* lpObj);
int ipworks_xmpp_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* ipworks_xmpp_getfirewalluser(void* lpObj);
int ipworks_xmpp_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

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 class fails with an error.

Data Type

String

IMPort Property (XMPP Class)

The server port for XMPP (default 5222).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIMPort();
int SetIMPort(int iIMPort);

Unicode (Windows)
INT GetIMPort();
INT SetIMPort(INT iIMPort);

int ipworks_xmpp_getimport(void* lpObj);
int ipworks_xmpp_setimport(void* lpObj, int iIMPort);

int GetIMPort();
int SetIMPort(int iIMPort);

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 Class)

This is the instant messaging server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIMServer();
int SetIMServer(const char* lpszIMServer);

Unicode (Windows)
LPWSTR GetIMServer();
INT SetIMServer(LPCWSTR lpszIMServer);

char* ipworks_xmpp_getimserver(void* lpObj);
int ipworks_xmpp_setimserver(void* lpObj, const char* lpszIMServer);

QString GetIMServer();
int SetIMServer(QString qsIMServer);

Default Value

""

Remarks

This is the instant messaging server to which the class 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 Class)

The directory to which received files are saved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalDirectory();
int SetLocalDirectory(const char* lpszLocalDirectory);

Unicode (Windows)
LPWSTR GetLocalDirectory();
INT SetLocalDirectory(LPCWSTR lpszLocalDirectory);

char* ipworks_xmpp_getlocaldirectory(void* lpObj);
int ipworks_xmpp_setlocaldirectory(void* lpObj, const char* lpszLocalDirectory);

QString GetLocalDirectory();
int SetLocalDirectory(QString qsLocalDirectory);

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 Class)

The path to the file that will be sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalFile();
int SetLocalFile(const char* lpszLocalFile);

Unicode (Windows)
LPWSTR GetLocalFile();
INT SetLocalFile(LPCWSTR lpszLocalFile);

char* ipworks_xmpp_getlocalfile(void* lpObj);
int ipworks_xmpp_setlocalfile(void* lpObj, const char* lpszLocalFile);

QString GetLocalFile();
int SetLocalFile(QString qsLocalFile);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworks_xmpp_getlocalhost(void* lpObj);
int ipworks_xmpp_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

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 class initiate connections (or accept in the case of server classs) only through that interface.

If the class 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 Class)

This is the HTML version of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageHTML();
int SetMessageHTML(const char* lpszMessageHTML);

Unicode (Windows)
LPWSTR GetMessageHTML();
INT SetMessageHTML(LPCWSTR lpszMessageHTML);

char* ipworks_xmpp_getmessagehtml(void* lpObj);
int ipworks_xmpp_setmessagehtml(void* lpObj, const char* lpszMessageHTML);

QString GetMessageHTML();
int SetMessageHTML(QString qsMessageHTML);

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 class will fail with an error.

This property is not available at design time.

Data Type

String

MessageOtherData Property (XMPP Class)

This property contains extra data elements for the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageOtherData();
int SetMessageOtherData(const char* lpszMessageOtherData);

Unicode (Windows)
LPWSTR GetMessageOtherData();
INT SetMessageOtherData(LPCWSTR lpszMessageOtherData);

char* ipworks_xmpp_getmessageotherdata(void* lpObj);
int ipworks_xmpp_setmessageotherdata(void* lpObj, const char* lpszMessageOtherData);

QString GetMessageOtherData();
int SetMessageOtherData(QString qsMessageOtherData);

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 Class)

This is the subject of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageSubject();
int SetMessageSubject(const char* lpszMessageSubject);

Unicode (Windows)
LPWSTR GetMessageSubject();
INT SetMessageSubject(LPCWSTR lpszMessageSubject);

char* ipworks_xmpp_getmessagesubject(void* lpObj);
int ipworks_xmpp_setmessagesubject(void* lpObj, const char* lpszMessageSubject);

QString GetMessageSubject();
int SetMessageSubject(QString qsMessageSubject);

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 Class)

This is the plain text of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageText();
int SetMessageText(const char* lpszMessageText);

Unicode (Windows)
LPWSTR GetMessageText();
INT SetMessageText(LPCWSTR lpszMessageText);

char* ipworks_xmpp_getmessagetext(void* lpObj);
int ipworks_xmpp_setmessagetext(void* lpObj, const char* lpszMessageText);

QString GetMessageText();
int SetMessageText(QString qsMessageText);

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 Class)

This is the thread name of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageThread();
int SetMessageThread(const char* lpszMessageThread);

Unicode (Windows)
LPWSTR GetMessageThread();
INT SetMessageThread(LPCWSTR lpszMessageThread);

char* ipworks_xmpp_getmessagethread(void* lpObj);
int ipworks_xmpp_setmessagethread(void* lpObj, const char* lpszMessageThread);

QString GetMessageThread();
int SetMessageThread(QString qsMessageThread);

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 Class)

This is the type of the current message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageType();
int SetMessageType(int iMessageType);

Unicode (Windows)
INT GetMessageType();
INT SetMessageType(INT iMessageType);

JMT_NORMAL(0), 
JMT_CHAT(1), 
JMT_GROUP_CHAT(2), 
JMT_HEADLINE(3), 
JMT_ERROR(4)

int ipworks_xmpp_getmessagetype(void* lpObj);
int ipworks_xmpp_setmessagetype(void* lpObj, int iMessageType);

int GetMessageType();
int SetMessageType(int iMessageType);

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.

Data Type

Integer

Password Property (XMPP Class)

This is the user's password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworks_xmpp_getpassword(void* lpObj);
int ipworks_xmpp_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

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 Class)

This is the availability of the entity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPresence();
int SetPresence(int iPresence);

Unicode (Windows)
INT GetPresence();
INT SetPresence(INT iPresence);

PC_OFFLINE(0), 
PC_CHAT(1), 
PC_AWAY(2), 
PC_XA(3), 
PC_DND(4)

int ipworks_xmpp_getpresence(void* lpObj);
int ipworks_xmpp_setpresence(void* lpObj, int iPresence);

int GetPresence();
int SetPresence(int iPresence);

Default Value

1

Remarks

When the class 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 class sets the client presence to pcChat, meaning that the user is available. To change the initial status sent by the class 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 class 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 Class)

This is the resource for the current session.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResource();
int SetResource(const char* lpszResource);

Unicode (Windows)
LPWSTR GetResource();
INT SetResource(LPCWSTR lpszResource);

char* ipworks_xmpp_getresource(void* lpObj);
int ipworks_xmpp_setresource(void* lpObj, const char* lpszResource);

QString GetResource();
int SetResource(QString qsResource);

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 Class)

The XMPP server's domain.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerDomain();
int SetServerDomain(const char* lpszServerDomain);

Unicode (Windows)
LPWSTR GetServerDomain();
INT SetServerDomain(LPCWSTR lpszServerDomain);

char* ipworks_xmpp_getserverdomain(void* lpObj);
int ipworks_xmpp_setserverdomain(void* lpObj, const char* lpszServerDomain);

QString GetServerDomain();
int SetServerDomain(QString qsServerDomain);

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 Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int ipworks_xmpp_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworks_xmpp_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

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

Binary String

SSLCertEncoded Property (XMPP Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int ipworks_xmpp_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworks_xmpp_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

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

Binary String

SSLCertStore Property (XMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int ipworks_xmpp_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworks_xmpp_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

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

Binary String

SSLCertStorePassword Property (XMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* ipworks_xmpp_getsslcertstorepassword(void* lpObj);
int ipworks_xmpp_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

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 Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworks_xmpp_getsslcertstoretype(void* lpObj);
int ipworks_xmpp_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (XMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* ipworks_xmpp_getsslcertsubject(void* lpObj);
int ipworks_xmpp_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

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 Class)

Whether TLS/SSL is enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLEnabled();
int SetSSLEnabled(int bSSLEnabled);

Unicode (Windows)
BOOL GetSSLEnabled();
INT SetSSLEnabled(BOOL bSSLEnabled);

int ipworks_xmpp_getsslenabled(void* lpObj);
int ipworks_xmpp_setsslenabled(void* lpObj, int bSSLEnabled);

bool GetSSLEnabled();
int SetSSLEnabled(bool bSSLEnabled);

Default Value

FALSE

Remarks

This setting specifies whether TLS/SSL is enabled in the class. When False (default) the class 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 Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworks_xmpp_getsslprovider(void* lpObj);
int ipworks_xmpp_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

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 class 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 class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (XMPP Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int ipworks_xmpp_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

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

Binary String

SSLStartMode Property (XMPP Class)

Determines how the class starts the SSL negotiation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Unicode (Windows)
INT GetSSLStartMode();
INT SetSSLStartMode(INT iSSLStartMode);

SSL_AUTOMATIC(0), 
SSL_IMPLICIT(1), 
SSL_EXPLICIT(2), 
SSL_NONE(3)

int ipworks_xmpp_getsslstartmode(void* lpObj);
int ipworks_xmpp_setsslstartmode(void* lpObj, int iSSLStartMode);

int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

Status Property (XMPP Class)

Description of the availability of this entity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetStatus();
int SetStatus(const char* lpszStatus);

Unicode (Windows)
LPWSTR GetStatus();
INT SetStatus(LPCWSTR lpszStatus);

char* ipworks_xmpp_getstatus(void* lpObj);
int ipworks_xmpp_setstatus(void* lpObj, const char* lpszStatus);

QString GetStatus();
int SetStatus(QString qsStatus);

Default Value

"Available for Chat."

Remarks

When the class 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 class sets the client presence to pcChat, meaning that the user is available. To change the initial status sent by the class 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 class 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 Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworks_xmpp_gettimeout(void* lpObj);
int ipworks_xmpp_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

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 class will wait for the operation to complete before returning control.

The class 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 class fails with an error.

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 Class)

The user portion of this entity's Jabber ID.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* ipworks_xmpp_getuser(void* lpObj);
int ipworks_xmpp_setuser(void* lpObj, const char* lpszUser);

QString GetUser();
int SetUser(QString qsUser);

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 Class)

Gets or sets the domain value used for Jabber IDs.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDomain();
int SetUserDomain(const char* lpszUserDomain);

Unicode (Windows)
LPWSTR GetUserDomain();
INT SetUserDomain(LPCWSTR lpszUserDomain);

char* ipworks_xmpp_getuserdomain(void* lpObj);
int ipworks_xmpp_setuserdomain(void* lpObj, const char* lpszUserDomain);

QString GetUserDomain();
int SetUserDomain(QString qsUserDomain);

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 Class)

The number of records in the UserInfo arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserInfoCount();
int SetUserInfoCount(int iUserInfoCount);

Unicode (Windows)
INT GetUserInfoCount();
INT SetUserInfoCount(INT iUserInfoCount);

int ipworks_xmpp_getuserinfocount(void* lpObj);
int ipworks_xmpp_setuserinfocount(void* lpObj, int iUserInfoCount);

int GetUserInfoCount();
int SetUserInfoCount(int iUserInfoCount);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserInfoField(int iFieldIndex);
int SetUserInfoField(int iFieldIndex, const char* lpszUserInfoField);

Unicode (Windows)
LPWSTR GetUserInfoField(INT iFieldIndex);
INT SetUserInfoField(INT iFieldIndex, LPCWSTR lpszUserInfoField);

char* ipworks_xmpp_getuserinfofield(void* lpObj, int fieldindex);
int ipworks_xmpp_setuserinfofield(void* lpObj, int fieldindex, const char* lpszUserInfoField);

QString GetUserInfoField(int iFieldIndex);
int SetUserInfoField(int iFieldIndex, QString qsUserInfoField);

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 class 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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserInfoValue(int iFieldIndex);
int SetUserInfoValue(int iFieldIndex, const char* lpszUserInfoValue);

Unicode (Windows)
LPWSTR GetUserInfoValue(INT iFieldIndex);
INT SetUserInfoValue(INT iFieldIndex, LPCWSTR lpszUserInfoValue);

char* ipworks_xmpp_getuserinfovalue(void* lpObj, int fieldindex);
int ipworks_xmpp_setuserinfovalue(void* lpObj, int fieldindex, const char* lpszUserInfoValue);

QString GetUserInfoValue(int iFieldIndex);
int SetUserInfoValue(int iFieldIndex, QString qsUserInfoValue);

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 class 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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Add(const char* lpszJabberId, const char* lpszName, const char* lpszGroups);

Unicode (Windows)
INT Add(LPCWSTR lpszJabberId, LPCWSTR lpszName, LPCWSTR lpszGroups);

int ipworks_xmpp_add(void* lpObj, const char* lpszJabberId, const char* lpszName, const char* lpszGroups);

int Add(const QString& qsJabberId, const QString& qsName, const QString& qsGroups);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Cancel Method (XMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Cancel(const char* lpszJabberId);

Unicode (Windows)
INT Cancel(LPCWSTR lpszJabberId);

int ipworks_xmpp_cancel(void* lpObj, const char* lpszJabberId);

int Cancel(const QString& qsJabberId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ChangePassword Method (XMPP Class)

This method will change the current user's password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ChangePassword(const char* lpszPassword);

Unicode (Windows)
INT ChangePassword(LPCWSTR lpszPassword);

int ipworks_xmpp_changepassword(void* lpObj, const char* lpszPassword);

int ChangePassword(const QString& qsPassword);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ChangePresence Method (XMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ChangePresence(int iPresenceCode, const char* lpszStatus);

Unicode (Windows)
INT ChangePresence(INT iPresenceCode, LPCWSTR lpszStatus);

int ipworks_xmpp_changepresence(void* lpObj, int iPresenceCode, const char* lpszStatus);

int ChangePresence(int iPresenceCode, const QString& qsStatus);

Remarks

PresenceCode should correspond the possible values of the Presence property:

By default, the class sets the client presence to pcChat, meaning that the user is available. To change the initial status sent by the class 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 "".

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (XMPP Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworks_xmpp_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Connect Method (XMPP Class)

This method will connect the class to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworks_xmpp_connect(void* lpObj);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ConnectTo Method (XMPP Class)

This method will connect the class to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ConnectTo(const char* lpszUser, const char* lpszPassword);

Unicode (Windows)
INT ConnectTo(LPCWSTR lpszUser, LPCWSTR lpszPassword);

int ipworks_xmpp_connectto(void* lpObj, const char* lpszUser, const char* lpszPassword);

int ConnectTo(const QString& qsUser, const QString& qsPassword);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Disconnect Method (XMPP Class)

This method disconnects the class from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworks_xmpp_disconnect(void* lpObj);

int Disconnect();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoEvents Method (XMPP Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworks_xmpp_doevents(void* lpObj);

int DoEvents();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (XMPP Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworks_xmpp_interrupt(void* lpObj);

int Interrupt();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ProbePresence Method (XMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ProbePresence(const char* lpszJabberId);

Unicode (Windows)
INT ProbePresence(LPCWSTR lpszJabberId);

int ipworks_xmpp_probepresence(void* lpObj, const char* lpszJabberId);

int ProbePresence(const QString& qsJabberId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

QueryRegister Method (XMPP Class)

This method queries a server for the necessary registration fields.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int QueryRegister(const char* lpszXMPPServer);

Unicode (Windows)
INT QueryRegister(LPCWSTR lpszXMPPServer);

int ipworks_xmpp_queryregister(void* lpObj, const char* lpszXMPPServer);

int QueryRegister(const QString& qsXMPPServer);

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 class is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Register Method (XMPP Class)

This method registers an account with a server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Register(const char* lpszXMPPServer);

Unicode (Windows)
INT Register(LPCWSTR lpszXMPPServer);

int ipworks_xmpp_register(void* lpObj, const char* lpszXMPPServer);

int Register(const QString& qsXMPPServer);

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 class 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 class is logged into the host under an existing account.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Remove Method (XMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Remove(const char* lpszJabberId, const char* lpszName, const char* lpszGroup);

Unicode (Windows)
INT Remove(LPCWSTR lpszJabberId, LPCWSTR lpszName, LPCWSTR lpszGroup);

int ipworks_xmpp_remove(void* lpObj, const char* lpszJabberId, const char* lpszName, const char* lpszGroup);

int Remove(const QString& qsJabberId, const QString& qsName, const QString& qsGroup);

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 class 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 class's internally stored list.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (XMPP Class)

Reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworks_xmpp_reset(void* lpObj);

int Reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RetrieveRoster Method (XMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RetrieveRoster();

Unicode (Windows)
INT RetrieveRoster();

int ipworks_xmpp_retrieveroster(void* lpObj);

int RetrieveRoster();

Remarks

After the class 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 class 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendCommand Method (XMPP Class)

This method sends a command to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendCommand(const char* lpszCommand);

Unicode (Windows)
INT SendCommand(LPCWSTR lpszCommand);

int ipworks_xmpp_sendcommand(void* lpObj, const char* lpszCommand);

int SendCommand(const QString& qsCommand);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendFile Method (XMPP Class)

Sends a file to the specified user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendFile(const char* lpszJabberId);

Unicode (Windows)
INT SendFile(LPCWSTR lpszJabberId);

int ipworks_xmpp_sendfile(void* lpObj, const char* lpszJabberId);

int SendFile(const QString& qsJabberId);

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 class supports sending files using In-Band Bystestreams as defined in XEP-0047 and XEP-0096.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendMessage Method (XMPP Class)

This method will send a message to the specified user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* SendMessage(const char* lpszJabberId);

Unicode (Windows)
LPWSTR SendMessage(LPCWSTR lpszJabberId);

char* ipworks_xmpp_sendmessage(void* lpObj, const char* lpszJabberId);

QString SendMessage(const QString& qsJabberId);

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 class associates several properties with messages it receives and sends. When it receives a message, the class will parse out the corresponding values and set these properties before firing a MessageIn event. After the event returns control to the class, the properties will be cleared (ie, 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 class will send only properties with non-empty 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 sub-domains.

Note: the XMPP class 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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SetUserInfoField Method (XMPP Class)

This method will add a user information field for registration.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetUserInfoField(const char* lpszField, const char* lpszValue);

Unicode (Windows)
INT SetUserInfoField(LPCWSTR lpszField, LPCWSTR lpszValue);

int ipworks_xmpp_setuserinfofield(void* lpObj, const char* lpszField, const char* lpszValue);

int SetUserInfoField(const QString& qsField, const QString& qsValue);

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 class is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SubscribeTo Method (XMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SubscribeTo(const char* lpszJabberId);

Unicode (Windows)
INT SubscribeTo(LPCWSTR lpszJabberId);

int ipworks_xmpp_subscribeto(void* lpObj, const char* lpszJabberId);

int SubscribeTo(const QString& qsJabberId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Unregister Method (XMPP Class)

This method cancels an account with the host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Unregister();

Unicode (Windows)
INT Unregister();

int ipworks_xmpp_unregister(void* lpObj);

int 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 class will be logged off the server, but not disconnected.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UnsubscribeTo Method (XMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UnsubscribeTo(const char* lpszJabberId);

Unicode (Windows)
INT UnsubscribeTo(LPCWSTR lpszJabberId);

int ipworks_xmpp_unsubscribeto(void* lpObj, const char* lpszJabberId);

int UnsubscribeTo(const QString& qsJabberId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateBuddyGroup Method (XMPP Class)

Updates the buddy's associatd groups.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateBuddyGroup(int iBuddyIndex, const char* lpszGroup);

Unicode (Windows)
INT UpdateBuddyGroup(INT iBuddyIndex, LPCWSTR lpszGroup);

int ipworks_xmpp_updatebuddygroup(void* lpObj, int iBuddyIndex, const char* lpszGroup);

int UpdateBuddyGroup(int iBuddyIndex, const QString& qsGroup);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

BuddyUpdate Event (XMPP Class)

This event is fired whenever a roster entry is updated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireBuddyUpdate(XMPPBuddyUpdateEventParams *e);

typedef struct {
  int BuddyIdx;
  int reserved;
} XMPPBuddyUpdateEventParams;


Unicode (Windows)
virtual INT FireBuddyUpdate(XMPPBuddyUpdateEventParams *e);

typedef struct {
  INT BuddyIdx;
  INT reserved;
} XMPPBuddyUpdateEventParams;

#define EID_XMPP_BUDDYUPDATE 1

virtual INT IPWORKS_CALL FireBuddyUpdate(INT &iBuddyIdx);

class XMPPBuddyUpdateEventParams {
public:
  int BuddyIdx();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void BuddyUpdate(XMPPBuddyUpdateEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireBuddyUpdate(XMPPBuddyUpdateEventParams *e) {...}

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(XMPPConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} XMPPConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(XMPPConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} XMPPConnectedEventParams;

#define EID_XMPP_CONNECTED 2

virtual INT IPWORKS_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class XMPPConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(XMPPConnectedEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireConnected(XMPPConnectedEventParams *e) {...}

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(XMPPConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} XMPPConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(XMPPConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} XMPPConnectionStatusEventParams;

#define EID_XMPP_CONNECTIONSTATUS 3

virtual INT IPWORKS_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class XMPPConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionStatus(XMPPConnectionStatusEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireConnectionStatus(XMPPConnectionStatusEventParams *e) {...}

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(XMPPDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} XMPPDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(XMPPDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} XMPPDisconnectedEventParams;

#define EID_XMPP_DISCONNECTED 4

virtual INT IPWORKS_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class XMPPDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(XMPPDisconnectedEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireDisconnected(XMPPDisconnectedEventParams *e) {...}

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 Class)

Fired when a file transfer completes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(XMPPEndTransferEventParams *e);

typedef struct {
  int Direction;
  const char *FileId;
  const char *Filename;
  int Success;
  int reserved;
} XMPPEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(XMPPEndTransferEventParams *e);

typedef struct {
  INT Direction;
  LPCWSTR FileId;
  LPCWSTR Filename;
  BOOL Success;
  INT reserved;
} XMPPEndTransferEventParams;

#define EID_XMPP_ENDTRANSFER 5

virtual INT IPWORKS_CALL FireEndTransfer(INT &iDirection, LPSTR &lpszFileId, LPSTR &lpszFilename, BOOL &bSuccess);

class XMPPEndTransferEventParams {
public:
  int Direction();

  const QString &FileId();

  const QString &Filename();

  bool Success();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(XMPPEndTransferEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireEndTransfer(XMPPEndTransferEventParams *e) {...}

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(XMPPErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} XMPPErrorEventParams;


Unicode (Windows)
virtual INT FireError(XMPPErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} XMPPErrorEventParams;

#define EID_XMPP_ERROR 6

virtual INT IPWORKS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class XMPPErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(XMPPErrorEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireError(XMPPErrorEventParams *e) {...}

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 class's interpretation of the code.

IQ Event (XMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireIQ(XMPPIQEventParams *e);

typedef struct {
  const char *Iq;
  const char *Id;
  const char *From;
  const char *IqType;
  int Ignore;
  int reserved;
} XMPPIQEventParams;


Unicode (Windows)
virtual INT FireIQ(XMPPIQEventParams *e);

typedef struct {
  LPCWSTR Iq;
  LPCWSTR Id;
  LPCWSTR From;
  LPCWSTR IqType;
  BOOL Ignore;
  INT reserved;
} XMPPIQEventParams;

#define EID_XMPP_IQ 7

virtual INT IPWORKS_CALL FireIQ(LPSTR &lpszIq, LPSTR &lpszId, LPSTR &lpszFrom, LPSTR &lpszIqType, BOOL &bIgnore);

class XMPPIQEventParams {
public:
  const QString &Iq();

  const QString &Id();

  const QString &From();

  const QString &IqType();

  bool Ignore();
  void SetIgnore(bool bIgnore);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void IQ(XMPPIQEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireIQ(XMPPIQEventParams *e) {...}

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 Class)

This event is fired upon receipt of a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMessageIn(XMPPMessageInEventParams *e);

typedef struct {
  const char *MessageId;
  const char *From;
  const char *Domain;
  const char *Resource;
  int MessageType;
  const char *Subject;
  const char *MessageThread;
  const char *MessageText;
  const char *MessageHTML;
  const char *Other;
  int reserved;
} XMPPMessageInEventParams;


Unicode (Windows)
virtual INT FireMessageIn(XMPPMessageInEventParams *e);

typedef struct {
  LPCWSTR MessageId;
  LPCWSTR From;
  LPCWSTR Domain;
  LPCWSTR Resource;
  INT MessageType;
  LPCWSTR Subject;
  LPCWSTR MessageThread;
  LPCWSTR MessageText;
  LPCWSTR MessageHTML;
  LPCWSTR Other;
  INT reserved;
} XMPPMessageInEventParams;

#define EID_XMPP_MESSAGEIN 8

virtual INT IPWORKS_CALL FireMessageIn(LPSTR &lpszMessageId, LPSTR &lpszFrom, LPSTR &lpszDomain, LPSTR &lpszResource, INT &iMessageType, LPSTR &lpszSubject, LPSTR &lpszMessageThread, LPSTR &lpszMessageText, LPSTR &lpszMessageHTML, LPSTR &lpszOther);

class XMPPMessageInEventParams {
public:
  const QString &MessageId();

  const QString &From();

  const QString &Domain();

  const QString &Resource();

  int MessageType();

  const QString &Subject();

  const QString &MessageThread();

  const QString &MessageText();

  const QString &MessageHTML();

  const QString &Other();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void MessageIn(XMPPMessageInEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireMessageIn(XMPPMessageInEventParams *e) {...}

Remarks

When a message is received, the XMPP class 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 Class)

This event is fired for all protocol messages.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePITrail(XMPPPITrailEventParams *e);

typedef struct {
  int Direction;
  const char *Pi;
  int reserved;
} XMPPPITrailEventParams;


Unicode (Windows)
virtual INT FirePITrail(XMPPPITrailEventParams *e);

typedef struct {
  INT Direction;
  LPCWSTR Pi;
  INT reserved;
} XMPPPITrailEventParams;

#define EID_XMPP_PITRAIL 9

virtual INT IPWORKS_CALL FirePITrail(INT &iDirection, LPSTR &lpszPi);

class XMPPPITrailEventParams {
public:
  int Direction();

  const QString &Pi();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PITrail(XMPPPITrailEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FirePITrail(XMPPPITrailEventParams *e) {...}

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePresence(XMPPPresenceEventParams *e);

typedef struct {
  const char *User;
  const char *Domain;
  const char *Resource;
  int Availability;
  const char *Status;
  int reserved;
} XMPPPresenceEventParams;


Unicode (Windows)
virtual INT FirePresence(XMPPPresenceEventParams *e);

typedef struct {
  LPCWSTR User;
  LPCWSTR Domain;
  LPCWSTR Resource;
  INT Availability;
  LPCWSTR Status;
  INT reserved;
} XMPPPresenceEventParams;

#define EID_XMPP_PRESENCE 10

virtual INT IPWORKS_CALL FirePresence(LPSTR &lpszUser, LPSTR &lpszDomain, LPSTR &lpszResource, INT &iAvailability, LPSTR &lpszStatus);

class XMPPPresenceEventParams {
public:
  const QString &User();

  const QString &Domain();

  const QString &Resource();

  int Availability();

  const QString &Status();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Presence(XMPPPresenceEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FirePresence(XMPPPresenceEventParams *e) {...}

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 class 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 class, with the same possible values:

By default, the class sets the client presence to pcChat, meaning that the user is available. To change the initial status sent by the class 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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireReadyToSend(XMPPReadyToSendEventParams *e);

typedef struct {
  int reserved;
} XMPPReadyToSendEventParams;


Unicode (Windows)
virtual INT FireReadyToSend(XMPPReadyToSendEventParams *e);

typedef struct {
  INT reserved;
} XMPPReadyToSendEventParams;

#define EID_XMPP_READYTOSEND 11

virtual INT IPWORKS_CALL FireReadyToSend();

class XMPPReadyToSendEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ReadyToSend(XMPPReadyToSendEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireReadyToSend(XMPPReadyToSendEventParams *e) {...}

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 Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(XMPPSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} XMPPSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(XMPPSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} XMPPSSLServerAuthenticationEventParams;

#define EID_XMPP_SSLSERVERAUTHENTICATION 12

virtual INT IPWORKS_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class XMPPSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(XMPPSSLServerAuthenticationEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireSSLServerAuthentication(XMPPSSLServerAuthenticationEventParams *e) {...}

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 Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(XMPPSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} XMPPSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(XMPPSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} XMPPSSLStatusEventParams;

#define EID_XMPP_SSLSTATUS 13

virtual INT IPWORKS_CALL FireSSLStatus(LPSTR &lpszMessage);

class XMPPSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(XMPPSSLStatusEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireSSLStatus(XMPPSSLStatusEventParams *e) {...}

Remarks

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

StartTransfer Event (XMPP Class)

Fired when a file transfer begins.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartTransfer(XMPPStartTransferEventParams *e);

typedef struct {
  int Direction;
  const char *FileId;
  const char *User;
  const char *Domain;
  const char *Resource;
  char *Filename;
  const char *Datetime;
  int64 Size;
  int Accept;
  int reserved;
} XMPPStartTransferEventParams;


Unicode (Windows)
virtual INT FireStartTransfer(XMPPStartTransferEventParams *e);

typedef struct {
  INT Direction;
  LPCWSTR FileId;
  LPCWSTR User;
  LPCWSTR Domain;
  LPCWSTR Resource;
  LPWSTR Filename;
  LPCWSTR Datetime;
  LONG64 Size;
  BOOL Accept;
  INT reserved;
} XMPPStartTransferEventParams;

#define EID_XMPP_STARTTRANSFER 14

virtual INT IPWORKS_CALL FireStartTransfer(INT &iDirection, LPSTR &lpszFileId, LPSTR &lpszUser, LPSTR &lpszDomain, LPSTR &lpszResource, LPSTR &lpszFilename, LPSTR &lpszDatetime, LONG64 &lSize, BOOL &bAccept);

class XMPPStartTransferEventParams {
public:
  int Direction();

  const QString &FileId();

  const QString &User();

  const QString &Domain();

  const QString &Resource();

  const QString &Filename();
  void SetFilename(const QString &qsFilename);

  const QString &Datetime();

  qint64 Size();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartTransfer(XMPPStartTransferEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireStartTransfer(XMPPStartTransferEventParams *e) {...}

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 Class)

This event fires when a subscription request is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSubscriptionRequest(XMPPSubscriptionRequestEventParams *e);

typedef struct {
  const char *From;
  const char *Domain;
  int Accept;
  int reserved;
} XMPPSubscriptionRequestEventParams;


Unicode (Windows)
virtual INT FireSubscriptionRequest(XMPPSubscriptionRequestEventParams *e);

typedef struct {
  LPCWSTR From;
  LPCWSTR Domain;
  BOOL Accept;
  INT reserved;
} XMPPSubscriptionRequestEventParams;

#define EID_XMPP_SUBSCRIPTIONREQUEST 15

virtual INT IPWORKS_CALL FireSubscriptionRequest(LPSTR &lpszFrom, LPSTR &lpszDomain, BOOL &bAccept);

class XMPPSubscriptionRequestEventParams {
public:
  const QString &From();

  const QString &Domain();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SubscriptionRequest(XMPPSubscriptionRequestEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireSubscriptionRequest(XMPPSubscriptionRequestEventParams *e) {...}

Remarks

This event fires whenever another XMPP entity requests a subscription to this entity's presence. The XMPP class 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 class to allow the remote subscription. Otherwise, the XMPP class will actively deny the subscription request.

Sync Event (XMPP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSync(XMPPSyncEventParams *e);

typedef struct {
  int reserved;
} XMPPSyncEventParams;


Unicode (Windows)
virtual INT FireSync(XMPPSyncEventParams *e);

typedef struct {
  INT reserved;
} XMPPSyncEventParams;

#define EID_XMPP_SYNC 16

virtual INT IPWORKS_CALL FireSync();

class XMPPSyncEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Sync(XMPPSyncEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireSync(XMPPSyncEventParams *e) {...}

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 Class)

Fired during file transfer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(XMPPTransferEventParams *e);

typedef struct {
  int Direction;
  const char *FileId;
  const char *Filename;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int lenText;
  int Cancel;
  int reserved;
} XMPPTransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(XMPPTransferEventParams *e);

typedef struct {
  INT Direction;
  LPCWSTR FileId;
  LPCWSTR Filename;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCSTR Text;
  INT lenText;
  BOOL Cancel;
  INT reserved;
} XMPPTransferEventParams;

#define EID_XMPP_TRANSFER 17

virtual INT IPWORKS_CALL FireTransfer(INT &iDirection, LPSTR &lpszFileId, LPSTR &lpszFilename, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText, BOOL &bCancel);

class XMPPTransferEventParams {
public:
  int Direction();

  const QString &FileId();

  const QString &Filename();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Transfer(XMPPTransferEventParams *e);

// Or, subclass XMPP and override this emitter function.
virtual int FireTransfer(XMPPTransferEventParams *e) {...}

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 Class)

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 Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

XMPP Errors

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

TCPClient Errors