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

IPWorksIoT_XMPP

Procedural Interface

 ipworksiot_xmpp_open();
 ipworksiot_xmpp_close($res);
 ipworksiot_xmpp_register_callback($res, $id, $function);
 ipworksiot_xmpp_get_last_error($res);
 ipworksiot_xmpp_get_last_error_code($res);
 ipworksiot_xmpp_set($res, $id, $index, $value);
 ipworksiot_xmpp_get($res, $id, $index);
 ipworksiot_xmpp_do_add($res, $jabberid, $name, $groups);
 ipworksiot_xmpp_do_cancel($res, $jabberid);
 ipworksiot_xmpp_do_changepassword($res, $password);
 ipworksiot_xmpp_do_changepresence($res, $presencecode, $status);
 ipworksiot_xmpp_do_config($res, $configurationstring);
 ipworksiot_xmpp_do_connect($res);
 ipworksiot_xmpp_do_connectto($res, $user, $password);
 ipworksiot_xmpp_do_disconnect($res);
 ipworksiot_xmpp_do_doevents($res);
 ipworksiot_xmpp_do_interrupt($res);
 ipworksiot_xmpp_do_probepresence($res, $jabberid);
 ipworksiot_xmpp_do_queryregister($res, $xmppserver);
 ipworksiot_xmpp_do_register($res, $xmppserver);
 ipworksiot_xmpp_do_remove($res, $jabberid, $name, $group);
 ipworksiot_xmpp_do_reset($res);
 ipworksiot_xmpp_do_retrieveroster($res);
 ipworksiot_xmpp_do_sendcommand($res, $command);
 ipworksiot_xmpp_do_sendfile($res, $jabberid);
 ipworksiot_xmpp_do_sendmessage($res, $jabberid);
 ipworksiot_xmpp_do_setuserinfofield($res, $field, $value);
 ipworksiot_xmpp_do_subscribeto($res, $jabberid);
 ipworksiot_xmpp_do_unregister($res);
 ipworksiot_xmpp_do_unsubscribeto($res, $jabberid);
 ipworksiot_xmpp_do_updatebuddygroup($res, $buddyindex, $group);

Remarks

The XMPP class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.

A call to the ConnectTo method will perform the entire logon process after which a Connected event will fire to indicate the connection status. For simplicity, the entire interface is synchronous; the 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 1. Connecting and Sending a Message:

IMControl.ConnectTo("myusername", "mypassword") IMControl.MessageText = "My Message" IMControl.SendMessage("ToUser") Example 2. Sending a Single Message:

IMControl.User = "myusername" IMControl.Password = "mypassword" IMControl.MessageText = "My Message" IMControl.SendMessage("ToUser")

Property List

The following is the full list of the properties of the 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 (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function getAuthDomain();
public function setAuthDomain($value);

Procedural Interface

ipworksiot_xmpp_get($res, 1 );
ipworksiot_xmpp_set($res, 1, $value );

Default Value

''

Remarks

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

Data Type

String

AuthMethods Property (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function getAuthMethods();
public function setAuthMethods($value);

Procedural Interface

ipworksiot_xmpp_get($res, 2 );
ipworksiot_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 (IPWorksIoT_XMPP Class)

The number of records in the Buddy arrays.

Object Oriented Interface

public function getBuddyCount();

Procedural Interface

ipworksiot_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 (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function getBuddyGroup($buddyindex);

Procedural Interface

ipworksiot_xmpp_get($res, 4 , $buddyindex);

Default Value

''

Remarks

This property holds 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. Call the UpdateBuddyGroup method to update the buddy's group associations.

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

BuddyId Property (IPWorksIoT_XMPP Class)

This property is the jabber Id of the buddy.

Object Oriented Interface

public function getBuddyId($buddyindex);

Procedural Interface

ipworksiot_xmpp_get($res, 5 , $buddyindex);

Default Value

''

Remarks

This property 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 (IPWorksIoT_XMPP Class)

This property includes the nickname of the buddy, if one exists.

Object Oriented Interface

public function getBuddyNickName($buddyindex);
public function setBuddyNickName($buddyindex, $value);

Procedural Interface

ipworksiot_xmpp_get($res, 6 , $buddyindex);
ipworksiot_xmpp_set($res, 6, $value , $buddyindex);

Default Value

''

Remarks

This property includes 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 (IPWorksIoT_XMPP Class)

This property includes the real name of the buddy.

Object Oriented Interface

public function getBuddyRealName($buddyindex);

Procedural Interface

ipworksiot_xmpp_get($res, 7 , $buddyindex);

Default Value

''

Remarks

This property includes 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 (IPWorksIoT_XMPP Class)

This property includes a list of the buddy's subscription status types.

Object Oriented Interface

public function getBuddySubscription($buddyindex);

Procedural Interface

ipworksiot_xmpp_get($res, 8 , $buddyindex);

Default Value

0

Remarks

This property includes a list of the buddy's subscription status types.

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

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

Object Oriented Interface

public function getConnected();

Procedural Interface

ipworksiot_xmpp_get($res, 9 );

Default Value

false

Remarks

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

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

Data Type

Boolean

FirewallAutoDetect Property (IPWorksIoT_XMPP Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

ipworksiot_xmpp_get($res, 10 );
ipworksiot_xmpp_set($res, 10, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (IPWorksIoT_XMPP Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

ipworksiot_xmpp_get($res, 11 );
ipworksiot_xmpp_set($res, 11, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (IPWorksIoT_XMPP Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

ipworksiot_xmpp_get($res, 12 );
ipworksiot_xmpp_set($res, 12, $value );

Default Value

''

Remarks

The name or IP address of the 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 (IPWorksIoT_XMPP Class)

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

ipworksiot_xmpp_get($res, 13 );
ipworksiot_xmpp_set($res, 13, $value );

Default Value

''

Remarks

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

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

ipworksiot_xmpp_get($res, 14 );
ipworksiot_xmpp_set($res, 14, $value );

Default Value

0

Remarks

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

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

ipworksiot_xmpp_get($res, 15 );
ipworksiot_xmpp_set($res, 15, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property 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 (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function getIMPort();
public function setIMPort($value);

Procedural Interface

ipworksiot_xmpp_get($res, 16 );
ipworksiot_xmpp_set($res, 16, $value );

Default Value

5222

Remarks

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

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

Data Type

Integer

IMServer Property (IPWorksIoT_XMPP Class)

This property is the instant messaging server.

Object Oriented Interface

public function getIMServer();
public function setIMServer($value);

Procedural Interface

ipworksiot_xmpp_get($res, 17 );
ipworksiot_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 (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function getLocalDirectory();
public function setLocalDirectory($value);

Procedural Interface

ipworksiot_xmpp_get($res, 18 );
ipworksiot_xmpp_set($res, 18, $value );

Default Value

''

Remarks

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

Data Type

String

LocalFile Property (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function getLocalFile();
public function setLocalFile($value);

Procedural Interface

ipworksiot_xmpp_get($res, 19 );
ipworksiot_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 (IPWorksIoT_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

ipworksiot_xmpp_get($res, 20 );
ipworksiot_xmpp_set($res, 20, $value );

Default Value

''

Remarks

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

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the 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 multihomed hosts (machines with more than one IP interface).

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

Data Type

String

MessageHTML Property (IPWorksIoT_XMPP Class)

This property includes the HTML version of the current message.

Object Oriented Interface

public function getMessageHTML();
public function setMessageHTML($value);

Procedural Interface

ipworksiot_xmpp_get($res, 21 );
ipworksiot_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 (IPWorksIoT_XMPP Class)

This property contains extra data elements for the current message.

Object Oriented Interface

public function getMessageOtherData();
public function setMessageOtherData($value);

Procedural Interface

ipworksiot_xmpp_get($res, 22 );
ipworksiot_xmpp_set($res, 22, $value );

Default Value

''

Remarks

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

Data Type

String

MessageSubject Property (IPWorksIoT_XMPP Class)

This property is the subject of the current message.

Object Oriented Interface

public function getMessageSubject();
public function setMessageSubject($value);

Procedural Interface

ipworksiot_xmpp_get($res, 23 );
ipworksiot_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 (IPWorksIoT_XMPP Class)

This property is the plaintext version of the current message.

Object Oriented Interface

public function getMessageText();
public function setMessageText($value);

Procedural Interface

ipworksiot_xmpp_get($res, 24 );
ipworksiot_xmpp_set($res, 24, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

MessageThread Property (IPWorksIoT_XMPP Class)

This property is the thread name of the current message.

Object Oriented Interface

public function getMessageThread();
public function setMessageThread($value);

Procedural Interface

ipworksiot_xmpp_get($res, 25 );
ipworksiot_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 (IPWorksIoT_XMPP Class)

This property is the type of the current message.

Object Oriented Interface

public function getMessageType();
public function setMessageType($value);

Procedural Interface

ipworksiot_xmpp_get($res, 26 );
ipworksiot_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 (IPWorksIoT_XMPP Class)

This property is the user's password.

Object Oriented Interface

public function getPassword();
public function setPassword($value);

Procedural Interface

ipworksiot_xmpp_get($res, 27 );
ipworksiot_xmpp_set($res, 27, $value );

Default Value

''

Remarks

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

Data Type

String

Presence Property (IPWorksIoT_XMPP Class)

This property indicates the availability of the entity.

Object Oriented Interface

public function getPresence();

Procedural Interface

ipworksiot_xmpp_get($res, 28 );

Default Value

1

Remarks

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

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

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

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

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

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

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

Data Type

Integer

Resource Property (IPWorksIoT_XMPP Class)

This property is the resource for the current session.

Object Oriented Interface

public function getResource();
public function setResource($value);

Procedural Interface

ipworksiot_xmpp_get($res, 29 );
ipworksiot_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 (IPWorksIoT_XMPP Class)

This property includes the XMPP server's domain.

Object Oriented Interface

public function getServerDomain();
public function setServerDomain($value);

Procedural Interface

ipworksiot_xmpp_get($res, 30 );
ipworksiot_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

SSLAcceptServerCertEffectiveDate Property (IPWorksIoT_XMPP Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworksiot_xmpp_get($res, 31 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (IPWorksIoT_XMPP Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworksiot_xmpp_get($res, 32 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (IPWorksIoT_XMPP Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworksiot_xmpp_get($res, 33 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (IPWorksIoT_XMPP Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworksiot_xmpp_get($res, 34 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (IPWorksIoT_XMPP Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworksiot_xmpp_get($res, 35 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (IPWorksIoT_XMPP Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworksiot_xmpp_get($res, 36 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (IPWorksIoT_XMPP Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworksiot_xmpp_get($res, 37 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (IPWorksIoT_XMPP Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworksiot_xmpp_get($res, 38 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (IPWorksIoT_XMPP Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworksiot_xmpp_get($res, 39 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (IPWorksIoT_XMPP Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworksiot_xmpp_get($res, 40 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (IPWorksIoT_XMPP Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworksiot_xmpp_get($res, 41 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorksIoT_XMPP Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksiot_xmpp_get($res, 42 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (IPWorksIoT_XMPP Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworksiot_xmpp_get($res, 43 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (IPWorksIoT_XMPP Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworksiot_xmpp_get($res, 44 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (IPWorksIoT_XMPP Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworksiot_xmpp_get($res, 45 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (IPWorksIoT_XMPP Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

ipworksiot_xmpp_get($res, 46 );
ipworksiot_xmpp_set($res, 46, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (IPWorksIoT_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 getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

ipworksiot_xmpp_get($res, 47 );
ipworksiot_xmpp_set($res, 47, $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

SSLAcceptServerCertStoreType Property (IPWorksIoT_XMPP Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

ipworksiot_xmpp_get($res, 48 );
ipworksiot_xmpp_set($res, 48, $value );

Default Value

0

Remarks

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

SSLAcceptServerCertSubjectAltNames Property (IPWorksIoT_XMPP Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworksiot_xmpp_get($res, 49 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorksIoT_XMPP Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworksiot_xmpp_get($res, 50 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (IPWorksIoT_XMPP Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworksiot_xmpp_get($res, 51 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (IPWorksIoT_XMPP Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworksiot_xmpp_get($res, 52 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (IPWorksIoT_XMPP Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworksiot_xmpp_get($res, 53 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (IPWorksIoT_XMPP Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworksiot_xmpp_get($res, 54 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (IPWorksIoT_XMPP Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworksiot_xmpp_get($res, 55 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (IPWorksIoT_XMPP Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

ipworksiot_xmpp_get($res, 56 );
ipworksiot_xmpp_set($res, 56, $value );

Default Value

''

Remarks

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

SSLAcceptServerCertEncoded Property (IPWorksIoT_XMPP Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworksiot_xmpp_get($res, 57 );
ipworksiot_xmpp_set($res, 57, $value );

Default Value

''

Remarks

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

SSLCertEffectiveDate Property (IPWorksIoT_XMPP Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworksiot_xmpp_get($res, 58 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (IPWorksIoT_XMPP Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworksiot_xmpp_get($res, 59 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (IPWorksIoT_XMPP Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworksiot_xmpp_get($res, 60 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (IPWorksIoT_XMPP Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworksiot_xmpp_get($res, 61 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (IPWorksIoT_XMPP Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworksiot_xmpp_get($res, 62 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (IPWorksIoT_XMPP Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworksiot_xmpp_get($res, 63 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (IPWorksIoT_XMPP Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworksiot_xmpp_get($res, 64 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (IPWorksIoT_XMPP Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworksiot_xmpp_get($res, 65 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (IPWorksIoT_XMPP Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworksiot_xmpp_get($res, 66 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (IPWorksIoT_XMPP Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworksiot_xmpp_get($res, 67 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (IPWorksIoT_XMPP Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworksiot_xmpp_get($res, 68 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (IPWorksIoT_XMPP Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworksiot_xmpp_get($res, 69 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (IPWorksIoT_XMPP Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworksiot_xmpp_get($res, 70 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (IPWorksIoT_XMPP Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworksiot_xmpp_get($res, 71 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (IPWorksIoT_XMPP Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworksiot_xmpp_get($res, 72 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (IPWorksIoT_XMPP Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

ipworksiot_xmpp_get($res, 73 );
ipworksiot_xmpp_set($res, 73, $value );

Default Value

'MY'

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, 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 (IPWorksIoT_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

ipworksiot_xmpp_get($res, 74 );
ipworksiot_xmpp_set($res, 74, $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 (IPWorksIoT_XMPP Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

ipworksiot_xmpp_get($res, 75 );
ipworksiot_xmpp_set($res, 75, $value );

Default Value

0

Remarks

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

SSLCertSubjectAltNames Property (IPWorksIoT_XMPP Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworksiot_xmpp_get($res, 76 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorksIoT_XMPP Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworksiot_xmpp_get($res, 77 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (IPWorksIoT_XMPP Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworksiot_xmpp_get($res, 78 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (IPWorksIoT_XMPP Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworksiot_xmpp_get($res, 79 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (IPWorksIoT_XMPP Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworksiot_xmpp_get($res, 80 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (IPWorksIoT_XMPP Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworksiot_xmpp_get($res, 81 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (IPWorksIoT_XMPP Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworksiot_xmpp_get($res, 82 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (IPWorksIoT_XMPP Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

ipworksiot_xmpp_get($res, 83 );
ipworksiot_xmpp_set($res, 83, $value );

Default Value

''

Remarks

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

SSLCertEncoded Property (IPWorksIoT_XMPP Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

ipworksiot_xmpp_get($res, 84 );
ipworksiot_xmpp_set($res, 84, $value );

Default Value

''

Remarks

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

SSLEnabled Property (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function getSSLEnabled();
public function setSSLEnabled($value);

Procedural Interface

ipworksiot_xmpp_get($res, 85 );
ipworksiot_xmpp_set($res, 85, $value );

Default Value

false

Remarks

This property 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 (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

ipworksiot_xmpp_get($res, 86 );
ipworksiot_xmpp_set($res, 86, $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 as follows:

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

SSLServerCertEffectiveDate Property (IPWorksIoT_XMPP Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworksiot_xmpp_get($res, 87 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (IPWorksIoT_XMPP Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworksiot_xmpp_get($res, 88 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (IPWorksIoT_XMPP Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworksiot_xmpp_get($res, 89 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (IPWorksIoT_XMPP Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworksiot_xmpp_get($res, 90 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (IPWorksIoT_XMPP Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworksiot_xmpp_get($res, 91 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (IPWorksIoT_XMPP Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworksiot_xmpp_get($res, 92 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (IPWorksIoT_XMPP Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworksiot_xmpp_get($res, 93 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (IPWorksIoT_XMPP Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworksiot_xmpp_get($res, 94 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (IPWorksIoT_XMPP Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworksiot_xmpp_get($res, 95 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (IPWorksIoT_XMPP Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworksiot_xmpp_get($res, 96 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (IPWorksIoT_XMPP Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworksiot_xmpp_get($res, 97 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (IPWorksIoT_XMPP Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksiot_xmpp_get($res, 98 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (IPWorksIoT_XMPP Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworksiot_xmpp_get($res, 99 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (IPWorksIoT_XMPP Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworksiot_xmpp_get($res, 100 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (IPWorksIoT_XMPP Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworksiot_xmpp_get($res, 101 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (IPWorksIoT_XMPP Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworksiot_xmpp_get($res, 102 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (IPWorksIoT_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 getSSLServerCertStorePassword();

Procedural Interface

ipworksiot_xmpp_get($res, 103 );

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.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (IPWorksIoT_XMPP Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworksiot_xmpp_get($res, 104 );

Default Value

0

Remarks

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:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (IPWorksIoT_XMPP Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworksiot_xmpp_get($res, 105 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorksIoT_XMPP Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworksiot_xmpp_get($res, 106 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (IPWorksIoT_XMPP Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworksiot_xmpp_get($res, 107 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (IPWorksIoT_XMPP Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworksiot_xmpp_get($res, 108 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (IPWorksIoT_XMPP Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworksiot_xmpp_get($res, 109 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (IPWorksIoT_XMPP Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworksiot_xmpp_get($res, 110 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (IPWorksIoT_XMPP Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworksiot_xmpp_get($res, 111 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (IPWorksIoT_XMPP Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworksiot_xmpp_get($res, 112 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (IPWorksIoT_XMPP Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworksiot_xmpp_get($res, 113 );

Default Value

''

Remarks

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

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

Object Oriented Interface

public function getSSLStartMode();
public function setSSLStartMode($value);

Procedural Interface

ipworksiot_xmpp_get($res, 114 );
ipworksiot_xmpp_set($res, 114, $value );

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

Status Property (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function getStatus();

Procedural Interface

ipworksiot_xmpp_get($res, 115 );

Default Value

'Available for Chat.'

Remarks

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

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

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

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

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

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

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

Data Type

String

Timeout Property (IPWorksIoT_XMPP Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworksiot_xmpp_get($res, 116 );
ipworksiot_xmpp_set($res, 116, $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.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

User Property (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function getUser();
public function setUser($value);

Procedural Interface

ipworksiot_xmpp_get($res, 117 );
ipworksiot_xmpp_set($res, 117, $value );

Default Value

''

Remarks

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

Data Type

String

UserDomain Property (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function getUserDomain();
public function setUserDomain($value);

Procedural Interface

ipworksiot_xmpp_get($res, 118 );
ipworksiot_xmpp_set($res, 118, $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 log in.

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

Data Type

String

UserInfoCount Property (IPWorksIoT_XMPP Class)

The number of records in the UserInfo arrays.

Object Oriented Interface

public function getUserInfoCount();
public function setUserInfoCount($value);

Procedural Interface

ipworksiot_xmpp_get($res, 119 );
ipworksiot_xmpp_set($res, 119, $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 (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function getUserInfoField($fieldindex);
public function setUserInfoField($fieldindex, $value);

Procedural Interface

ipworksiot_xmpp_get($res, 120 , $fieldindex);
ipworksiot_xmpp_set($res, 120, $value , $fieldindex);

Default Value

''

Remarks

This property includes 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 (IPWorksIoT_XMPP Class)

This property includes the value of the current registration property.

Object Oriented Interface

public function getUserInfoValue($fieldindex);
public function setUserInfoValue($fieldindex, $value);

Procedural Interface

ipworksiot_xmpp_get($res, 121 , $fieldindex);
ipworksiot_xmpp_set($res, 121, $value , $fieldindex);

Default Value

''

Remarks

This property includes the value of the current registration field. It 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 (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

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

Procedural Interface

ipworksiot_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 the JabberId is to be added. If JabberId already exists in the buddy list, it will be updated to exist only in the specified groups. A buddy's group list can also be modified by the Buddies property.

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

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

Cancel Method (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function doCancel($jabberid);

Procedural Interface

ipworksiot_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 (IPWorksIoT_XMPP Class)

This method will change the current user's password.

Object Oriented Interface

public function doChangePassword($password);

Procedural Interface

ipworksiot_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 (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function doChangePresence($presencecode, $status);

Procedural Interface

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

Remarks

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

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

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

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

Config Method (IPWorksIoT_XMPP Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksiot_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 (IPWorksIoT_XMPP Class)

This method will connect the class to the server.

Object Oriented Interface

public function doConnect();

Procedural Interface

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

ConnectTo Method (IPWorksIoT_XMPP Class)

This method will connect the class to the server.

Object Oriented Interface

public function doConnectTo($user, $password);

Procedural Interface

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

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

Disconnect Method (IPWorksIoT_XMPP Class)

This method disconnects the class from the server.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

ipworksiot_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 (IPWorksIoT_XMPP Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksiot_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 (IPWorksIoT_XMPP Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworksiot_xmpp_do_interrupt($res);

Remarks

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

ProbePresence Method (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function doProbePresence($jabberid);

Procedural Interface

ipworksiot_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 (IPWorksIoT_XMPP Class)

This method queries a server for the necessary registration fields.

Object Oriented Interface

public function doQueryRegister($xmppserver);

Procedural Interface

ipworksiot_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 (IPWorksIoT_XMPP Class)

This method registers an account with a server.

Object Oriented Interface

public function doRegister($xmppserver);

Procedural Interface

ipworksiot_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 (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

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

Procedural Interface

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

Remarks

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

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

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

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

Reset Method (IPWorksIoT_XMPP Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksiot_xmpp_do_reset($res);

Remarks

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

RetrieveRoster Method (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function doRetrieveRoster();

Procedural Interface

ipworksiot_xmpp_do_retrieveroster($res);

Remarks

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

After a successful call to the RetrieveRoster method, the server will respond with this entity's roster. The 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 (IPWorksIoT_XMPP Class)

This method sends a command to the server.

Object Oriented Interface

public function doSendCommand($command);

Procedural Interface

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

SendFile Method (IPWorksIoT_XMPP Class)

This method sends a file to the specified user.

Object Oriented Interface

public function doSendFile($jabberid);

Procedural Interface

ipworksiot_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 (IPWorksIoT_XMPP Class)

This method will send a message to the specified user.

Object Oriented Interface

public function doSendMessage($jabberid);

Procedural Interface

ipworksiot_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 (i.e., they will be set to the empty string, "").

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

The associated properties are the following:

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

Note: The XMPP 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 (IPWorksIoT_XMPP Class)

This method will add a user information field for registration.

Object Oriented Interface

public function doSetUserInfoField($field, $value);

Procedural Interface

ipworksiot_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 be added.

Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the UserInfo 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 (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function doSubscribeTo($jabberid);

Procedural Interface

ipworksiot_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 (IPWorksIoT_XMPP Class)

This method cancels an account with the host.

Object Oriented Interface

public function doUnregister();

Procedural Interface

ipworksiot_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 (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function doUnsubscribeTo($jabberid);

Procedural Interface

ipworksiot_xmpp_do_unsubscribeto($res, $jabberid);

Remarks

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

UpdateBuddyGroup Method (IPWorksIoT_XMPP Class)

This method updates the buddy's associated groups.

Object Oriented Interface

public function doUpdateBuddyGroup($buddyindex, $group);

Procedural Interface

ipworksiot_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-separated list of groups the buddy should be associated with. Setting Group to an empty string ("") will cause the buddy to be completely disassociated from all groups.

BuddyUpdate Event (IPWorksIoT_XMPP Class)

This event is fired whenever a roster entry is updated.

Object Oriented Interface

public function fireBuddyUpdate($param);

Procedural Interface

ipworksiot_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 (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworksiot_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 Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (IPWorksIoT_XMPP Class)

Fired to indicate changes in the connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

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

Parameter List

 'connectionevent'
 'statuscode'
 'description'

Remarks

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

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

Disconnected Event (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworksiot_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 Transmission Control Protocol (TCP)/IP subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (IPWorksIoT_XMPP Class)

This event is fired when a file transfer completes.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworksiot_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 (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

Parameter List

 'errorcode'
 'description'

Remarks

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

IQ Event (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function fireIQ($param);

Procedural Interface

ipworksiot_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 it will require both knowledge of XML and knowledge of the possible contents of the IQ message to parse. Id will contain the transaction Id of the IQ message. From will contain the sender's Jabber Id. IqType will have one of the following values:

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

MessageIn Event (IPWorksIoT_XMPP Class)

This event is fired upon receipt of a message.

Object Oriented Interface

public function fireMessageIn($param);

Procedural Interface

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

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

PITrail Event (IPWorksIoT_XMPP Class)

This event is fired for all protocol messages.

Object Oriented Interface

public function firePITrail($param);

Procedural Interface

ipworksiot_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 interactions between the client and the server, line by line.

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

The direction parameter shows the originator of the message:

The Pi parameter contains the PI message.

Presence Event (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function firePresence($param);

Procedural Interface

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

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

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

Object Oriented Interface

public function fireReadyToSend($param);

Procedural Interface

ipworksiot_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 SendBytes. This event also is fired immediately after a connection to the remote host is established.

SSLServerAuthentication Event (IPWorksIoT_XMPP Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworksiot_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 (IPWorksIoT_XMPP Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksiot_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 (IPWorksIoT_XMPP Class)

This event is fired when a file transfer begins.

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworksiot_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 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 (IPWorksIoT_XMPP Class)

This event fires when a subscription request is received.

Object Oriented Interface

public function fireSubscriptionRequest($param);

Procedural Interface

ipworksiot_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. It is not necessary to know which resource sent the request, because all instances of the requesting entity's account have access to the same roster.

Accept will initially be False, but setting it to True will cause the XMPP class to allow the remote subscription. Otherwise, the XMPP class will actively deny the subscription request.

Sync Event (IPWorksIoT_XMPP Class)

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

Object Oriented Interface

public function fireSync($param);

Procedural Interface

ipworksiot_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:

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

Transfer Event (IPWorksIoT_XMPP Class)

This event is fired during file transfer.

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworksiot_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 cannot be calculated, the value will be -1.

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

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

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

Config Settings (XMPP Class)

XMPP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base 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