fsi.layouts.notification
========================

.. py:module:: fsi.layouts.notification


Classes
-------

.. autoapisummary::

   fsi.layouts.notification.MailLayout
   fsi.layouts.notification.NotificationTemplateCollectionLayout
   fsi.layouts.notification.NotificationTemplateLayout
   fsi.layouts.notification.EditNotificationTemplateLayout
   fsi.layouts.notification.SendNotificationTemplateLayout


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

.. py:class:: MailLayout(model: Any, request: onegov.core.request.CoreRequest)

   Bases: :py:obj:`onegov.org.layout.DefaultMailLayout`, :py:obj:`onegov.fsi.layout.FormatMixin`


   Layout for emails expecting the model to be a subscription object.
   Takes in a notification template linked to a course_event.


   .. py:attribute:: app
      :type:  onegov.fsi.app.FsiApp

      Returns the application behind the request. 



   .. py:attribute:: request
      :type:  onegov.fsi.request.FsiRequest


   .. py:attribute:: model
      :type:  onegov.fsi.models.CourseNotificationTemplate


   .. py:property:: title
      :type: str



   .. py:property:: default_macros
      :type: onegov.core.templates.MacrosLookup



   .. py:property:: edit_link
      :type: str



   .. py:property:: base
      :type: chameleon.PageTemplateFile


      Returns the layout, which defines the base layout of all pages.

      See ``templates/layout.pt``.




   .. py:property:: event_start
      :type: str



   .. py:property:: event_end
      :type: str



   .. py:property:: event_date
      :type: str



   .. py:property:: course_name
      :type: str



   .. py:property:: course_description
      :type: str



   .. py:property:: reservation_name
      :type: str



   .. py:property:: event_url
      :type: str



   .. py:property:: course_url
      :type: str



   .. py:property:: upcoming_events_collection
      :type: onegov.fsi.collections.course_event.CourseEventCollection



   .. py:property:: open_events_url
      :type: str



   .. py:property:: events_list
      :type: list[onegov.fsi.models.CourseEvent]



   .. py:property:: notification_type
      :type: str



.. py:class:: NotificationTemplateCollectionLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`onegov.fsi.layout.DefaultLayout`


   The default layout meant for the public facing parts of the site. 


   .. py:attribute:: model
      :type:  onegov.fsi.collections.notification_template.CourseNotificationTemplateCollection


   .. py:property:: title
      :type: str



   .. py:property:: breadcrumbs
      :type: list[onegov.core.elements.Link]


      Returns the breadcrumbs for the current page. 



   .. py:class:: AccordionItem

      Bases: :py:obj:`NamedTuple`


      .. py:attribute:: subject
         :type:  str | None


      .. py:attribute:: text
         :type:  str | None


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


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



   .. py:method:: accordion_items() -> tuple[AccordionItem, Ellipsis]


.. py:class:: NotificationTemplateLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`onegov.fsi.layout.DefaultLayout`


   The default layout meant for the public facing parts of the site. 


   .. py:attribute:: model
      :type:  onegov.fsi.models.CourseNotificationTemplate


   .. py:property:: title
      :type: str



   .. py:property:: collection
      :type: onegov.fsi.collections.notification_template.CourseNotificationTemplateCollection



   .. py:property:: breadcrumbs
      :type: list[onegov.core.elements.Link]


      Returns the breadcrumbs for the current page. 



   .. py:property:: editbar_links
      :type: list[onegov.core.elements.Link | onegov.core.elements.LinkGroup]


      A of :class:`onegov.org.elements.LinkGroup` classes. Each of them
      will be shown in the top editbar, with the group title being the
      dropdown title.



.. py:class:: EditNotificationTemplateLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`NotificationTemplateLayout`


   The default layout meant for the public facing parts of the site. 


   .. py:property:: title
      :type: str



   .. py:property:: breadcrumbs
      :type: list[onegov.core.elements.Link]


      Returns the breadcrumbs for the current page. 



.. py:class:: SendNotificationTemplateLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`NotificationTemplateLayout`


   The default layout meant for the public facing parts of the site. 


   .. py:property:: title
      :type: str



   .. py:property:: breadcrumbs
      :type: list[onegov.core.elements.Link]


      Returns the breadcrumbs for the current page.