wapi.user#
Use this module to interact with the wizard user account.
- wapi.user.set(user_name, password)#
Log the given user in wizard.
- Parameters:
user_name (str) – The user name
password (str) – The user’s password
- Returns:
The success.
- Return type:
bool
- wapi.user.get()#
Return the current wizard user.
- Returns:
The current wizard user.
- Return type:
str
- wapi.user.change_password(old_password, new_password)#
Change the password of the current user.
- Parameters:
old_password (str) – The old password of the current user
new_password (str) – The new password of the current user
- Returns:
The success.
- Return type:
bool
- wapi.user.is_admin()#
Return True if the current user is administrator, else return False.
- Returns:
The administrator status of the curren user.
- Return type:
bool
- wapi.user.set_team_dns(host, port)#
Modify the current team server DNS with the given host and port.
- Parameters:
host (str) – The server host
port (int) – The server port
- Returns:
The success.
- Return type:
bool
- wapi.user.get_team_dns()#
Return the current team server DNS
- Returns:
The team dns as a list with host and port, or None
- Return type:
[str, int] or bool
- wapi.user.set_popups_settings(enabled=1, duration=3, keep_until_comment=True)#
Modify current user popups settings with the given arguments.
- Parameters:
enabled (bool or int) – Enable the popups
duration (int) – The popups duration in seconds
keep_until_comment (bool) – Enable keeping the popups until comment
- Returns:
The success.
- Return type:
bool