:py:mod:`wfexs_backend.pushers.abstract_token_export`
=====================================================

.. py:module:: wfexs_backend.pushers.abstract_token_export

.. autodoc2-docstring:: wfexs_backend.pushers.abstract_token_export
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`AbstractTokenExportPlugin <wfexs_backend.pushers.abstract_token_export.AbstractTokenExportPlugin>`
     -

API
~~~

.. py:class:: AbstractTokenExportPlugin(refdir: pathlib.Path, setup_block: Optional[SecurityContextConfig] = None, default_licences: Sequence[LicenceDescription] = [], default_orcids: Sequence[ResolvedORCID] = [], default_preferred_id: Optional[str] = None)
   :canonical: wfexs_backend.pushers.abstract_token_export.AbstractTokenExportPlugin

   Bases: :py:obj:`wfexs_backend.pushers.AbstractDraftedExportPlugin`

   .. py:method:: get_file_bucket_prefix(draft_entry: wfexs_backend.pushers.DraftEntry) -> str
      :canonical: wfexs_backend.pushers.abstract_token_export.AbstractTokenExportPlugin.get_file_bucket_prefix
      :abstractmethod:

      .. autodoc2-docstring:: wfexs_backend.pushers.abstract_token_export.AbstractTokenExportPlugin.get_file_bucket_prefix

   .. py:method:: get_api_prefix() -> str
      :canonical: wfexs_backend.pushers.abstract_token_export.AbstractTokenExportPlugin.get_api_prefix

      .. autodoc2-docstring:: wfexs_backend.pushers.abstract_token_export.AbstractTokenExportPlugin.get_api_prefix

   .. py:method:: push(items: Sequence[AnyContent], preferred_id: Optional[str] = None, title: Optional[str] = None, description: Optional[str] = None, licences: Sequence[LicenceDescription] = [], resolved_orcids: Sequence[ResolvedORCID] = [], metadata: Optional[Mapping[str, Any]] = None, community_specific_metadata: Optional[Mapping[str, Any]] = None) -> Sequence[URIWithMetadata]
      :canonical: wfexs_backend.pushers.abstract_token_export.AbstractTokenExportPlugin.push

      .. autodoc2-docstring:: wfexs_backend.pushers.abstract_token_export.AbstractTokenExportPlugin.push