org.request
===========

.. py:module:: org.request


Classes
-------

.. autoapisummary::

   org.request.PageMeta
   org.request.OrgRequest


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

.. py:class:: PageMeta

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: id
      :type:  int


   .. py:attribute:: type
      :type:  str


   .. py:attribute:: title
      :type:  str


   .. py:attribute:: access
      :type:  str


   .. py:attribute:: published
      :type:  bool


   .. py:attribute:: is_visible_on_homepage
      :type:  bool | None


   .. py:attribute:: path
      :type:  str


   .. py:attribute:: children
      :type:  tuple[PageMeta, Ellipsis]


   .. py:method:: link(request: OrgRequest, variables: dict[str, Any] | None = None, name: str = '') -> str


.. py:class:: OrgRequest(*args, **kwargs)

   Bases: :py:obj:`onegov.core.request.CoreRequest`


   Extends the default Morepath request with virtual host support and
   other useful methods.

   Virtual hosting might be supported by Morepath directly in the future:
   https://github.com/morepath/morepath/issues/185



   .. py:attribute:: app
      :type:  onegov.org.app.OrgApp

      :class:`morepath.App` instance currently handling request.
              



   .. py:property:: is_manager
      :type: bool


      Returns true if the current user is logged in, and has the role
      editor or admin.




   .. py:method:: is_manager_for_model(model: object) -> bool


   .. py:property:: is_admin
      :type: bool


      Returns true if the current user is an admin.

              



   .. py:property:: is_editor
      :type: bool


      Returns true if the current user is an editor.

              



   .. py:property:: is_supporter
      :type: bool


      Returns true if the current user is a supporter.

              



   .. py:property:: current_username
      :type: str | None



   .. py:property:: current_user
      :type: onegov.user.User | None



   .. py:property:: first_admin_available
      :type: onegov.user.User | None



   .. py:property:: auto_accept_user
      :type: onegov.user.User | None



   .. py:property:: email_for_new_tickets
      :type: str | None



   .. py:property:: active_mtan_session
      :type: bool



   .. py:property:: mtan_accesses
      :type: onegov.org.models.TANAccessCollection



   .. py:property:: mtan_access_limit_exceeded
      :type: bool



   .. py:method:: auto_accept(ticket: onegov.ticket.Ticket) -> bool


   .. py:method:: pages_tree() -> tuple[PageMeta, Ellipsis]

      This is the entire pages tree preloaded into the individual
      parent/children attributes. We optimize this as much as possible
      by performing the recursive join in Python, rather than SQL.




   .. py:method:: root_pages() -> tuple[PageMeta, Ellipsis]


   .. py:method:: homepage_pages() -> dict[int, list[PageMeta]]