pyanaconda.modules.payloads.payloads_interface
==============================================

.. py:module:: pyanaconda.modules.payloads.payloads_interface


Classes
-------

.. autoapisummary::

   pyanaconda.modules.payloads.payloads_interface.PayloadsInterface


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

.. py:class:: PayloadsInterface

   Bases: :py:obj:`pyanaconda.modules.common.base.KickstartModuleInterface`


   DBus interface for Payload module.


   .. py:method:: connect_signals()

      Connect the signals.



   .. py:method:: CreatePayload(payload_type)

      Create payload and publish it on DBus.

      payload_type could contain these values:
       - DNF
       - LIVE_OS
       - LIVE_IMAGE



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


      List of all created payload modules.

      :return: a list of DBus paths


   .. py:method:: ActivatePayload(payload)

      Activate the payload.

      :param payload: a path to a payload



   .. py:property:: ActivePayload
      :type: Str


      The active payload.

      :return: a DBus path or an empty string


   .. py:method:: CreateSource(source_type)

      Create payload source and publish it on DBus.

      source_type could contain these values:
       - LIVE_OS_IMAGE



   .. py:method:: IsNetworkRequired()

      Do the sources require a network?

      :return: True or False



   .. py:method:: CalculateRequiredSpace()

      Calculate space required for the installation.

      :return: required size in bytes
      :rtype: int



   .. py:method:: GetKernelVersionList()

      Get the kernel versions list.

      The kernel version list doesn't have to be available
      before the payload installation.

      :return: a list of kernel versions
      :raises UnavailableValueError: if the list is not available



   .. py:method:: PostInstallWithTasks()

      Return a list of post-installation tasks.

      :return: a list of object paths of installation tasks