XMPP Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ipworks.xmpp()

Remarks

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

A call to the ConnectTo method will perform the entire logon process after which a Connected event will fire indicating connection status. For simplicity, the entire interface is synchronous; the class will not return until a call is completed.

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

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

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

Example (Connecting and Sending a Message)

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

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

Property List


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

AuthDomainThe domain under which the user will be authenticated.
AuthMethodsControls how the class authenticates itself with the XMPP server.
BuddiesCollection of buddies in the buddy list.
ConnectedThis indicates the class's login status.
FirewallA set of properties related to firewall access.
IMPortThe server port for XMPP (default 5222).
IMServerThis is the instant messaging server.
LocalDirectoryThe directory to which received files are saved.
LocalFileThe path to the file that will be sent.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MessageHTMLThis is the HTML version of the current message.
MessageOtherDataThis property contains extra data elements for the current message.
MessageSubjectThis is the subject of the current message.
MessageTextThis is the plain text of the current message.
MessageThreadThis is the thread name of the current message.
MessageTypeThis is the type of the current message.
PasswordThis is the user's password.
PresenceThis is the availability of the entity.
ResourceThis is the resource for the current session.
ServerDomainThe XMPP server's domain.
SSLAcceptServerCertInstructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLEnabledWhether TLS/SSL is enabled.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertThe server certificate for the last established connection.
SSLStartModeDetermines how the class starts the SSL negotiation.
StatusDescription of the availability of this entity.
TimeoutA timeout for the class.
UserThe user portion of this entity's Jabber ID.
UserDomainGets or sets the domain value used for Jabber IDs.
UserInfoCollection of named registration fields.

Method List


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

AddThis method will add an entity to this entity's roster.
CancelThis will cancel another entity's subscription to this entity's presence.
ChangePasswordThis method will change the current user's password.
ChangePresenceThis method will set the availability and status of this entity.
ConfigSets or retrieves a configuration setting.
ConnectThis method will connect the class to the server.
ConnectToThis method will connect the class to the server.
DisconnectThis method disconnects the class from the server.
DoEventsThis method processes events from the internal message queue.
InterruptInterrupt the current method.
ProbePresenceUse this method to probe for another entity's presence.
QueryRegisterThis method queries a server for the necessary registration fields.
RegisterThis method registers an account with a server.
RemoveThis method will remove an entity from this entity's roster.
ResetReset the class.
RetrieveRosterThis method will retrieve this entity's roster from the server.
SendCommandThis method sends a command to the server.
SendFileSends a file to the specified user.
SendMessageThis method will send a message to the specified user.
SetUserInfoFieldThis method will add a user information field for registration.
SubscribeToUse this method to subscribe to another entity's presence.
UnregisterThis method cancels an account with the host.
UnsubscribeToThis method will cancel a subscription to another entity's presence.
UpdateBuddyGroupUpdates the buddy's associatd groups.

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.

BuddyUpdateThis event is fired whenever a roster entry is updated.
ConnectedThis event is fired when a connection to the IM Server is completed.
ConnectionStatusThis event is fired to indicate changes in the connection state.
DisconnectedThis event is fired when the chat service connection is lost.
EndTransferFired when a file transfer completes.
ErrorThis event is fired when the server sends a protocol error message.
IQThis event is fired for IQ messages not normally supported by the class.
MessageInThis event is fired upon receipt of a message.
PITrailThis event is fired for all protocol messages.
PresenceThis event is fired when the presence of a subscribed entity changes.
ReadyToSendThis event is fired when the class is ready to send data.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusFired when secure connection progress messages are available.
StartTransferFired when a file transfer begins.
SubscriptionRequestThis event fires when a subscription request is received.
SyncThis event fires upon a complete information synchronization with the server.
TransferFired during file transfer.

Config Settings


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

AccessTokenThe OAuth access token used for authentication.
BlockSizeSpecifies the block size for file transfers.
ClientIdThe OAuth client Id used for authentication.
MessageIdSpecifies the number used in the message Id.
MessageXMLReturns the last root-level element received by the class.
OverwriteSpecifies whether or not to overwrite received files.
ParseHTMLTells XMPP whether or not to parse MessageHTML when it's set.
RetrieveRosterWhether to automatically retrieve the roster when logging in.
SendSubscriptionResponseDetermines whether a response will be sent to a Subscription Request.
UseCompressionSpecified whether or not stream compression is used.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLAcceptAnyServerCertWhether to trust any certificate presented by the server.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

XMPP.AuthDomain Property

The domain under which the user will be authenticated.

Syntax

getAuthDomain(): string;
setAuthDomain(authDomain: string): void;

Default Value

""

Remarks

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

XMPP.AuthMethods Property

Controls how the class authenticates itself with the XMPP server.

Syntax

getAuthMethods(): string;
setAuthMethods(authMethods: string): void;

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

XMPP.Buddies Property

Collection of buddies in the buddy list.

Syntax

getBuddies(): XMPPBuddyList;

Default Value

Remarks

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

This property is read-only.

Please refer to the XMPPBuddy type for a complete list of fields.

XMPP.Connected Property

This indicates the class's login status.

Syntax

isConnected(): boolean;

Default Value

FALSE

Remarks

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

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

This property is not available at design time.

XMPP.Firewall Property

A set of properties related to firewall access.

Syntax

getFirewall(): Firewall;
setFirewall(firewall: Firewall): void;

Default Value

Remarks

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

Please refer to the Firewall type for a complete list of fields.

XMPP.IMPort Property

The server port for XMPP (default 5222).

Syntax

getIMPort(): number;
setIMPort(IMPort: number): void;

Default Value

5222

Remarks

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

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

XMPP.IMServer Property

This is the instant messaging server.

Syntax

getIMServer(): string;
setIMServer(IMServer: string): void;

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.

XMPP.LocalDirectory Property

The directory to which received files are saved.

Syntax

getLocalDirectory(): string;
setLocalDirectory(localDirectory: string): void;

Default Value

""

Remarks

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

XMPP.LocalFile Property

The path to the file that will be sent.

Syntax

getLocalFile(): string;
setLocalFile(localFile: string): void;

Default Value

""

Remarks

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

XMPP.LocalHost Property

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

Syntax

getLocalHost(): string;
setLocalHost(localHost: string): void;

Default Value

""

Remarks

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

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

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

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

XMPP.MessageHTML Property

This is the HTML version of the current message.

Syntax

getMessageHTML(): string;
setMessageHTML(messageHTML: string): void;

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.

XMPP.MessageOtherData Property

This property contains extra data elements for the current message.

Syntax

getMessageOtherData(): string;
setMessageOtherData(messageOtherData: string): void;

Default Value

""

Remarks

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

XMPP.MessageSubject Property

This is the subject of the current message.

Syntax

getMessageSubject(): string;
setMessageSubject(messageSubject: string): void;

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.

XMPP.MessageText Property

This is the plain text of the current message.

Syntax

getMessageText(): string;
setMessageText(messageText: string): void;

Default Value

""

Remarks

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

This property is not available at design time.

XMPP.MessageThread Property

This is the thread name of the current message.

Syntax

getMessageThread(): string;
setMessageThread(messageThread: string): void;

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.

XMPP.MessageType Property

This is the type of the current message.

Syntax

getMessageType(): XmppMessageTypes;
setMessageType(messageType: XmppMessageTypes): void;

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

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:

normal (jmtNormal - 0)A single message.
chat (jmtChat - 1)A message sent in the context of two-way chat between two entities.
groupchat (jmtGroupChat - 2)A message sent in the context of multi-user chat among multiple entities.
headline (jmtHeadline - 3)A message that represents one of a list of items (e.g., in a news feed or information ticker).
error (jmtError - 4)A message returned to a sender specifying an error associated with a previous message sent by the sender to an intended recipient.

This property is not available at design time.

XMPP.Password Property

This is the user's password.

Syntax

getPassword(): string;
setPassword(password: string): void;

Default Value

""

Remarks

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

XMPP.Presence Property

This is the availability of the entity.

Syntax

getPresence(): XmppPresences;

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

Default Value

1

Remarks

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

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

pcOffline (0)Invisible: JabberId is offline.
pcChat (1)Available: JabberId is online.
pcAway (2)Away: JabberId is online, but the user is away from their computer.
pcXA (3)Extended Away: JabberId is online, but the user is away from their computer for an extended period of time.
pcDND (4)Do not Disturb: JabberId is online, but is busy and does not wish to be disturbed.

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

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

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

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

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

This property is not available at design time.

XMPP.Resource Property

This is the resource for the current session.

Syntax

getResource(): string;
setResource(resource: string): void;

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.

XMPP.ServerDomain Property

The XMPP server's domain.

Syntax

getServerDomain(): string;
setServerDomain(serverDomain: string): void;

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.

XMPP.SSLAcceptServerCert Property

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

Syntax

getSSLAcceptServerCert(): Certificate;
setSSLAcceptServerCert(SSLAcceptServerCert: Certificate): void;

Default Value

Remarks

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

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

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

Please refer to the Certificate type for a complete list of fields.

XMPP.SSLCert Property

The certificate to be used during SSL negotiation.

Syntax

getSSLCert(): Certificate;
setSSLCert(SSLCert: Certificate): void;

Default Value

Remarks

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

Please refer to the Certificate type for a complete list of fields.

XMPP.SSLEnabled Property

Whether TLS/SSL is enabled.

Syntax

isSSLEnabled(): boolean;
setSSLEnabled(SSLEnabled: boolean): void;

Default Value

FALSE

Remarks

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

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

This property is not available at design time.

XMPP.SSLProvider Property

This specifies the SSL/TLS implementation to use.

Syntax

getSSLProvider(): XmppSSLProviders;
setSSLProvider(SSLProvider: XmppSSLProviders): void;

enum XmppSSLProviders { sslpAutomatic, sslpPlatform, sslpInternal }

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:

0 (sslpAutomatic - default)Automatically selects the appropriate implementation.
1 (sslpPlatform) Uses the platform/system implementation.
2 (sslpInternal) Uses the internal implementation.
Additional Notes

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 the platform implementation will be used by default in all cases in the JavaScript edition.

Note: The Internal provider is not support at this time.

XMPP.SSLServerCert Property

The server certificate for the last established connection.

Syntax

getSSLServerCert(): Certificate;

Default Value

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Please refer to the Certificate type for a complete list of fields.

XMPP.SSLStartMode Property

Determines how the class starts the SSL negotiation.

Syntax

getSSLStartMode(): XmppSSLStartModes;
setSSLStartMode(SSLStartMode: XmppSSLStartModes): void;

enum XmppSSLStartModes { sslAutomatic, sslImplicit, sslExplicit, sslNone }

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

0 (sslAutomatic)If the remote port is set to the standard plaintext port of the protocol (where applicable), the class will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit).
1 (sslImplicit)The SSL negotiation will start immediately after the connection is established.
2 (sslExplicit)The class will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.
3 (sslNone - default)No SSL negotiation, no SSL security. All communication will be in plaintext mode.

XMPP.Status Property

Description of the availability of this entity.

Syntax

getStatus(): string;

Default Value

"Available for Chat."

Remarks

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

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

pcOffline (0)Invisible: JabberId is offline.
pcChat (1)Available: JabberId is online.
pcAway (2)Away: JabberId is online, but the user is away from their computer.
pcXA (3)Extended Away: JabberId is online, but the user is away from their computer for an extended period of time.
pcDND (4)Do not Disturb: JabberId is online, but is busy and does not wish to be disturbed.

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

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

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

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

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

This property is not available at design time.

XMPP.Timeout Property

A timeout for the class.

Syntax

getTimeout(): number;
setTimeout(timeout: number): void;

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 .

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

The default value for the Timeout property is 60 seconds.

XMPP.User Property

The user portion of this entity's Jabber ID.

Syntax

getUser(): string;
setUser(user: string): void;

Default Value

""

Remarks

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

XMPP.UserDomain Property

Gets or sets the domain value used for Jabber IDs.

Syntax

getUserDomain(): string;
setUserDomain(userDomain: string): void;

Default Value

""

Remarks

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

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

XMPP.UserInfo Property

Collection of named registration fields.

Syntax

getUserInfo(): XMPPUserInfoMap;
setUserInfo(userInfo: XMPPUserInfoMap): void;

Default Value

0

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:

instructionsSpecial instructions sent from the server.
usernameThe username to be associated with this account.
passwordThe initial password for this account.
nameThe user's name.
emailThe user's email address.
addressThe user's physical address.
cityThe user's city of residence.
stateThe user's state (for United States citizens).
zipThe user's postal code (for United States citizens).
phoneThe user's phone number.
URLThe user's website.
dateThe date of registration.
miscAny miscellaneous data.
textAny extra text (potentially for a personal bio).
removeSpecifies a request to unregister.

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.

This collection is a hashtable type of collection where the field string is used as the key to the desired XMPP user info object.

Example (Setting New User Information)

xmpp1.QueryRegister("server"); xmpp1.UserInfoCount = 2 xmpp1.UserInfoField(0) = "Username" xmpp1.UserInfoValue(0) = "newuser" xmpp1.UserInfoField(1) = "Password" xmpp1.UserInfoValue(1) = "newpass" xmpp1.Register("server");

This property is not available at design time.

Please refer to the XMPPUserInfo type for a complete list of fields.

XMPP.add Method

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

Syntax

async xmpp.add(jabberId : string, name : string, groups : string): Promise<void>

Remarks

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

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

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

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

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

XMPP.cancel Method

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

Syntax

async xmpp.cancel(jabberId : string): Promise<void>

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.

XMPP.changePassword Method

This method will change the current user's password.

Syntax

async xmpp.changePassword(password : string): Promise<void>

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.

XMPP.changePresence Method

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

Syntax

async xmpp.changePresence(presenceCode : number, status : string): Promise<void>

Remarks

PresenceCode should correspond the possible values of the Presence property:

pcOffline (0)Invisible: JabberId is offline.
pcChat (1)Available: JabberId is online.
pcAway (2)Away: JabberId is online, but the user is away from their computer.
pcXA (3)Extended Away: JabberId is online, but the user is away from their computer for an extended period of time.
pcDND (4)Do not Disturb: JabberId is online, but is busy and does not wish to be disturbed.

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

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

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

XMPP.config Method

Sets or retrieves a configuration setting.

Syntax

async xmpp.config(configurationString : string): Promise<string>

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.

XMPP.connect Method

This method will connect the class to the server.

Syntax

async xmpp.connect(): Promise<void>

Remarks

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

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

XMPP.connectTo Method

This method will connect the class to the server.

Syntax

async xmpp.connectTo(user : string, password : string): Promise<void>

Remarks

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

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

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

XMPP.disconnect Method

This method disconnects the class from the server.

Syntax

async xmpp.disconnect(): Promise<void>

Remarks

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

XMPP.doEvents Method

This method processes events from the internal message queue.

Syntax

async xmpp.doEvents(): Promise<void>

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.

XMPP.interrupt Method

Interrupt the current method.

Syntax

async xmpp.interrupt(): Promise<void>

Remarks

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

XMPP.probePresence Method

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

Syntax

async xmpp.probePresence(jabberId : string): Promise<void>

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.

XMPP.queryRegister Method

This method queries a server for the necessary registration fields.

Syntax

async xmpp.queryRegister(XMPPServer : string): Promise<void>

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:

instructionsSpecial instructions sent from the server.
usernameThe username to be associated with this account.
passwordThe initial password for this account.
nameThe user's name.
emailThe user's email address.
addressThe user's physical address.
cityThe user's city of residence.
stateThe user's state (for United States citizens).
zipThe user's postal code (for United States citizens).
phoneThe user's phone number.
URLThe user's website.
dateThe date of registration.
miscAny miscellaneous data.
textAny extra text (potentially for a personal bio).
removeSpecifies a request to unregister.

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.

XMPP.register Method

This method registers an account with a server.

Syntax

async xmpp.register(XMPPServer : string): Promise<void>

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:

instructionsSpecial instructions sent from the server.
usernameThe username to be associated with this account.
passwordThe initial password for this account.
nameThe user's name.
emailThe user's email address.
addressThe user's physical address.
cityThe user's city of residence.
stateThe user's state (for United States citizens).
zipThe user's postal code (for United States citizens).
phoneThe user's phone number.
URLThe user's website.
dateThe date of registration.
miscAny miscellaneous data.
textAny extra text (potentially for a personal bio).
removeSpecifies a request to unregister.

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.

XMPP.remove Method

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

Syntax

async xmpp.remove(jabberId : string, name : string, group : string): Promise<void>

Remarks

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

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

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

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

XMPP.reset Method

Reset the class.

Syntax

async xmpp.reset(): Promise<void>

Remarks

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

XMPP.retrieveRoster Method

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

Syntax

async xmpp.retrieveRoster(): Promise<void>

Remarks

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

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

XMPP.sendCommand Method

This method sends a command to the server.

Syntax

async xmpp.sendCommand(command : string): Promise<void>

Remarks

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

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

XMPP.sendFile Method

Sends a file to the specified user.

Syntax

async xmpp.sendFile(jabberId : string): Promise<void>

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.

XMPP.sendMessage Method

This method will send a message to the specified user.

Syntax

async xmpp.sendMessage(jabberId : string): Promise<string>

Remarks

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

The class associates several properties with messages it receives and sends. When it receives a message, the class will parse out the corresponding values and set these properties before firing a MessageIn event. After the event returns control to the class, the properties will be cleared (ie, they will be set to the empty string, "").

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

The associated properties are the following:

MessageTypethe type of the message to be sent
MessageSubjectfor "headline" type messages, this is the subject
MessageThreadfor "chat" type messages, this is the thread on which the current message is a follow-up
MessageTextthe plain text of the message
MessageHTMLthe HTML version of the message
MessageOtherDataany extra data associated with the message but not required by the protocol.

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

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

XMPP.setUserInfoField Method

This method will add a user information field for registration.

Syntax

async xmpp.setUserInfoField(field : string, value : string): Promise<void>

Remarks

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

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

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

instructionsSpecial instructions sent from the server.
usernameThe username to be associated with this account.
passwordThe initial password for this account.
nameThe user's name.
emailThe user's email address.
addressThe user's physical address.
cityThe user's city of residence.
stateThe user's state (for United States citizens).
zipThe user's postal code (for United States citizens).
phoneThe user's phone number.
URLThe user's website.
dateThe date of registration.
miscAny miscellaneous data.
textAny extra text (potentially for a personal bio).
removeSpecifies a request to unregister.

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.

XMPP.subscribeTo Method

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

Syntax

async xmpp.subscribeTo(jabberId : string): Promise<void>

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.

XMPP.unregister Method

This method cancels an account with the host.

Syntax

async xmpp.unregister(): Promise<void>

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.

XMPP.unsubscribeTo Method

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

Syntax

async xmpp.unsubscribeTo(jabberId : string): Promise<void>

Remarks

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

XMPP.updateBuddyGroup Method

Updates the buddy's associatd groups.

Syntax

async xmpp.updateBuddyGroup(buddyIndex : number, group : string): Promise<void>

Remarks

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

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

XMPP.BuddyUpdate Event

This event is fired whenever a roster entry is updated.

Syntax

xmpp.on('BuddyUpdate', listener: (e: {readonly buddyIdx: number}) => void )

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.

XMPP.Connected Event

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

Syntax

xmpp.on('Connected', listener: (e: {readonly statusCode: number, readonly description: string}) => void )

Remarks

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

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

Please refer to the Error Codes section for more information.

XMPP.ConnectionStatus Event

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

Syntax

xmpp.on('ConnectionStatus', listener: (e: {readonly connectionEvent: string, readonly statusCode: number, readonly description: string}) => void )

Remarks

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

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

Firewall connection complete.
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable).
Remote host connection complete.
Remote host disconnected.
SSL or S/Shell connection broken.
Firewall host disconnected.
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.

XMPP.Disconnected Event

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

Syntax

xmpp.on('Disconnected', listener: (e: {readonly statusCode: number, readonly description: string}) => void )

Remarks

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

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

Please refer to the Error Codes section for more information.

XMPP.EndTransfer Event

Fired when a file transfer completes.

Syntax

xmpp.on('EndTransfer', listener: (e: {readonly direction: number, readonly fileId: string, readonly filename: string, readonly success: boolean}) => void )

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.

XMPP.Error Event

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

Syntax

xmpp.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

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

XMPP.IQ Event

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

Syntax

xmpp.on('IQ', listener: (e: {readonly iq: string, readonly id: string, readonly from: string, readonly iqType: string, ignore: boolean}) => void )

Remarks

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

"get"The IQ is requesting information from this XMPP client.
"set"The IQ is attempting to set a value..
"result"The IQ is a success response to a previous IQ.
"error"The IQ is an error response to a previous IQ.

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

XMPP.MessageIn Event

This event is fired upon receipt of a message.

Syntax

xmpp.on('MessageIn', listener: (e: {readonly messageId: string, readonly from: string, readonly domain: string, readonly resource: string, readonly messageType: number, readonly subject: string, readonly messageThread: string, readonly messageText: string, readonly messageHTML: string, readonly other: string}) => void )

Remarks

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

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

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

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

XMPP.PITrail Event

This event is fired for all protocol messages.

Syntax

xmpp.on('PITrail', listener: (e: {readonly direction: number, readonly pi: string}) => void )

Remarks

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

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

The direction parameter shows the originator of the message:

0 (Client)Pi originates from the client.
1 (Server)Pi originates from the server.
2 (Info)Pi is an informative message originating from within the class.

The Pi parameter contains the PI message.

XMPP.Presence Event

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

Syntax

xmpp.on('Presence', listener: (e: {readonly user: string, readonly domain: string, readonly resource: string, readonly availability: number, readonly status: string}) => void )

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:

pcOffline (0)Invisible: JabberId is offline.
pcChat (1)Available: JabberId is online.
pcAway (2)Away: JabberId is online, but the user is away from their computer.
pcXA (3)Extended Away: JabberId is online, but the user is away from their computer for an extended period of time.
pcDND (4)Do not Disturb: JabberId is online, but is busy and does not wish to be disturbed.

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

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

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

XMPP.ReadyToSend Event

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

Syntax

xmpp.on('ReadyToSend', listener: (e: {}) => void )

Remarks

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

XMPP.SSLServerAuthentication Event

Fired after the server presents its certificate to the client.

Syntax

xmpp.on('SSLServerAuthentication', listener: (e: {readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void )

Remarks

This event fires with information about the server certificate. The Status property shows why verification failed (otherwise, Status contains the string OK). To manually accept an untrusted certificate, the SSLAcceptAnyServerCert setting must be set to True before initiating the connection.

XMPP.SSLStatus Event

Fired when secure connection progress messages are available.

Syntax

xmpp.on('SSLStatus', listener: (e: {readonly message: string}) => void )

Remarks

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

XMPP.StartTransfer Event

Fired when a file transfer begins.

Syntax

xmpp.on('StartTransfer', listener: (e: {readonly direction: number, readonly fileId: string, readonly user: string, readonly domain: string, readonly resource: string, filename: string, readonly datetime: string, readonly size: number, accept: boolean}) => void )

Remarks

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

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

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

XMPP.SubscriptionRequest Event

This event fires when a subscription request is received.

Syntax

xmpp.on('SubscriptionRequest', listener: (e: {readonly from: string, readonly domain: string, accept: boolean}) => void )

Remarks

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

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

XMPP.Sync Event

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

Syntax

xmpp.on('Sync', listener: (e: {}) => void )

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:

Id the jabber ids associated with the buddies
Group the group associated with each entry (if a buddy is in more than one group, they will have multiple entries in the buddy list)
Subscription the subscription type for each buddy

Please refer to Buddies properties property for more information.

XMPP.Transfer Event

Fired during file transfer.

Syntax

xmpp.on('Transfer', listener: (e: {readonly direction: number, readonly fileId: string, readonly filename: string, readonly bytesTransferred: number, readonly percentDone: number, readonly text: string, readonly textB: Uint8Array, cancel: boolean}) => void )

Remarks

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

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

Text contains the portion of the file data being delivered.

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

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

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

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

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

Certificate Type

This is the digital certificate being used.

Remarks

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

Fields

EffectiveDate
string (read-only)

Default Value: ""

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

Encoded
string

Default Value: ""

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

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

EncodedB
Uint8Array

Default Value: ""

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

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

ExpirationDate
string (read-only)

Default Value: ""

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
string

Default Value: ""

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

Fingerprint
string (read-only)

Default Value: ""

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

FingerprintSHA1
string (read-only)

Default Value: ""

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

FingerprintSHA256
string (read-only)

Default Value: ""

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

Issuer
string (read-only)

Default Value: ""

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

KeyPassword
string

Default Value: ""

This is the password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the . . This field can be used to read such password-protected private keys.

Note: this property defaults to the value of . To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling .

PrivateKey
string (read-only)

Default Value: ""

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

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

PrivateKeyAvailable
boolean (read-only)

Default Value: False

This property shows whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
string (read-only)

Default Value: ""

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

PublicKey
string (read-only)

Default Value: ""

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

PublicKeyAlgorithm
string

Default Value: ""

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

PublicKeyLength
number (read-only)

Default Value: 0

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

SerialNumber
string (read-only)

Default Value: ""

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

SignatureAlgorithm
string (read-only)

Default Value: ""

The property contains 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.

Store
string

Default Value: "MY"

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

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

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

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

StoreB
Uint8Array

Default Value: "MY"

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

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

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

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

StorePassword
string

Default Value: ""

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

StoreType
CertStoreTypes

Default Value: 0

This is the type of certificate store for this certificate.

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

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

Note: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

Note: this store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

Note: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

Note: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the and set to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Subject
string

Default Value: ""

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

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

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

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

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

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

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

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

SubjectAltNames
string (read-only)

Default Value: ""

This property contains comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
string (read-only)

Default Value: ""

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

ThumbprintSHA1
string (read-only)

Default Value: ""

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

ThumbprintSHA256
string (read-only)

Default Value: ""

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

Usage
string

Default Value: ""

This property contains the text description of .

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

  • Digital Signatures
  • Key Authentication
  • Key Encryption
  • Data Encryption
  • Key Agreement
  • Certificate Signing
  • Key Signing

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

UsageFlags
number

Default Value: 0

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

0x80Digital Signatures
0x40Key Authentication (Non-Repudiation)
0x20Key Encryption
0x10Data Encryption
0x08Key Agreement
0x04Certificate Signing
0x02Key Signing

Please see the property for a text representation of .

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

Version
string (read-only)

Default Value: ""

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

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate(String certificateFile);

Opens CertificateFile and reads out the contents as an X.509 public key.

public Certificate(byte[] certificateData);

Parses CertificateData as an X.509 public key.

public Certificate(int certStoreType, String store, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

Firewall Type

The firewall the class will connect through.

Remarks

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

Fields

AutoDetect
boolean

Default Value: False

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

FirewallType
FirewallTypes

Default Value: 0

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

fwNone (0)No firewall (default setting).
fwTunnel (1)Connect through a tunneling proxy. is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. is set to 1080.

Host
string

Default Value: ""

This property contains the name or IP address of firewall (optional). If a 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 .

Password
string

Default Value: ""

This property contains a password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class .

Port
number

Default Value: 0

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

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

User
string

Default Value: ""

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

Constructors

public Firewall();



XMPPBuddy Type

A buddy in the XMPP buddy list.

Remarks

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

Fields

Group
string

Default Value: ""

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

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

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

Id
string (read-only)

Default Value: ""

This is the jabber id of the buddy.

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

NickName
string

Default Value: ""

The nickname of the buddy, if one exists.

RealName
string (read-only)

Default Value: ""

The real name of the buddy.

Subscription
XMPPBuddySubscriptions (read-only)

Default Value: 0

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

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

stNone (0) no subscription
stTo (1) the buddy has a subscription to this entity.
stFrom (2) this entity has a subscription to the buddy
stBoth (3) subscription is both to and from
stRemove (4) the item is to be removed from the list

Constructors

public XMPPBuddy();



XMPPUserInfo Type

A named registration field.

Remarks

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

Fields

Field
string

Default Value: ""

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

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

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

instructionsSpecial instructions sent from the server.
usernameThe username to be associated with this account.
passwordThe initial password for this account.
nameThe user's name.
emailThe user's email address.
addressThe user's physical address.
cityThe user's city of residence.
stateThe user's state (for United States citizens).
zipThe user's postal code (for United States citizens).
phoneThe user's phone number.
URLThe user's website.
dateThe date of registration.
miscAny miscellaneous data.
textAny extra text (potentially for a personal bio).
removeSpecifies a request to unregister.

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.

Value
string

Default Value: ""

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

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

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

instructionsSpecial instructions sent from the server.
usernameThe username to be associated with this account.
passwordThe initial password for this account.
nameThe user's name.
emailThe user's email address.
addressThe user's physical address.
cityThe user's city of residence.
stateThe user's state (for United States citizens).
zipThe user's postal code (for United States citizens).
phoneThe user's phone number.
URLThe user's website.
dateThe date of registration.
miscAny miscellaneous data.
textAny extra text (potentially for a personal bio).
removeSpecifies a request to unregister.

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.

Constructors

public XMPPUserInfo();



public XMPPUserInfo(String field, String value);



Config Settings (class ipworks.xmpp)

The class accepts one or more of the following configuration settings. Configuration 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.

XMPP Config Settings

AccessToken:   The OAuth access token used for authentication.

Specifies the OAuth access token used during authentication. This can be used when connecting to Facebook or Windows Live Messenger.

BlockSize:   Specifies the block size for file transfers.

The size in bytes of the block size used when sending files. The default value is 4096. Increasing this value may improve performance. However, some servers may not support larger block sizes.

ClientId:   The OAuth client Id used for authentication.

Specifies the OAuth client Id used during authentication. This can be used when connecting to Facebook. Windows Live Messenger does not require this value.

MessageId:   Specifies the number used in the message Id.

The value that is then converted to hex and appended to the XMPPMessage Id.

MessageXML:   Returns the last root-level element received by the component.

This returns the last root-level element received by the component. This could be a message, iq, presence, or any other element type.

Overwrite:   Specifies whether or not to overwrite received files.

The default value is false. If set to true, the class will overwrite the existing files in LocalDirectory if another file with the same name is received. This is only applicable when receiving file transfers.

ParseHTML:   Tells XMPP whether or not to parse MessageHTML when it's set.

If ParseHTML is true, the class will take any value sent to MessageHTML, compute a plaintext version of the text, and put it into the MessageText property.

RetrieveRoster:   Whether to automatically retrieve the roster when logging in.

When this configuration setting is set to True (default), the class will automatically retrieve the roster from the server when logging in. Setting this to False will cause the class to not request the roster, which can be useful when interacting with some non-standard XMPP servers.

SendSubscriptionResponse:   Determines whether a response will be sent to a Subscription Request.

When set to true, a response will be sent to a subscription request based upon the Accept parameter value of the SubscriptionRequest event. When set to false, a response will not be sent. Therefore a response can be created and sent using SendCommand outside of the SubscriptionRequest event. The default value is true.

UseCompression:   Specified whether or not stream compression is used.

The default value is false. If set to true, the class will use stream compression when communicating with the IMServer.

TCPClient Config Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class .

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class .

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

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

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

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

LocalPort:   The port in the local host where the class binds.

This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the class will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the class is the same.

SSLAcceptAnyServerCert:   Whether to trust any certificate presented by the server.

This setting disables all certificate verification when set to True. This configuration setting must be enabled to trust a self-signed certificate. It is not recommended to enable this configuration setting in a production environment. The default value is False.

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when SSLProvider is set to Internal: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when SSLProvider is set to Internal include:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30) [Platform Only]
SSL2 12 (Hex 0C) [Platform Only]

SSLEnabledProtocols - TLS 1.3 Notes

In the JavaScript edition the platform implementation is used when TLS 1.3 is enabled and SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is true by default, but can be set to false to disable the extension.

This setting is only applicable when SSLProvider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

Note: This setting is only applicable when SSLProvider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated cipher suite strength.

Returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

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

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class .

The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448" (default)
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096" (default)
  • "ffdhe_6144" (default)
  • "ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

This setting is set to false by default on all platforms.

Trappable Errors (class ipworks.xmpp)

XMPP Errors

202   Invalid argument.
432   Array index out of bounds.
600   XMPP protocol error (server returned an error code; description follows).
601   Server disconnected.
602   Cannot change this property while connected.
603   Invalid XML received from server.
604   Invalid response received from server.
605   Server indicates TLS is required.
606   User requested SSL, but server does not support it.
607   Cannot authenticate.
620   Error hashing password.

TCPClient Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102   The RemoteHost address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the LocalPort at this time. A connection is in progress.
107   You cannot change the LocalHost at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
117   You cannot change the UseConnection option while the class is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).