ImportInteraction

class ImportInteraction(*args, **kwargs)

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 TlsInteraction

Methods

class ImportInteraction
supplement(builder: Builder, cancellable: Cancellable | None = None) 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 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.

Parameters:
  • builder – supplemented attributes

  • cancellable – optional cancellable object

supplement_async(builder: Builder, cancellable: Cancellable | None = None, callback: Callable[[...], None] | None = None, *user_data: 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 supplement_prep().

This method prompts the user and fills in the attributes.

Parameters:
  • builder – supplemented attributes

  • cancellable – optional cancellable object

  • callback – called when the operation completes

  • user_data – data to be passed to the callback

supplement_finish(result: AsyncResult) 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.

Parameters:

result – the asynchronous result

supplement_prep(builder: 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.

Parameters:

builder – attributes to supplement

Virtual Methods

class ImportInteraction
do_supplement(builder: Builder, cancellable: Cancellable | None = None) 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 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.

Parameters:
  • builder – supplemented attributes

  • cancellable – optional cancellable object

do_supplement_async(builder: Builder, cancellable: Cancellable | None = None, callback: Callable[[...], None] | None = None, *user_data: 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 supplement_prep().

This method prompts the user and fills in the attributes.

Parameters:
  • builder – supplemented attributes

  • cancellable – optional cancellable object

  • callback – called when the operation completes

  • user_data – data to be passed to the callback

do_supplement_finish(result: AsyncResult) 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.

Parameters:

result – the asynchronous result

do_supplement_prep(builder: 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.

Parameters:

builder – attributes to supplement