org.views.directory
===================

.. py:module:: org.views.directory


Classes
-------

.. autoapisummary::

   org.views.directory.DirectoryEntryWithNumber
   org.views.directory.Filter


Functions
---------

.. autoapisummary::

   org.views.directory.get_directory_form_class
   org.views.directory.get_directory_entry_form_class
   org.views.directory.get_submission_form_class
   org.views.directory.get_change_request_form_class
   org.views.directory.view_directories
   org.views.directory.view_directory_redirect
   org.views.directory.handle_new_directory
   org.views.directory.handle_edit_directory
   org.views.directory.delete_directory
   org.views.directory.change_directory_url
   org.views.directory.get_filters
   org.views.directory.keyword_count
   org.views.directory.view_directory
   org.views.directory.view_geojson
   org.views.directory.send_email_notification_for_directory_entry
   org.views.directory.handle_new_directory_entry
   org.views.directory.handle_edit_directory_entry
   org.views.directory.handle_submit_directory_entry
   org.views.directory.handle_change_request
   org.views.directory.view_directory_entry
   org.views.directory.delete_directory_entry
   org.views.directory.view_export
   org.views.directory.view_zip_file
   org.views.directory.view_import
   org.views.directory.execute_submission_action
   org.views.directory.new_recipient
   org.views.directory.view_directory_entry_update_recipients
   org.views.directory.view_confirm
   org.views.directory.view_unsubscribe
   org.views.directory.view_unsubscribe_rfc8058


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

.. py:class:: DirectoryEntryWithNumber

   Bases: :py:obj:`onegov.org.models.ExtendedDirectoryEntry`


   A single entry of a directory. 


   .. py:attribute:: number
      :type:  str | int | None


.. py:function:: get_directory_form_class(model: object, request: onegov.org.request.OrgRequest) -> type[onegov.org.forms.DirectoryForm]

.. py:function:: get_directory_entry_form_class(model: onegov.org.models.ExtendedDirectoryEntry, request: onegov.org.request.OrgRequest) -> type[onegov.directory.models.directory.DirectoryEntryForm]

.. py:function:: get_submission_form_class(model: onegov.org.models.ExtendedDirectoryEntry, request: onegov.org.request.OrgRequest) -> type[onegov.org.models.directory.ExtendedDirectoryEntryForm]

.. py:function:: get_change_request_form_class(model: onegov.org.models.ExtendedDirectoryEntry, request: onegov.org.request.OrgRequest) -> type[onegov.org.models.directory.ExtendedDirectoryEntryForm]

.. py:function:: view_directories(self: onegov.directory.DirectoryCollection[Any], request: onegov.org.request.OrgRequest, layout: onegov.org.layout.DirectoryCollectionLayout | None = None) -> onegov.core.types.RenderData

.. py:function:: view_directory_redirect(self: onegov.directory.Directory, request: onegov.org.request.OrgRequest) -> webob.Response

.. py:function:: handle_new_directory(self: onegov.directory.DirectoryCollection[Any], request: onegov.org.request.OrgRequest, form: onegov.org.forms.DirectoryForm, layout: onegov.org.layout.DirectoryCollectionLayout | None = None) -> onegov.core.types.RenderData | webob.Response

.. py:function:: handle_edit_directory(self: onegov.org.models.directory.ExtendedDirectoryEntryCollection, request: onegov.org.request.OrgRequest, form: onegov.org.forms.DirectoryForm, layout: onegov.org.layout.DirectoryCollectionLayout | None = None) -> onegov.core.types.RenderData | webob.Response

.. py:function:: delete_directory(self: onegov.org.models.directory.ExtendedDirectoryEntryCollection, request: onegov.org.request.OrgRequest) -> None

.. py:function:: change_directory_url(self: onegov.directory.Directory, request: onegov.org.request.OrgRequest, form: onegov.org.forms.directory.DirectoryUrlForm, layout: onegov.org.layout.DefaultLayout | None = None) -> onegov.core.types.RenderData | webob.Response

.. py:class:: Filter

   Bases: :py:obj:`NamedTuple`


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


   .. py:attribute:: tags
      :type:  collections.abc.Sequence[onegov.core.elements.Link]


.. py:function:: get_filters(request: onegov.org.request.OrgRequest, self: onegov.org.models.directory.ExtendedDirectoryEntryCollection, keyword_counts: collections.abc.Mapping[str, collections.abc.Mapping[str, int]] | None = None, view_name: str = '') -> list[Filter]

.. py:function:: keyword_count(request: onegov.org.request.OrgRequest, collection: onegov.org.models.directory.ExtendedDirectoryEntryCollection) -> dict[str, dict[str, int]]

.. py:function:: view_directory(self: onegov.org.models.directory.ExtendedDirectoryEntryCollection, request: onegov.org.request.OrgRequest, layout: onegov.org.layout.DirectoryEntryCollectionLayout | None = None) -> onegov.core.types.RenderData

.. py:function:: view_geojson(self: onegov.org.models.directory.ExtendedDirectoryEntryCollection, request: onegov.org.request.OrgRequest) -> onegov.core.types.JSON_ro

.. py:function:: send_email_notification_for_directory_entry(directory: onegov.org.models.ExtendedDirectory, entry: onegov.org.models.ExtendedDirectoryEntry, request: onegov.org.request.OrgRequest) -> None

.. py:function:: handle_new_directory_entry(self: onegov.org.models.directory.ExtendedDirectoryEntryCollection, request: onegov.org.request.OrgRequest, form: onegov.directory.models.directory.DirectoryEntryForm, layout: onegov.org.layout.DirectoryEntryCollectionLayout | None = None) -> onegov.core.types.RenderData | webob.Response

.. py:function:: handle_edit_directory_entry(self: onegov.directory.DirectoryEntry, request: onegov.org.request.OrgRequest, form: onegov.directory.models.directory.DirectoryEntryForm, layout: onegov.org.layout.DirectoryEntryLayout | None = None) -> onegov.core.types.RenderData | webob.Response

.. py:function:: handle_submit_directory_entry(self: onegov.org.models.directory.ExtendedDirectoryEntryCollection, request: onegov.org.request.OrgRequest, form: onegov.org.models.directory.ExtendedDirectoryEntryForm, layout: onegov.org.layout.DirectoryEntryCollectionLayout | None = None) -> onegov.core.types.RenderData | webob.Response

.. py:function:: handle_change_request(self: onegov.org.models.ExtendedDirectoryEntry, request: onegov.org.request.OrgRequest, form: onegov.org.models.directory.ExtendedDirectoryEntryForm, layout: onegov.org.layout.DirectoryEntryLayout | None = None) -> onegov.core.types.RenderData | webob.Response

.. py:function:: view_directory_entry(self: onegov.org.models.ExtendedDirectoryEntry, request: onegov.org.request.OrgRequest, layout: onegov.org.layout.DirectoryEntryLayout | None = None) -> onegov.core.types.RenderData

.. py:function:: delete_directory_entry(self: onegov.directory.DirectoryEntry, request: onegov.org.request.OrgRequest) -> None

.. py:function:: view_export(self: onegov.org.models.directory.ExtendedDirectoryEntryCollection, request: onegov.org.request.OrgRequest, form: onegov.org.forms.generic.ExportForm, layout: onegov.org.layout.DirectoryEntryCollectionLayout | None = None) -> onegov.core.types.RenderData | webob.Response

.. py:function:: view_zip_file(self: onegov.org.models.directory.ExtendedDirectoryEntryCollection, request: onegov.org.request.OrgRequest) -> webob.Response

.. py:function:: view_import(self: onegov.org.models.directory.ExtendedDirectoryEntryCollection, request: onegov.org.request.OrgRequest, form: onegov.org.forms.DirectoryImportForm, layout: onegov.org.layout.DirectoryEntryCollectionLayout | None = None) -> onegov.core.types.RenderData | webob.Response

.. py:function:: execute_submission_action(self: onegov.org.models.DirectorySubmissionAction, request: onegov.org.request.OrgRequest) -> None

.. py:function:: new_recipient(self: onegov.org.models.directory.ExtendedDirectoryEntryCollection, request: onegov.org.request.OrgRequest, form: onegov.org.forms.directory.DirectoryRecipientForm, layout: onegov.org.layout.DirectoryEntryCollectionLayout | None = None, mail_layout: onegov.org.layout.DefaultMailLayout | None = None) -> onegov.core.types.RenderData | webob.Response

.. py:function:: view_directory_entry_update_recipients(self: onegov.org.models.directory.ExtendedDirectoryEntryCollection, request: onegov.org.request.OrgRequest, layout: onegov.org.layout.DirectoryEntryCollectionLayout | None = None) -> onegov.core.types.RenderData | webob.Response

.. py:function:: view_confirm(self: onegov.directory.models.directory.EntrySubscription, request: onegov.org.request.OrgRequest) -> webob.Response

.. py:function:: view_unsubscribe(self: onegov.directory.models.directory.EntrySubscription, request: onegov.org.request.OrgRequest) -> webob.Response

.. py:function:: view_unsubscribe_rfc8058(self: onegov.directory.models.directory.EntrySubscription, request: onegov.org.request.OrgRequest) -> webob.Response