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.

Method List

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

Event List

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

Config Settings

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

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.

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.

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:

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:

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.

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.

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:

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.

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:

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:

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:

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.

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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

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

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

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

Constructors

public XMPPUserInfo();

public XMPPUserInfo(String field, String value);

Config Settings (class ipworks.xmpp)

XMPP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (class ipworks.xmpp)

XMPP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors