election_day.collections.notifications
======================================

.. py:module:: election_day.collections.notifications


Classes
-------

.. autoapisummary::

   election_day.collections.notifications.NotificationCollection


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

.. py:class:: NotificationCollection(session: sqlalchemy.orm.Session)

   .. py:attribute:: session


   .. py:method:: query() -> sqlalchemy.orm.Query[onegov.election_day.models.Notification]


   .. py:method:: by_model(model: onegov.election_day.models.Election | onegov.election_day.models.ElectionCompound | onegov.election_day.models.Vote, current: bool = True) -> list[onegov.election_day.models.Notification]

      Returns the notification for the given election or vote and its
      modification times. Only returns the current by default.




   .. py:method:: trigger(request: onegov.election_day.request.ElectionDayRequest, model: onegov.election_day.models.Election | onegov.election_day.models.ElectionCompound | onegov.election_day.models.Vote, options: collections.abc.Collection[str]) -> None

      Triggers and adds the selected notifications. 



   .. py:method:: trigger_summarized(request: onegov.election_day.request.ElectionDayRequest, elections: collections.abc.Sequence[onegov.election_day.models.Election], election_compounds: collections.abc.Sequence[onegov.election_day.models.ElectionCompound], votes: collections.abc.Sequence[onegov.election_day.models.Vote], options: collections.abc.Collection[str]) -> None

      Triggers and adds a single notification for all given votes and
      elections.