=========
wapi.user
=========

Use this module to interact with the wizard user account.

.. py:function:: wapi.user.set(user_name, password)

   Log the given user in wizard.

   :param user_name: The user name
   :type user_name: str
   :param password: The user's password
   :type password: str
   :return: The success.
   :rtype: bool

.. py:function:: wapi.user.get()

   Return the current wizard user.

   :return: The current wizard user.
   :rtype: str

.. py:function:: wapi.user.change_password(old_password, new_password)

   Change the password of the current user.

   :param old_password: The old password of the current user
   :type old_password: str
   :param new_password: The new password of the current user
   :type new_password: str
   :return: The success.
   :rtype: bool

.. py:function:: wapi.user.is_admin()

   Return True if the current user is administrator, else return False.

   :return: The administrator status of the curren user.
   :rtype: bool

.. py:function:: wapi.user.set_team_dns(host, port)

   Modify the current team server DNS with the given host and port.

   :param host: The server host
   :type host: str
   :param port: The server port
   :type port: int
   :return: The success.
   :rtype: bool

.. py:function:: wapi.user.get_team_dns()

   Return the current team server DNS

   :return: The team dns as a list with host and port, or None
   :rtype: [str, int] or bool

.. py:function:: wapi.user.set_popups_settings(enabled=1, duration=3, keep_until_comment=True)

   Modify current user popups settings with the given arguments.

   :param enabled: Enable the popups
   :type enabled: bool or int
   :param duration: The popups duration in seconds
   :type duration: int
   :param keep_until_comment: Enable keeping the popups until comment
   :type keep_until_comment: bool
   :return: The success.
   :rtype: bool