tik_manager4.objects.commons
============================

.. py:module:: tik_manager4.objects.commons

.. autoapi-nested-parse::

   Commons module for tik_manager4 package.



Classes
-------

.. autoapisummary::

   tik_manager4.objects.commons.Commons


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

.. py:class:: Commons(folder_path)

   Class to handle the common settings and user data


   .. py:method:: check_user_permission_level(user_name)

      Return the permission level for given user.

      Args:
          user_name (str): The name of the user.

      Returns:
          int: The permission level of the user.



   .. py:method:: collect_common_modules(dcc_name, module_type)

      Collect the available studio-specific dcc modules.



   .. py:method:: get_project_structures()

      Return list of available project structures defined in defaults.



   .. py:method:: get_user_email(user_name)

      Return the email of the user.

      Args:
          user_name (str): The name of the user.

      Returns:
          str: The email of the user.



   .. py:method:: get_users()

      Return the list of all active users.



   .. py:property:: folder_path
      Return the folder path.



   .. py:property:: id
      Return the commons id.



   .. py:attribute:: metadata
      :value: None



   .. py:property:: name
      Return the commons name.



   .. py:attribute:: project_settings
      :value: None



   .. py:attribute:: structures
      :value: None



   .. py:attribute:: template
      :value: None



   .. py:attribute:: user_defaults
      :value: None



   .. py:attribute:: users
      :value: None