IPWorks IoT 2020 Python Edition

Questions / Feedback?

set_user_info_field Method

This method will add a user information field for registration.

Syntax

def set_user_info_field(field: str, value: str) -> None: ...

Remarks

This method will search through user_info for the field name in Field and set the corresponding value to Value. If the field was not previously contained in user_info, it will automatically added.

Before a registration can be attempted, the application should use the 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:

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 user_info, and added any extra fields 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 fields, and then disconnect.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks IoT 2020 Python Edition - Version 20.0 [Build 8265]