sidequest_common.models.role_menus
==================================

.. py:module:: sidequest_common.models.role_menus

.. autoapi-nested-parse::

   Self-assignable role menus (button panels).



Classes
-------

.. autoapisummary::

   sidequest_common.models.role_menus.RoleMenu
   sidequest_common.models.role_menus.RoleMenuOption


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

.. py:class:: RoleMenu

   Bases: :py:obj:`advanced_alchemy.base.UUIDAuditBase`


   A message with one button per self-assignable role.


   .. py:attribute:: channel_id
      :type:  sqlalchemy.orm.Mapped[int]


   .. py:attribute:: description
      :type:  sqlalchemy.orm.Mapped[str | None]


   .. py:attribute:: guild_id
      :type:  sqlalchemy.orm.Mapped[int]


   .. py:attribute:: max_roles
      :type:  sqlalchemy.orm.Mapped[int]

      Max roles a member may hold from this menu at once; 0 = unlimited.



   .. py:attribute:: message_id
      :type:  sqlalchemy.orm.Mapped[int | None]


   .. py:attribute:: options
      :type:  sqlalchemy.orm.Mapped[list[RoleMenuOption]]


   .. py:attribute:: title
      :type:  sqlalchemy.orm.Mapped[str]


.. py:class:: RoleMenuOption

   Bases: :py:obj:`advanced_alchemy.base.UUIDAuditBase`


   One role button on a menu.


   .. py:attribute:: description
      :type:  sqlalchemy.orm.Mapped[str | None]


   .. py:attribute:: emoji
      :type:  sqlalchemy.orm.Mapped[str | None]


   .. py:attribute:: label
      :type:  sqlalchemy.orm.Mapped[str]


   .. py:attribute:: menu
      :type:  sqlalchemy.orm.Mapped[RoleMenu]


   .. py:attribute:: position
      :type:  sqlalchemy.orm.Mapped[int]


   .. py:attribute:: role_id
      :type:  sqlalchemy.orm.Mapped[int]


   .. py:attribute:: role_menu_id
      :type:  sqlalchemy.orm.Mapped[uuid.UUID]