pyanaconda.modules.payloads.payload.payload_base_interface
==========================================================

.. py:module:: pyanaconda.modules.payloads.payload.payload_base_interface


Classes
-------

.. autoapisummary::

   pyanaconda.modules.payloads.payload.payload_base_interface.PayloadBaseInterface


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

.. py:class:: PayloadBaseInterface

   Bases: :py:obj:`pyanaconda.modules.common.base.base_template.ModuleInterfaceTemplate`


   Base class for all the payload module interfaces.

   This object contains API shared by all the payloads. Everything in this object has
   to be implemented by a payload to be usable.


   .. py:method:: connect_signals()

      Connect the signals.



   .. py:property:: Type
      :type: Str


      Type of this payload.

      Possible types are values of the payload.base.constants.PayloadType enum

      :return: a string representation of a payload type


   .. py:property:: DefaultSourceType
      :type: Str


      Type of the default source.

      See the SourceType enum for valid values.

      :return: a string representation of a source type


   .. py:property:: SupportedSourceTypes
      :type: List[Str]


      Get list of supported source types.

      See the SourceType enum for valid values.

      :return: a list of string representations of source types


   .. py:property:: Sources
      :type: List[ObjPath]


      Get list of sources attached to this payload.


   .. py:method:: SetUpSourcesWithTask()

      Set up installation sources.



   .. py:method:: TearDownSourcesWithTask()

      Tear down installation sources.