org.aptkit.transaction(7)

NAME
org.aptkit.transaction - the main interface of an aptkit transaction

SYNOPSIS
Each transaction is represented as an unique D-Bus object, e.g. at the D-Bus path /or/debian/apt/transaction/12123-123-123213. Which provides the following interface.

DESCRIPTION

  METHODS

ProvideMedium
    ProvideMedium (in 's' medium)

    Continue a paused transaction which is waiting for the given medium.

    If a media change is required to e.g. install packages from a CD/DVD the transaction will be paused and the RequiredMedium property changed to an array of the medium label and its mount point. Furthermore the MediumRequired signal will be emitted.

ResolveConfigFileConflict
    ResolveConfigFilePrompt (in 's' config,
    in 's' answer)

    Continue a paused transaction which is waiting for an answer to handle a configuration file conflict. Config is the path to the current configuration file and answer can be either "replace" or "keep".

    If a later config file is shipped in a package which overrides some user modifications the transaction will be paused and the ConfigFileConflict property of the transaction will be set to an array of the old and new configuration file path. The later one is supposed to replace the former one. Furthermore the ConfigFileConflict signal will be emitted.

Simulate
    Simulate ()

    Simulate the transaction and calculate dependencies, required disk space and download size. If a transaction would fail the corresponding error will be raised.

Run Run ()

    Queue the transaction for processing. Afterwards there cannot be made any further changes to the transaction, e.g. modifying the http proxy.

Cancel
    Cancel ()

    Cancel the transaction if possible.

  SIGNALS

Finished
    Finished ('s' exit_state)

    The signal will be emitted when the transaction has been processed. The exit_state indicates if the transaction was completed, cancelled or failed.

MediumRequired
    MediumRequired ('s' label,
    's' mount_point)

    The signal will be emitted if the transaction has been paused and waits for a media change to install packages.

ConfigFileConflict
    ConfigFileConflict ('s' old,
    's' new)

    The signal will be emitted if the transaction has been paused because a new configuration file is shipped in a package which would override changes by the user in the old configuration file.

PropertyChanged
    PropertyChanged ('s' property_name ,
    'v' value)

    The signal will be emitted if one of the following properties has changed.

  PROPERTIES
The properties of the transaction are available through the Get And GetAll methods of the D-Bus properties interface and can be changed using the Set method.

Role read 's'
    The role enum of the transaction, e.g. update-cache.

Status read 's'
    The current status enum of the transaction, e.g. downloading

StatusDetails read 's'
    A clear text message describing the current status.

Progress read 'i'
    The progress of the transaction in percent.

ProgressDownload read 'sssiis'
    The last download progress information received from APT. It is an array of the URI, status enum, short description, full size, already downloaded size and an error or status message.

Space read 'i'
    The additional disk space in Bytes which will be required by the transaction. The Simulate method has to be called to calculate the download size.

Download read 'i'
    The required download size in Bytes of the transaction. The Simulate method has to be called to calculate the download size.

Packages read 'a(a(s)a(s)a(s)a(s)a(s)a(s)a(s))'
    The lists of packages which are initially queued to be installed, reinstalled, removed, purged, upgraded, downgraded or skipped from upgrading.

Dependencies read 'a(a(s)a(s)a(s)a(s)a(s)a(s)a(s))'
    The lists of packages which are additionally required to be installed, reinstalled, removed, purged, upgraded, downgraded or skipped from upgrading. The Simulate method has to be called to calculate the dependencies.

Cancellable read 'b'
    If the transaction can be cancelled.

TerminalAttached read 'b'
    If the master pty which has to be set using the Terminal property is attached as controlling terminal to the underlying dpkg call.

RequiredMedium read 'a(ss)'
    The transaction will be stopped if a media change is required to install packages. This property provides the label and the mount point of the requested medium.

ConfigFileConflict read 'a(ss)'
    The transaction will be stopped if a configuration file shipped in the package overrides changes of the user. This property provides the path to current and the path to the new configuration file.

ExitState read 's'
    The exit state enum of the transaction.

Error read 'a(ss)'
    If an error occurred this property provides the error enum and the error message.

Locale read-write 's'
    This is the locale which will be used for translating status and error messages of apt, e.g. de_DE@utf-8.

Terminal read-write 's'
    The path to the master pty which will be the controlling terminal of the underlying dpkg call. This allows one to have an interactive terminal session.

DebconfSocket read-write 's'
    The path to the socket which will be used by the debconf passthrough backend to forward the debconf communication to the user session.

Paused read 'b'
    If the transaction is paused, e.g. waiting for a conflict file resolution or media change.

Unauthenticated read 'as'
    List of unauthenticated packages which are going to be installed.

RemoveObsoletedDepends read-write 'b'
    If obsoleted dependencies of to be removed packages which have been installed automatically should be removed too.

AllowUnauthenticated read-write 'b'
    If it is allowed to install not authenticated software packages.

HttpProxy read-write 's'
    The URL of an http proxy which should be used to download repository meta data and package files, e.g. http://myproxy.athome:8080. You should set the system wide proxy if you use this feature regularly. MetaData read-write 'a{ss}' A dictonary which allows client application to store additional data in the transaction. The key name has to include an identifier of the client application separated by an unterscore from the key name, e.g. sc_icon for the application icon name stored by software-center. The property cannot be changed anymore after the transaction has been queued.

SEE ALSO
org.aptkit.transaction(7), aptk(2), aptkcon(2)