UserInfoValue Property

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

Syntax

 xmpp.getUserInfoValue(index, [callback])
 xmpp.setUserInfoValue(index,  userInfoValue, [callback])

Default Value

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 getUserInfoValue([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 setUserInfoValue([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

This is the value for the current registration property, 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 properties 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 properties are defined in the Jabber protocol specification as follows:


instructions	Special instructions sent from the server.
username	The username to be associated with this account.
password	The initial password for this account.
name	The user's name.
email	The user's email address.
address	The user's physical address.
city	The user's city of residence.
state	The user's state (for United States citizens).
zip	The user's postal code (for United States citizens).
phone	The user's phone number.
URL	The user's website.
date	The date of registration.
misc	Any miscellaneous data.
text	Any extra text (potentially for a personal bio).
remove	Specifies a request to unregister.

After the user has set all of the values in UserInfo, and added any extra properties 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 properties, and then disconnect.

The size of the array is controlled by the UserInfoCount property.

This property is not available at design time.

Data Type

String