|
|
IP*Works! V9
Questions / Feedback?
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 |
This is the name of the current field 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 collection
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:
| | | 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 fields they may wish to include in their registration,
the application should make a call to Register.
If the component is not already connected when this method is called, it will
connect, poll the registration fields, and then disconnect.
|
Value
String |
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 collection
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:
| | | 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 fields they may wish to include in their registration,
the application should make a call to Register.
If the component is not already connected when this method is called, it will
connect, poll the registration fields, and then disconnect.
|
Constructors
[VB.NET]
Public XMPPUserInfo()
[C#]
public XMPPUserInfo();
[VB.NET]
Public XMPPUserInfo(ByVal Field As String, ByVal Value As String)
[C#]
public XMPPUserInfo(string field, string value);
|