:right-sidebar: True

ImportInteraction
===================================================================

.. currentmodule:: gi.repository.Gcr





.. class:: ImportInteraction(*args, **kwargs)
   :no-contents-entry:






This is an interface implemented by a caller performing an import. It allows
the importer to ask the caller for further information about the import.

It must be implemented on a derived class of :obj:`~gi.repository.Gio.TlsInteraction`





Methods
-------

.. rst-class:: interim-class

.. class:: ImportInteraction
   :no-index:


   .. method:: supplement(builder: ~gi.repository.Gck.Builder, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.Gio.TlsInteractionResult

      Supplement attributes before import. This means prompting the user for
      things like labels and the like. The needed attributes will have been passed
      to :func:`~gi.repository.Gcr.ImportInteraction.supplement_prep`.

      This method prompts the user and fills in the attributes. If the user or
      cancellable cancels the operation the error should be set with ``%G_IO_ERROR_CANCELLED``.







      :param builder: supplemented attributes


      :param cancellable: optional cancellable object





   .. method:: supplement_async(builder: ~gi.repository.Gck.Builder, cancellable: ~gi.repository.Gio.Cancellable | None = None, callback: ~typing.Callable[[...], None] | None = None, *user_data: ~typing.Any) -> None

      Asynchronously supplement attributes before import. This means prompting the
      user for things like labels and the like. The needed attributes will have
      been passed to :func:`~gi.repository.Gcr.ImportInteraction.supplement_prep`.

      This method prompts the user and fills in the attributes.







      :param builder: supplemented attributes


      :param cancellable: optional cancellable object


      :param callback: called when the operation completes


      :param user_data: data to be passed to the callback





   .. method:: supplement_finish(result: ~gi.repository.Gio.AsyncResult) -> ~gi.repository.Gio.TlsInteractionResult

      Complete operation to asynchronously supplement attributes before import.

      If the user or cancellable cancels the operation the error should be set
      with ``%G_IO_ERROR_CANCELLED``.







      :param result: the asynchronous result





   .. method:: supplement_prep(builder: ~gi.repository.Gck.Builder) -> None

      Prepare for supplementing the given attributes before import. This means
      prompting the user for things like labels and the like. The attributes
      will contain attributes for values that the importer needs, either empty
      or prefilled with suggested values.

      This method does not prompt the user, but rather just prepares the
      interaction that these are the attributes that are needed.







      :param builder: attributes to supplement













Virtual Methods
---------------

.. rst-class:: interim-class

.. class:: ImportInteraction
   :no-index:
   

   .. method:: do_supplement(builder: ~gi.repository.Gck.Builder, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.Gio.TlsInteractionResult

      Supplement attributes before import. This means prompting the user for
      things like labels and the like. The needed attributes will have been passed
      to :func:`~gi.repository.Gcr.ImportInteraction.supplement_prep`.

      This method prompts the user and fills in the attributes. If the user or
      cancellable cancels the operation the error should be set with ``%G_IO_ERROR_CANCELLED``.







      :param builder: supplemented attributes


      :param cancellable: optional cancellable object





   .. method:: do_supplement_async(builder: ~gi.repository.Gck.Builder, cancellable: ~gi.repository.Gio.Cancellable | None = None, callback: ~typing.Callable[[...], None] | None = None, *user_data: ~typing.Any) -> None

      Asynchronously supplement attributes before import. This means prompting the
      user for things like labels and the like. The needed attributes will have
      been passed to :func:`~gi.repository.Gcr.ImportInteraction.supplement_prep`.

      This method prompts the user and fills in the attributes.







      :param builder: supplemented attributes


      :param cancellable: optional cancellable object


      :param callback: called when the operation completes


      :param user_data: data to be passed to the callback





   .. method:: do_supplement_finish(result: ~gi.repository.Gio.AsyncResult) -> ~gi.repository.Gio.TlsInteractionResult

      Complete operation to asynchronously supplement attributes before import.

      If the user or cancellable cancels the operation the error should be set
      with ``%G_IO_ERROR_CANCELLED``.







      :param result: the asynchronous result





   .. method:: do_supplement_prep(builder: ~gi.repository.Gck.Builder) -> None

      Prepare for supplementing the given attributes before import. This means
      prompting the user for things like labels and the like. The attributes
      will contain attributes for values that the importer needs, either empty
      or prefilled with suggested values.

      This method does not prompt the user, but rather just prepares the
      interaction that these are the attributes that are needed.







      :param builder: attributes to supplement