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

UserInfoField Property

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

Syntax

 xmpp.getUserInfoField(index, [callback])
 xmpp.setUserInfoField(index,  userInfoField, [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 getUserInfoField([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 setUserInfoField([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 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 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:

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

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