magpie.ui.user.views
====================

.. py:module:: magpie.ui.user.views


Attributes
----------

.. autoapisummary::

   magpie.ui.user.views.LOGGER


Classes
-------

.. autoapisummary::

   magpie.ui.user.views.UserViews


Module Contents
---------------

.. py:data:: LOGGER

.. py:class:: UserViews(request)

   Bases: :py:obj:`magpie.ui.utils.BaseViews`


   Base methods for Magpie UI pages.


   .. py:method:: add_template_data(data=None)

      Adds required template data for the 'heading' mako template applied to every UI page.



   .. py:method:: get_current_user_groups(user_group_status: magpie.models.UserGroupStatus = UserGroupStatus.ACTIVE) -> magpie.typedefs.List[str]


   .. py:method:: get_current_user_info() -> magpie.typedefs.JSON


   .. py:method:: get_discoverable_groups() -> magpie.typedefs.List[str]


   .. py:method:: join_discoverable_group(group_name)

      Registers the current user to the discoverable group.

      :raises HTTPBadRequest: if the operation is not valid.



   .. py:method:: leave_discoverable_group(group_name: magpie.typedefs.Str) -> None

      Unregisters the current user from the discoverable group.

      :raises HTTPBadRequest: if the operation is not valid.



   .. py:method:: edit_current_user()

      Edit the own fields of the current user profile (self-update information).

      .. seealso::
          - :meth:`magpie.ui.management.views.ManagementViews.edit_user` for corresponding operation by administrator