IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

IMPort Property

The server port for XMPP (default 5222).

Syntax

 xmpp.getIMPort([callback])
 xmpp.setIMPort( IMPort, [callback])

Default Value

5222


Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getIMPort([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setIMPort([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

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

Data Type

Integer

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0