XMPP Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

IPWorksMQ_XMPP

Procedural Interface

 ipworksmq_xmpp_open();
 ipworksmq_xmpp_close($res);
 ipworksmq_xmpp_register_callback($res, $id, $function);
 ipworksmq_xmpp_get_last_error($res);
 ipworksmq_xmpp_get_last_error_code($res);
 ipworksmq_xmpp_set($res, $id, $index, $value);
 ipworksmq_xmpp_get($res, $id, $index);
 ipworksmq_xmpp_do_add($res, $jabberid, $name, $groups);
 ipworksmq_xmpp_do_cancel($res, $jabberid);
 ipworksmq_xmpp_do_changepassword($res, $password);
 ipworksmq_xmpp_do_changepresence($res, $presencecode, $status);
 ipworksmq_xmpp_do_config($res, $configurationstring);
 ipworksmq_xmpp_do_connect($res);
 ipworksmq_xmpp_do_connectto($res, $user, $password);
 ipworksmq_xmpp_do_disconnect($res);
 ipworksmq_xmpp_do_doevents($res);
 ipworksmq_xmpp_do_interrupt($res);
 ipworksmq_xmpp_do_probepresence($res, $jabberid);
 ipworksmq_xmpp_do_queryregister($res, $xmppserver);
 ipworksmq_xmpp_do_register($res, $xmppserver);
 ipworksmq_xmpp_do_remove($res, $jabberid, $name, $group);
 ipworksmq_xmpp_do_reset($res);
 ipworksmq_xmpp_do_retrieveroster($res);
 ipworksmq_xmpp_do_sendcommand($res, $command);
 ipworksmq_xmpp_do_sendfile($res, $jabberid);
 ipworksmq_xmpp_do_sendmessage($res, $jabberid);
 ipworksmq_xmpp_do_setuserinfofield($res, $field, $value);
 ipworksmq_xmpp_do_subscribeto($res, $jabberid);
 ipworksmq_xmpp_do_unregister($res);
 ipworksmq_xmpp_do_unsubscribeto($res, $jabberid);
 ipworksmq_xmpp_do_updatebuddygroup($res, $buddyindex, $group);

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

The domain under which the user will be authenticated.

Object Oriented Interface

public function getAuthDomain();


public function setAuthDomain($value);

Procedural Interface

ipworksmq_xmpp_get($res, 1 );


ipworksmq_xmpp_set($res, 1, $value );

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

Controls how the class authenticates itself with the XMPP server.

Object Oriented Interface

public function getAuthMethods();


public function setAuthMethods($value);

Procedural Interface

ipworksmq_xmpp_get($res, 2 );


ipworksmq_xmpp_set($res, 2, $value );

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

The number of records in the Buddy arrays.

Object Oriented Interface

public function getBuddyCount();

Procedural Interface

ipworksmq_xmpp_get($res, 3 );

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

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

Object Oriented Interface

public function getBuddyGroup($buddyindex);


public function setBuddyGroup($buddyindex, $value);

Procedural Interface

ipworksmq_xmpp_get($res, 4 , $buddyindex);


ipworksmq_xmpp_set($res, 4, $value , $buddyindex);

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

This is the jabber id of the buddy.

Object Oriented Interface

public function getBuddyId($buddyindex);

Procedural Interface

ipworksmq_xmpp_get($res, 5 , $buddyindex);

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

The nickname of the buddy, if one exists.

Object Oriented Interface

public function getBuddyNickName($buddyindex);


public function setBuddyNickName($buddyindex, $value);

Procedural Interface

ipworksmq_xmpp_get($res, 6 , $buddyindex);


ipworksmq_xmpp_set($res, 6, $value , $buddyindex);

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

The real name of the buddy.

Object Oriented Interface

public function getBuddyRealName($buddyindex);

Procedural Interface

ipworksmq_xmpp_get($res, 7 , $buddyindex);

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

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

Object Oriented Interface

public function getBuddySubscription($buddyindex);

Procedural Interface

ipworksmq_xmpp_get($res, 8 , $buddyindex);

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

This indicates the class's login status.

Object Oriented Interface

public function getConnected();


public function setConnected($value);

Procedural Interface

ipworksmq_xmpp_get($res, 9 );


ipworksmq_xmpp_set($res, 9, $value );

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

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

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

ipworksmq_xmpp_get($res, 10 );


ipworksmq_xmpp_set($res, 10, $value );

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

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

ipworksmq_xmpp_get($res, 11 );


ipworksmq_xmpp_set($res, 11, $value );

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

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

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

ipworksmq_xmpp_get($res, 12 );


ipworksmq_xmpp_set($res, 12, $value );

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

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

Object Oriented Interface

public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface

ipworksmq_xmpp_get($res, 13 );


ipworksmq_xmpp_set($res, 13, $value );

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

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

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

ipworksmq_xmpp_get($res, 14 );


ipworksmq_xmpp_set($res, 14, $value );

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

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

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

ipworksmq_xmpp_get($res, 15 );


ipworksmq_xmpp_set($res, 15, $value );

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

The server port for XMPP (default 5222).

Object Oriented Interface

public function getIMPort();


public function setIMPort($value);

Procedural Interface

ipworksmq_xmpp_get($res, 16 );


ipworksmq_xmpp_set($res, 16, $value );

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

This is the instant messaging server.

Object Oriented Interface

public function getIMServer();


public function setIMServer($value);

Procedural Interface

ipworksmq_xmpp_get($res, 17 );


ipworksmq_xmpp_set($res, 17, $value );

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

The directory to which received files are saved.

Object Oriented Interface

public function getLocalDirectory();


public function setLocalDirectory($value);

Procedural Interface

ipworksmq_xmpp_get($res, 18 );


ipworksmq_xmpp_set($res, 18, $value );

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

The path to the file that will be sent.

Object Oriented Interface

public function getLocalFile();


public function setLocalFile($value);

Procedural Interface

ipworksmq_xmpp_get($res, 19 );


ipworksmq_xmpp_set($res, 19, $value );

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

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

Object Oriented Interface

public function getLocalHost();


public function setLocalHost($value);

Procedural Interface

ipworksmq_xmpp_get($res, 20 );


ipworksmq_xmpp_set($res, 20, $value );

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

This is the HTML version of the current message.

Object Oriented Interface

public function getMessageHTML();


public function setMessageHTML($value);

Procedural Interface

ipworksmq_xmpp_get($res, 21 );


ipworksmq_xmpp_set($res, 21, $value );

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

This property contains extra data elements for the current message.

Object Oriented Interface

public function getMessageOtherData();


public function setMessageOtherData($value);

Procedural Interface

ipworksmq_xmpp_get($res, 22 );


ipworksmq_xmpp_set($res, 22, $value );

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

This is the subject of the current message.

Object Oriented Interface

public function getMessageSubject();


public function setMessageSubject($value);

Procedural Interface

ipworksmq_xmpp_get($res, 23 );


ipworksmq_xmpp_set($res, 23, $value );

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

This is the plain text of the current message.

Object Oriented Interface

public function getMessageText();


public function setMessageText($value);

Procedural Interface

ipworksmq_xmpp_get($res, 24 );


ipworksmq_xmpp_set($res, 24, $value );

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

This is the thread name of the current message.

Object Oriented Interface

public function getMessageThread();


public function setMessageThread($value);

Procedural Interface

ipworksmq_xmpp_get($res, 25 );


ipworksmq_xmpp_set($res, 25, $value );

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

This is the type of the current message.

Object Oriented Interface

public function getMessageType();


public function setMessageType($value);

Procedural Interface

ipworksmq_xmpp_get($res, 26 );


ipworksmq_xmpp_set($res, 26, $value );

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

This is the user's password.

Object Oriented Interface

public function getPassword();


public function setPassword($value);

Procedural Interface

ipworksmq_xmpp_get($res, 27 );


ipworksmq_xmpp_set($res, 27, $value );

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

This is the availability of the entity.

Object Oriented Interface

public function getPresence();


public function setPresence($value);

Procedural Interface

ipworksmq_xmpp_get($res, 28 );


ipworksmq_xmpp_set($res, 28, $value );

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

This is the resource for the current session.

Object Oriented Interface

public function getResource();


public function setResource($value);

Procedural Interface

ipworksmq_xmpp_get($res, 29 );


ipworksmq_xmpp_set($res, 29, $value );

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

The XMPP server's domain.

Object Oriented Interface

public function getServerDomain();


public function setServerDomain($value);

Procedural Interface

ipworksmq_xmpp_get($res, 30 );


ipworksmq_xmpp_set($res, 30, $value );

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

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworksmq_xmpp_get($res, 32 );


ipworksmq_xmpp_set($res, 32, $value );

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

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

ipworksmq_xmpp_get($res, 60 );


ipworksmq_xmpp_set($res, 60, $value );

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

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

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

ipworksmq_xmpp_get($res, 76 );


ipworksmq_xmpp_set($res, 76, $value );

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 (IPWorksMQ_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.

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

ipworksmq_xmpp_get($res, 77 );


ipworksmq_xmpp_set($res, 77, $value );

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

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

ipworksmq_xmpp_get($res, 78 );


ipworksmq_xmpp_set($res, 78, $value );

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

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

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

ipworksmq_xmpp_get($res, 79 );


ipworksmq_xmpp_set($res, 79, $value );

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

Whether TLS/SSL is enabled.

Object Oriented Interface

public function getSSLEnabled();


public function setSSLEnabled($value);

Procedural Interface

ipworksmq_xmpp_get($res, 87 );


ipworksmq_xmpp_set($res, 87, $value );

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

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

ipworksmq_xmpp_get($res, 88 );


ipworksmq_xmpp_set($res, 88, $value );

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

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworksmq_xmpp_get($res, 90 );

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

Determines how the class starts the SSL negotiation.

Object Oriented Interface

public function getSSLStartMode();


public function setSSLStartMode($value);

Procedural Interface

ipworksmq_xmpp_get($res, 117 );


ipworksmq_xmpp_set($res, 117, $value );

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

Status Property (IPWorksMQ_XMPP Class)

Description of the availability of this entity.

Object Oriented Interface

public function getStatus();


public function setStatus($value);

Procedural Interface

ipworksmq_xmpp_get($res, 118 );


ipworksmq_xmpp_set($res, 118, $value );

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

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

ipworksmq_xmpp_get($res, 119 );


ipworksmq_xmpp_set($res, 119, $value );

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

The user portion of this entity's Jabber ID.

Object Oriented Interface

public function getUser();


public function setUser($value);

Procedural Interface

ipworksmq_xmpp_get($res, 120 );


ipworksmq_xmpp_set($res, 120, $value );

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

Gets or sets the domain value used for Jabber IDs.

Object Oriented Interface

public function getUserDomain();


public function setUserDomain($value);

Procedural Interface

ipworksmq_xmpp_get($res, 121 );


ipworksmq_xmpp_set($res, 121, $value );

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

The number of records in the UserInfo arrays.

Object Oriented Interface

public function getUserInfoCount();


public function setUserInfoCount($value);

Procedural Interface

ipworksmq_xmpp_get($res, 122 );


ipworksmq_xmpp_set($res, 122, $value );

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

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

Object Oriented Interface

public function getUserInfoField($fieldindex);


public function setUserInfoField($fieldindex, $value);

Procedural Interface

ipworksmq_xmpp_get($res, 123 , $fieldindex);


ipworksmq_xmpp_set($res, 123, $value , $fieldindex);

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

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

Object Oriented Interface

public function getUserInfoValue($fieldindex);


public function setUserInfoValue($fieldindex, $value);

Procedural Interface

ipworksmq_xmpp_get($res, 124 , $fieldindex);


ipworksmq_xmpp_set($res, 124, $value , $fieldindex);

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

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

Object Oriented Interface

public function doAdd($jabberid, $name, $groups);

Procedural Interface

ipworksmq_xmpp_do_add($res, $jabberid, $name, $groups);

Remarks

JabberId is the Jabber ID of the entity to be added. It should be of form "user@host". If no hostname is specified, the 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.

Cancel Method (IPWorksMQ_XMPP Class)

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

Object Oriented Interface

public function doCancel($jabberid);

Procedural Interface

ipworksmq_xmpp_do_cancel($res, $jabberid);

Remarks

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

ChangePassword Method (IPWorksMQ_XMPP Class)

This method will change the current user's password.

Object Oriented Interface

public function doChangePassword($password);

Procedural Interface

ipworksmq_xmpp_do_changepassword($res, $password);

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.

ChangePresence Method (IPWorksMQ_XMPP Class)

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

Object Oriented Interface

public function doChangePresence($presencecode, $status);

Procedural Interface

ipworksmq_xmpp_do_changepresence($res, $presencecode, $status);

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

Config Method (IPWorksMQ_XMPP Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksmq_xmpp_do_config($res, $configurationstring);

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.

Connect Method (IPWorksMQ_XMPP Class)

This method will connect the class to the server.

Object Oriented Interface

public function doConnect();

Procedural Interface

ipworksmq_xmpp_do_connect($res);

Remarks

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

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

ConnectTo Method (IPWorksMQ_XMPP Class)

This method will connect the class to the server.

Object Oriented Interface

public function doConnectTo($user, $password);

Procedural Interface

ipworksmq_xmpp_do_connectto($res, $user, $password);

Remarks

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

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

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

Disconnect Method (IPWorksMQ_XMPP Class)

This method disconnects the class from the server.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

ipworksmq_xmpp_do_disconnect($res);

Remarks

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

DoEvents Method (IPWorksMQ_XMPP Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksmq_xmpp_do_doevents($res);

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.

Interrupt Method (IPWorksMQ_XMPP Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworksmq_xmpp_do_interrupt($res);

Remarks

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

ProbePresence Method (IPWorksMQ_XMPP Class)

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

Object Oriented Interface

public function doProbePresence($jabberid);

Procedural Interface

ipworksmq_xmpp_do_probepresence($res, $jabberid);

Remarks

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

QueryRegister Method (IPWorksMQ_XMPP Class)

This method queries a server for the necessary registration fields.

Object Oriented Interface

public function doQueryRegister($xmppserver);

Procedural Interface

ipworksmq_xmpp_do_queryregister($res, $xmppserver);

Remarks

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

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

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

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

Register Method (IPWorksMQ_XMPP Class)

This method registers an account with a server.

Object Oriented Interface

public function doRegister($xmppserver);

Procedural Interface

ipworksmq_xmpp_do_register($res, $xmppserver);

Remarks

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

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

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

If the 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.

Remove Method (IPWorksMQ_XMPP Class)

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

Object Oriented Interface

public function doRemove($jabberid, $name, $group);

Procedural Interface

ipworksmq_xmpp_do_remove($res, $jabberid, $name, $group);

Remarks

JabberId is the Jabber ID of the entity to be removed. It should be of form "user@host". If no hostname is specified, the 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.

Reset Method (IPWorksMQ_XMPP Class)

Reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksmq_xmpp_do_reset($res);

Remarks

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

RetrieveRoster Method (IPWorksMQ_XMPP Class)

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

Object Oriented Interface

public function doRetrieveRoster();

Procedural Interface

ipworksmq_xmpp_do_retrieveroster($res);

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.

SendCommand Method (IPWorksMQ_XMPP Class)

This method sends a command to the server.

Object Oriented Interface

public function doSendCommand($command);

Procedural Interface

ipworksmq_xmpp_do_sendcommand($res, $command);

Remarks

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

The SendCommand method should only be used by programmers or users who are connecting to non-standard servers whose command list is not covered by the 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.

SendFile Method (IPWorksMQ_XMPP Class)

Sends a file to the specified user.

Object Oriented Interface

public function doSendFile($jabberid);

Procedural Interface

ipworksmq_xmpp_do_sendfile($res, $jabberid);

Remarks

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

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

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

SendMessage Method (IPWorksMQ_XMPP Class)

This method will send a message to the specified user.

Object Oriented Interface

public function doSendMessage($jabberid);

Procedural Interface

ipworksmq_xmpp_do_sendmessage($res, $jabberid);

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.

SetUserInfoField Method (IPWorksMQ_XMPP Class)

This method will add a user information field for registration.

Object Oriented Interface

public function doSetUserInfoField($field, $value);

Procedural Interface

ipworksmq_xmpp_do_setuserinfofield($res, $field, $value);

Remarks

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

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

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

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

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

SubscribeTo Method (IPWorksMQ_XMPP Class)

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

Object Oriented Interface

public function doSubscribeTo($jabberid);

Procedural Interface

ipworksmq_xmpp_do_subscribeto($res, $jabberid);

Remarks

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

Unregister Method (IPWorksMQ_XMPP Class)

This method cancels an account with the host.

Object Oriented Interface

public function doUnregister();

Procedural Interface

ipworksmq_xmpp_do_unregister($res);

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.

UnsubscribeTo Method (IPWorksMQ_XMPP Class)

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

Object Oriented Interface

public function doUnsubscribeTo($jabberid);

Procedural Interface

ipworksmq_xmpp_do_unsubscribeto($res, $jabberid);

Remarks

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

UpdateBuddyGroup Method (IPWorksMQ_XMPP Class)

Updates the buddy's associatd groups.

Object Oriented Interface

public function doUpdateBuddyGroup($buddyindex, $group);

Procedural Interface

ipworksmq_xmpp_do_updatebuddygroup($res, $buddyindex, $group);

Remarks

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

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

BuddyUpdate Event (IPWorksMQ_XMPP Class)

This event is fired whenever a roster entry is updated.

Object Oriented Interface

public function fireBuddyUpdate($param);

Procedural Interface

ipworksmq_xmpp_register_callback($res, 1, array($this, 'fireBuddyUpdate'));

Parameter List

 'buddyidx'

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

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

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworksmq_xmpp_register_callback($res, 2, array($this, 'fireConnected'));

Parameter List

 'statuscode'
 'description'

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

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

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

ipworksmq_xmpp_register_callback($res, 3, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
 'statuscode'
 'description'

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

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

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworksmq_xmpp_register_callback($res, 4, array($this, 'fireDisconnected'));

Parameter List

 'statuscode'
 'description'

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

Fired when a file transfer completes.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworksmq_xmpp_register_callback($res, 5, array($this, 'fireEndTransfer'));

Parameter List

 'direction'
 'fileid'
 'filename'
 'success'

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

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

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksmq_xmpp_register_callback($res, 6, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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

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

Object Oriented Interface

public function fireIQ($param);

Procedural Interface

ipworksmq_xmpp_register_callback($res, 7, array($this, 'fireIQ'));

Parameter List

 'iq'
 'id'
 'from'
 'iqtype'
 'ignore'

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

This event is fired upon receipt of a message.

Object Oriented Interface

public function fireMessageIn($param);

Procedural Interface

ipworksmq_xmpp_register_callback($res, 8, array($this, 'fireMessageIn'));

Parameter List

 'messageid'
 'from'
 'domain'
 'resource'
 'messagetype'
 'subject'
 'messagethread'
 'messagetext'
 'messagehtml'
 'other'

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

This event is fired for all protocol messages.

Object Oriented Interface

public function firePITrail($param);

Procedural Interface

ipworksmq_xmpp_register_callback($res, 9, array($this, 'firePITrail'));

Parameter List

 'direction'
 'pi'

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

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

Object Oriented Interface

public function firePresence($param);

Procedural Interface

ipworksmq_xmpp_register_callback($res, 10, array($this, 'firePresence'));

Parameter List

 'user'
 'domain'
 'resource'
 'availability'
 'status'

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

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

Object Oriented Interface

public function fireReadyToSend($param);

Procedural Interface

ipworksmq_xmpp_register_callback($res, 11, array($this, 'fireReadyToSend'));

Parameter List

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

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworksmq_xmpp_register_callback($res, 12, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksmq_xmpp_register_callback($res, 13, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

StartTransfer Event (IPWorksMQ_XMPP Class)

Fired when a file transfer begins.

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworksmq_xmpp_register_callback($res, 14, array($this, 'fireStartTransfer'));

Parameter List

 'direction'
 'fileid'
 'user'
 'domain'
 'resource'
 'filename'
 'datetime'
 'size'
 'accept'

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

This event fires when a subscription request is received.

Object Oriented Interface

public function fireSubscriptionRequest($param);

Procedural Interface

ipworksmq_xmpp_register_callback($res, 15, array($this, 'fireSubscriptionRequest'));

Parameter List

 'from'
 'domain'
 'accept'

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

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

Object Oriented Interface

public function fireSync($param);

Procedural Interface

ipworksmq_xmpp_register_callback($res, 16, array($this, 'fireSync'));

Parameter List

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

Fired during file transfer.

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworksmq_xmpp_register_callback($res, 17, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'fileid'
 'filename'
 'bytestransferred'
 'percentdone'
 'text'
 'cancel'

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

Trappable Errors (XMPP Class)

XMPP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors