user_info_field Property
This is the name of the current property necessary for registration.
Syntax
def get_user_info_field(field_index: int) -> str: ... def set_user_info_field(field_index: int, value: str) -> None: ...
Default Value
""
Remarks
This is the name of the current property necessary for registration.
Before a registration can be attempted, the application should use the on_query_register 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 user_info properties accordingly. After a successful query, all entries in user_info 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. |
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 user_info, and added any extra fields they may wish to include in their registration, the application should make a call to on_register.
If the class is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.
The field_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_info_count property.