org.freedesktop.packagekit1.Transaction D-Bus Interface

org.freedesktop.packagekit1.Transaction

Description

The transaction interface is used for interacting with individual transactions.

Properties

org.freedesktop.packagekit1.Transaction:Role

    Role readable u

The transaction role enum, e.g. update-system.

org.freedesktop.packagekit1.Transaction:Status

    Status readable u

The transaction status enum, e.g. downloading.

org.freedesktop.packagekit1.Transaction:LastPackage

    LastPackage readable s

The last package_id that was processed, e.g. hal;0.1.2;i386;fedora;.

org.freedesktop.packagekit1.Transaction:Uid

    Uid readable u

The uid of the user that started the transaction.

org.freedesktop.packagekit1.Transaction:Sender

    Sender readable s

The D-Bus name of the process that started the transaction.

org.freedesktop.packagekit1.Transaction:Percentage

    Percentage readable u

The percentage complete of the transaction.

Backends should set this value to 101 if the amount complete cannot be calculated.

org.freedesktop.packagekit1.Transaction:AllowCancel

    AllowCancel readable b

If the transaction can be cancelled.

org.freedesktop.packagekit1.Transaction:CallerActive

    CallerActive readable b

If the original caller of the method is still connected to the system bus. This is usually an indication that the client can handle it’s own error handling and EULA callbacks rather than another program taking over.

org.freedesktop.packagekit1.Transaction:ElapsedTime

    ElapsedTime readable u

The amount of time elapsed during the transaction in seconds.

org.freedesktop.packagekit1.Transaction:RemainingTime

    RemainingTime readable u

The estimated time remaining of the transaction in seconds, or 0 if not known.

org.freedesktop.packagekit1.Transaction:Speed

    Speed readable u

The estimated speed of the transaction (copying, downloading, etc.) in bits per second, or 0 if not known.

org.freedesktop.packagekit1.Transaction:DownloadSizeRemaining

    DownloadSizeRemaining readable t

The number of bytes remaining to download, 0 if nothing is left to download.

org.freedesktop.packagekit1.Transaction:TransactionFlags

    TransactionFlags readable t

The flags set for this transaction, e.g. SIMULATE or ONLY_DOWNLOAD.

Methods

org.freedesktop.packagekit1.Transaction.SetHints

    SetHints (
      IN hints a{sv}
    )

This method allows the calling session to set transaction hints for the package manager which can change as the transaction runs.

This method can be sent before the transaction has been run or whilst it is running. There is no limit to the number of times this method can be sent, although some backends may only use the values that were set before the transaction was started.

Every hint is optional. A value of the wrong type is rejected with input-invalid. Unknown keys are ignored, so that newer clients keep working against older daemons.

Notes on hints:

The following hints are understood:

  • locale: The locale code, for example en_GB. [s]
  • background: If the method should be executed as a background task. Background tasks are normally treated with a lower priority than regular tasks, and normally only use idle CPU and network. [b]
  • interactive: If the method can ask interactive questions whilst running. [b]
  • cache-age: This allows the frontend to set how fresh it needs the metadata used in the transaction, in seconds. This allows fine control of the age of the returned results, but means the frontend probably has to query the updates check value and pass it this value for GetUpdates, and choose something sane otherwise. Most interactive clients will set this to the maximum value, which means “never download new metadata, unless required to return results”. Zero is rejected. Most transactions will not have this value set. [u]

  • frontend-socket: The absolute path of a Unix socket the backend may use to talk to a frontend helper, e.g. for debconf. It has to exist and be a socket. [s]

  • hints: The hints as a dictionary, for example {'locale': <'en_GB.utf8'>, 'background': <true>, 'interactive': <false>, 'cache-age': <3600>}.

org.freedesktop.packagekit1.Transaction.AcceptEula

    AcceptEula (
      IN eula_id s
    )

This method allows the user to accept a end user licence agreement.

Callers need the org.freedesktop.packagekit.accept-eula permission.

  • eula_id: A valid EULA ID

org.freedesktop.packagekit1.Transaction.Cancel

    Cancel ()

This method cancels a transaction that is already running

org.freedesktop.packagekit1.Transaction.DownloadPackages

    DownloadPackages (
      IN store_in_cache b,
      IN package_ids as
    )

This method downloads packages into a temporary directory.

This method should emit one Files signal for each package that is downloaded, with the file list set as the name of the complete downloaded file and directory, so for example:

DownloadPackages('hal;0.1.2;i386;fedora;','hal-info;2009-09-07;no-arch;updates;') should send two signals, e.g. Files('hal;0.1.2;i386;fedora;', '/tmp/hal-0.1.2.i386.rpm') and Files('hal-info;2009-09-07;no-arch;updates;', '/tmp/hal-info-2009-09-07.noarch.rpm').

Notes on store_in_cache:

See the developer docs for more details on how this is supposed to work.

  • store_in_cache: If the downloaded files should be stored in the system package cache rather than copied into a newly created directory.

  • package_ids: An array of package IDs.

org.freedesktop.packagekit1.Transaction.DependsOn

    DependsOn (
      IN filter t,
      IN package_ids as,
      IN recursive b
    )

This method returns packages that this package depends on.

This method typically emits Progress, Status and Error and Packages.

Packages info enumerated types should be available or installed.

  • filter: A correct filter bitfield, e.g. none or installed;~devel

  • package_ids: An array of package IDs.

  • recursive: Either true or false. If yes then the requirements should be returned for all packages returned. This means if gnome-power-manager depends on NetworkManager and NetworkManager depends on HAL, then DependsOn on gnome-power-manager should return both HAL and NetworkManager.

org.freedesktop.packagekit1.Transaction.GetDetails

    GetDetails (
      IN package_ids as
    )

This method should return all the details about a specific package_id.

This method typically emits Progress, Status and Error and Details.

  • package_ids: An array of package IDs.

org.freedesktop.packagekit1.Transaction.GetDetailsLocal

    GetDetailsLocal (
      IN files as
    )

This method should return all the details about a specific local file.

This method typically emits Progress, Status and Error and Details.

  • files: An array of filenames.

org.freedesktop.packagekit1.Transaction.GetFilesLocal

    GetFilesLocal (
      IN files as
    )

This method should return all the file lists for a specific local file.

This method typically emits Progress, Status and Error and Details.

  • files: An array of filenames.

org.freedesktop.packagekit1.Transaction.GetFiles

    GetFiles (
      IN package_ids as
    )

This method should return the file list of the package_id.

This method typically emits Progress, Status and Error and Files.

  • package_ids: An array of package IDs.

org.freedesktop.packagekit1.Transaction.GetOldTransactions

    GetOldTransactions (
      IN number u
    )

This method allows a client to view details for old transactions.

  • number: The number of past transactions, or 0 for all known transactions.

org.freedesktop.packagekit1.Transaction.GetPackages

    GetPackages (
      IN filter t
    )

This method returns all the packages without a search term.

This method typically emits Progress, Error and Packages.

Packages info enumerated types should be available or installed.

  • filter: A correct filter bitfield, e.g. none or installed;~devel

org.freedesktop.packagekit1.Transaction.GetRepoList

    GetRepoList (
      IN filter t
    )

This method returns the list of repositories used in the system.

This method should emit RepoDetail.

  • filter: A correct filter bitfield, e.g. none or installed;~devel

org.freedesktop.packagekit1.Transaction.RequiredBy

    RequiredBy (
      IN filter t,
      IN package_ids as,
      IN recursive b
    )

This method returns packages that depend on this package. This is useful to know, as if package_id is being removed, we can warn the user what else would be removed.

This method typically emits Progress, Status and Error and Packages.

Packages info enumerated types should be available or installed.

  • filter: A correct filter bitfield, e.g. none or installed;~devel

  • package_ids: An array of package IDs.

  • recursive: Either true or false. If yes then the requirements should be returned for all packages returned. This means if gnome-power-manager depends on NetworkManager and NetworkManager depends on HAL, then GetRequires on HAL should return both gnome-power-manager and NetworkManager.

org.freedesktop.packagekit1.Transaction.GetUpdateDetail

    GetUpdateDetail (
      IN package_ids as
    )

This method returns details about a specific update.

This method typically emits UpdateDetails and Error

  • package_ids: An array of package IDs.

org.freedesktop.packagekit1.Transaction.GetUpdates

    GetUpdates (
      IN filter t
    )

This method should return a list of packages that are installed and are upgradable. It should only return the newest update for each installed package.

This method typically emits Progress, Error and Packages.

Packages info enumerated types should be update, update-security, update-enhancement or blocked for the packages that have an update. Packages that are affected by applying the updates may be included with the types install, remove, obsolete or downgrade.

The urgency of an update is given by the severity enumerated type of each package, which is one of low, medium, high or critical. A blocked update carries the severity it would have if it was not blocked, or none if the backend can not tell.

The status blocked signifies the package cannot be updated, probably due to other dependencies not being met. This type allows the GUI tools to show to the user that an update exists, but cannot be installed. The reason for it not being installed should be put into the update description when doing GetUpdateDetail.

A filter such as basename or gui is also useful if you want to do filtering on the method to only show the main packages rather than the complete list. The complete list is available but specifying none as the filter. Using no filter which may be useful in advanced tools or when using libpackagekit and searching for an update of a specific name. Other filter types may be present, but can be safely ignored of the backend does not support them.

  • filter: A correct filter bitfield, e.g. none or installed;~devel

org.freedesktop.packagekit1.Transaction.GetDistroUpgrades

    GetDistroUpgrades ()

This method should return a list of distribution upgrades that are available. It should not return updates, only major upgrades.

This method typically emits DistroUpgrade, Error and

org.freedesktop.packagekit1.Transaction.InstallFiles

    InstallFiles (
      IN transaction_flags t,
      IN full_paths as
    )

This method installs local package files onto the local system.

The installer should always install extra dependant packages automatically.

This method typically emits Progress, Status and Error and Packages.

Packages info enumerated types should be downloading, updating, installing or removing. When simulating, they should be install, update, remove, reinstall, downgrade or obsolete instead.

Callers need the org.freedesktop.packagekit.localinstall-untrusted permission.

Notes on transaction_flags:

If this method is can only install trusted files, and the files are unsigned, then the backend will send a ErrorCode(missing-gpg-signature).

  • transaction_flags: If the transaction is only allowed to install trusted files. Unsigned files should not be installed if this parameter is TRUE.

  • full_paths: An array of full path and filenames to packages.

org.freedesktop.packagekit1.Transaction.InstallPackages

    InstallPackages (
      IN transaction_flags t,
      IN package_ids as
    )

This method installs new packages on the local system.

The installer should always install extra packages automatically as the use could call DependsOn prior to the install if a confirmation is required in the UI.

This method typically emits Progress, Status and Error and Packages.

Packages info enumerated types should be downloading, updating, installing or removing. When simulating, they should be install, update, remove, reinstall, downgrade or obsolete instead.

Callers need the org.freedesktop.packagekit.install-untrusted permission.

Notes on transaction_flags:

If this method is can only install trusted packages, and the packages are unsigned, then the backend will send a ErrorCode(missing-gpg-signature).

  • transaction_flags: If the transaction is only allowed to install trusted packages. Unsigned packages should not be installed if this transaction_flags has ONLY_TRUSTED.

  • package_ids: An array of package IDs.

org.freedesktop.packagekit1.Transaction.InstallSignature

    InstallSignature (
      IN sig_type u,
      IN key_id s,
      IN package_id s
    )

This method allows us to install new security keys.

Callers need the org.freedesktop.packagekit.install-signature permission.

  • sig_type: A key type enum, e.g. gpg

  • key_id: A key ID, e.g. BB7576AC

  • package_id: A PackageID for the package that the user is trying to install

org.freedesktop.packagekit1.Transaction.RefreshCache

    RefreshCache (
      IN force b
    )

This method should fetch updated meta-data for all enabled repositories. This operation should be only scheduled when the computer is idle as the network connection will be very active, and will the computer will have have non-trivial levels of hard disk and processor activity. For these reasons, it should not be done automatically when on battery power.

When fetching each software repository, ensure to emit RepoDetail for the current repository to give the user interface some extra details. Be sure to have the “enabled” field set to true, otherwise you wouldn’t be fetching that repository.

This method typically emits Progress, Error and RepoDetail.

Callers need the org.freedesktop.packagekit.refresh-cache permission.

  • force: If the caches should be cleaned and reloaded even if there is valid, up to date data.

org.freedesktop.packagekit1.Transaction.RemovePackages

    RemovePackages (
      IN transaction_flags t,
      IN package_ids as,
      IN allow_deps b,
      IN autoremove b
    )

This method removes packages from the local system.

This method typically emits Progress, Status and Error and Packages.

Packages info enumerated types should be downloading, updating, installing or removing. When simulating, they should be install, update, remove, reinstall, downgrade or obsolete instead.

Callers need the org.freedesktop.packagekit.remove permission.

  • transaction_flags: If the transaction should be simulated or prepared.

  • package_ids: An array of package IDs.

  • allow_deps: Either true or false. If true allow other packages to be removed with the package, but false should cause the script to abort if other packages are dependant on the package.

  • autoremove: Either true or false. This option is only really interesting on embedded devices with a limited amount of flash storage. It suggests to the packagekit backend that dependencies installed at the same time as the package should also be removed if they are not required by anything else. For instance, if you install LibreOffice, it might download libneon as a dependency. When auto_remove is set to true, and you remove LibreOffice then libneon will also get removed automatically.

org.freedesktop.packagekit1.Transaction.RepoEnable

    RepoEnable (
      IN repo_id s,
      IN enabled b
    )

This method enables the repository specified.

Callers need the org.freedesktop.packagekit.repo-change permission.

  • repo_id: A repository identifier, e.g. fedora-development-debuginfo

  • enabled: true if enabled, false if disabled.

org.freedesktop.packagekit1.Transaction.RepoSetData

    RepoSetData (
      IN repo_id s,
      IN parameter s,
      IN value s
    )

This method allows arbitary data to be passed to the repository handler.

Callers need the org.freedesktop.packagekit.repo-change permission.

  • repo_id: A repository identifier, e.g. fedora-development-debuginfo

  • parameter: The backend specific value, e.g. set-download-url.

  • value: The backend specific value, e.g. http://foo.bar.org/baz.

org.freedesktop.packagekit1.Transaction.RepoRemove

    RepoRemove (
      IN transaction_flags t,
      IN repo_id s,
      IN autoremove b
    )

This method removes the repo and optionally removes all the packages installed from the repo.

Callers need org.freedesktop.packagekit.repo-change permission.

  • transaction_flags: If the transaction should be simulated.

  • repo_id: A repository identifier, e.g. updates-testing

  • autoremove: Packages installed from the repo are automatically removed.

org.freedesktop.packagekit1.Transaction.Resolve

    Resolve (
      IN filter t,
      IN packages as
    )

This method turns a single package name into a package_id suitable for the other methods.

If the package is a fully formed package_id, then this should be treated as an exact package match. This is useful to find the summary or installed status of a package_id returned from other methods.

This method typically emits Error and Packages.

Packages info enumerated types should be available or installed.

Notes on packages:

The package names are case sensitive, so for instance: Resolve('Packagekit') would not match PackageKit.

  • filter: A correct filter bitfield, e.g. none or installed;~devel

  • packages: An array of package names, e.g. scribus-clipart.

org.freedesktop.packagekit1.Transaction.SearchDetails

    SearchDetails (
      IN filter t,
      IN values as
    )

This method allows deeper searching than SearchName().

Do not refresh the package cache. This should be fast. This is very similar to search-name. This should search as much data as possible, including, if possible repo names, package summaries, descriptions, licenses and URLs.

Try to emit installed before available packages first, as it allows the client program to perform the GUI filtering and matching whilst the daemon is running the transaction.

If the backend includes installed and available versions of the same package when searching then the available version will have to be filtered in the backend.

This method typically emits Progress, Error and Packages.

Packages info enumerated types should be available or installed.

Notes on values:

The search should not be treated as case sensitive.

  • filter: A correct filter bitfield, e.g. none or installed;~devel

  • values: A single word search term with no wildcard chars. The search can contain many words separated by spaces. In this case, the search operator is AND and the words can be found in any details section/field. For example, search of GPL games should returns every games with a GPL license.

org.freedesktop.packagekit1.Transaction.SearchFiles

    SearchFiles (
      IN filter t,
      IN values as
    )

This method searches for files on the local system and files in available packages.

This should search for files. This should allow an application to find out what package owns a file on the system.

This method typically emits Progress, Error and Packages.

Packages info enumerated types should be available or installed.

Notes on values:

The search is case sensitive, and should not be escaped or surrounded in quotes.

  • filter: A correct filter bitfield, e.g. none or installed;~devel

  • values: A filename or fully qualified path and filename on the system. If the search term begins with a / it will be assumed the entire path has been given and only packages that contain this exact path and filename will be returned. If the search term does not start with / then it should be treated as a single filename, which can be in any directory.

org.freedesktop.packagekit1.Transaction.SearchGroups

    SearchGroups (
      IN filter t,
      IN values as
    )

This method returns packages from a given group enumerated type.

Do not refresh the package cache. This should be fast.

Try to emit installed before available packages first, as it allows the client program to perform the GUI filtering and matching whilst the daemon is running the transaction.

If the backend includes installed and available versions of the same package when searching then the available version will have to be filtered in the backend.

This method typically emits Progress, Error and Packages.

Packages info enumerated types should be available or installed.

Notes on values:

If the values strings are prefixed with repo: then the request is treated as a ‘repository search’, for example: repo:fedora-debuginfo. In this instance all packages that were either installed from, or can be installed from the fedora-debuginfo repository would be returned.

  • filter: A correct filter bitfield, e.g. none or installed;~devel

  • values: An enumerated group type, or unknown. The search cannot contain spaces. The following recommendations are made below:

org.freedesktop.packagekit1.Transaction.SearchNames

    SearchNames (
      IN filter t,
      IN values as
    )

This method searches the package database by package name.

Do not refresh the package cache. This should be fast.

Try to emit installed before available packages first, as it allows the client program to perform the GUI filtering and matching whilst the daemon is running the transaction.

If the backend includes installed and available versions of the same package when searching then the available version will have to be filtered in the backend.

The search methods should return all results in all repositories. This may mean that multiple versions of package are returned. If this is not what is wanted by the client program, then the newest filter should be used.

This method typically emits Progress, Error and Packages.

Packages info enumerated types should be available or installed.

Notes on values:

The search should not be treated as case sensitive.

  • filter: A correct filter bitfield, e.g. none or installed;~devel

  • values: A single word search term with no wildcard chars. The search term can contain many words separated by spaces. In this case, the search operator is AND. For example, search of gnome power should returns gnome-power-manager but not gnomesword or powertop.

org.freedesktop.packagekit1.Transaction.UpdatePackages

    UpdatePackages (
      IN transaction_flags t,
      IN package_ids as
    )

This method updates existing packages on the local system.

The installer should always update extra packages automatically to fulfil dependencies.

This should allow an application to find out what package owns a file on the system.

This method typically emits Progress, Status and Error and Packages.

Callers need the org.freedesktop.packagekit.update-package permission.

Notes on transaction_flags:

If this method is can only update trusted packages, and the packages are unsigned, then the backend will send a ErrorCode(missing-gpg-signature).

  • transaction_flags: If the transaction is only allowed to update to trusted packages. Unsigned packages should not be installed if this transaction_flags has ONLY_TRUSTED.

  • package_ids: An array of package IDs.

org.freedesktop.packagekit1.Transaction.WhatProvides

    WhatProvides (
      IN filter t,
      IN values as
    )

This method returns packages that provide the supplied attributes. This method is useful for finding out what package(s) provide a modalias or GStreamer codec string.

This method typically emits Progress, Status and Error and Packages.

Packages info enumerated types should be available or installed.

  • filter: A correct filter bitfield, e.g. none or installed;~devel

  • values: The data to send to the backend to get the packages. Note: This is backend specific.

org.freedesktop.packagekit1.Transaction.UpgradeSystem

    UpgradeSystem (
      IN transaction_flags t,
      IN distro_id s,
      IN upgrade_kind u
    )

before launching a installer. The default is to download enough data to launch a full graphical installer, but a complete upgrade will be required if there is no internet access during install time.

This method perfoms a distribution upgrade to the specified version.

This method typically emits Progress, Status and Error and Packages.

Notes on distro_id:

Backends may use this as a filename component, so it has to start with an alphanumeric character and may otherwise only contain alphanumeric characters and ., _, + and -. Anything else is rejected with ErrorCode(input-invalid).

  • transaction_flags: If this method is can only install trusted files, and the files are unsigned, then the backend will send a ErrorCode(missing-gpg-signature).

  • distro_id: The distribution ID to upgrade to, e.g. fedora-14.

  • upgrade_kind: The type of upgrade, e.g. minimal, default or complete. Minimal upgrades will download the smallest amount of data

org.freedesktop.packagekit1.Transaction.RepairSystem

    RepairSystem (
      IN transaction_flags t
    )

This method recovers the package management system from e.g. unsatisfied dependencies of installed packages.

This method typically emits Progress, Status and Error and Packages.

Notes on transaction_flags:

If this method is can only install trusted packages, and the packages are unsigned, then the backend will send a ErrorCode(missing-gpg-signature).

  • transaction_flags: If the transaction is only allowed to install trusted packages. Unsigned packages should not be installed if this transaction_flags has ONLY_TRUSTED.

Signals

org.freedesktop.packagekit1.Transaction::Details

    Details (
      data a{sv}
    )

This signal allows the backend to convey more details about the package.

Notes on data:

  • package-id: The package ID [s]
  • license: The license string, e.g. GPLv2+ [s]
  • group: The enumerated package group description [u]
  • description: The multi-line package description in markdown syntax. [s]
  • url: The upstream project homepage [s]
  • size: The size of the package in bytes [t]
  • download-size: The number of bytes that have to be downloaded to install the package on this system, including dependencies that are not yet installed, as far as the backend can determine this cheaply. Backends that cannot account for dependencies report the download size of the package itself. Clients that need an exact figure should simulate an InstallPackages transaction instead. [t]
  • summary: The one line package summary, e.g. Clipart for LibreOffice [s]

data The details about a specific package. The available keys are here:

org.freedesktop.packagekit1.Transaction::ErrorCode

    ErrorCode (
      code u,
      details s
    )

This signal is used to report errors back to the session program.

Errors should only be send on fatal abort.

code Enumerated type, e.g. no-network.

details Long description or error, e.g. failed to connect to mytry.xml

org.freedesktop.packagekit1.Transaction::Files

    Files (
      package_id s,
      files a(su)
    )

for files downloaded by DownloadPackages. files: The file list; each entry is an absolute path without a trailing slash and a PkFileKindEnum saying whether it is a regular file, a directory owned by the package, a symbolic link, or unknown when the backend has no such information.

This signal is used to push file lists from the backend to the session.

package_id The Package ID that called the method, or an empty string

files

org.freedesktop.packagekit1.Transaction::Finished

    Finished (
      exit u,
      runtime u
    )

This signal is used to signal that the transaction has finished.

exit The PkExitEnum describing the exit status of the transaction.

runtime The amount of time in milliseconds that the transaction ran for.

org.freedesktop.packagekit1.Transaction::Packages

    Packages (
      packages a(uuss)
    )

This signal allows the backend to communicate packages to the session.

If updating, as packages are updated then emit them to the screen. This allows a summary to be presented after the transaction.

When returning results from a search always return installed before available for the same package name.

The daemon may split the packages of a transaction into multiple emissions of this signal to stay within the D-Bus message size limits. The content of one signal will never duplicate the content of another, and a single emission may contain only one package.

Each array element describes one package and consists of the following fields:

  • info: A valid info enumerated type [u]
  • severity: A valid severity enumerated type, describing how urgent a package update is. This is none for any package that is not an update. [u]
  • package_id: This identifier is of the form name;version;arch;origin;data in a single string and is meant to represent a single package unique across all local and remote data stores. The origin field should be set to the repository identifier or repository name the package is available from. For an installed package, it should be set to the repository the package was originally installed from, if the package manager tracks this information, and left empty otherwise. The origin field for a non-installed local package must be local as this signifies a repository name is not available and that package resides locally on the client system rather than in any specific repository. The data field is free for the backend to use for additional information it needs, for example whether a package was installed automatically or manually. Its contents are backend-specific and it is usually empty. Frontends must not parse it and should rely on the info enumerated type for state information instead. [s]
  • summary: The one line package summary, e.g. Clipart for LibreOffice. This may be empty when the package is emitted to show progress while a transaction is modifying the system. [s]

packages An array of package details, each array element is one package.

org.freedesktop.packagekit1.Transaction::RepoDetail

    RepoDetail (
      repo_id s,
      description s,
      enabled b
    )

This signal describes a repository on the system.

repo_id The repository ID.

description A description of the repository.

enabled If the repository is enabled and in use.

org.freedesktop.packagekit1.Transaction::RepoSignatureRequired

    RepoSignatureRequired (
      package_id s,
      repository_name s,
      key_url s,
      key_userid s,
      key_id s,
      key_fingerprint s,
      key_timestamp s,
      type u
    )

This signal is emitted when a transaction is not possible due to a missing security certificate.

Some backends support repositories which use a cryptographic signature, such as GPG. If a package cannot be installed because it is signed with a key that has not been verified, this signal is generated so the user can choose to accept or decline the key.

This signal includes information that can be used to verify that the key should be trusted, such as a URL for the company or person who owns the key, the key’s ID, the userid of the key creator, and the date the key was generated.

package_id A package ID for the package that is trying to be installed

repository_name The name of the repository associated with the provided key.

key_url The URL provided with the key.

key_userid The user id associated with the key.

key_id A unique identifier for the key.

key_fingerprint The hashed fingerprint of the key.

key_timestamp The date the key was created.

type The type of signature used. gpg, for example.

org.freedesktop.packagekit1.Transaction::EulaRequired

    EulaRequired (
      eula_id s,
      package_id s,
      vendor_name s,
      license_agreement s
    )

This signal is emitted when a transaction is not possible due to a EULA that needs to be agreed to at install time.

Some backends support EULAs, which have to be agreed to before the install can proceed.

eula_id The eula_id which identifies the EULA - this is provided so that if a specific EULA has previously agreed to a EULA from Acme Corp it is not asked again. An example eula_id‘s is vmware5_single_user.

package_id A package ID for the package that is trying to be installed.

vendor_name The vendor that is providing the EULA.

license_agreement The full text EULA.

org.freedesktop.packagekit1.Transaction::RequireRestart

    RequireRestart (
      type u,
      package_id s
    )

This signal is sent when the session program should notify the user that a restart is required to complete the transaction.

This is optional, but highly recommended.

The backend may send this as many times as needed, usually once per package. Clients should act on the most severe restart type they received during a transaction. A required system restart is also recorded in the RebootRequired property of the daemon until the next boot.

type The required restart type, one of system, session or application.

package_id The package ID that caused the restart to be required.

org.freedesktop.packagekit1.Transaction::Transactions

    Transactions (
      transactions a(oa{sv})
    )

This signal is sent when more details are required about a specific transaction.

The daemon may split the transactions into multiple emissions of this signal to stay within the D-Bus message size limits. The content of one signal will never duplicate the content of another, and a single emission may contain only one transaction.

Each array element describes one past transaction as a struct: the transaction ID followed by a vardict with the remaining fields. A key whose value is unset, unknown or empty is omitted. Clients must ignore keys they do not know and treat enum values they do not recognize as that enum’s unknown value.

  • time-started: The ISO 8601 encoded time the transaction was started. [s]
  • succeeded: If the transaction succeeded. Always present. [b]
  • role: The role enumerated type. [u]
  • duration: The duration of the transaction in milliseconds. Always present. [u]
  • packages: The packages the transaction acted on, as an array of (info, package_id, summary) with the same meaning as in the Packages signal. Only recorded for install, update and remove transactions. [a(uss)]
  • uid: The user ID of the user that scheduled the action. [u]
  • cmdline: The command line of the tool that scheduled the action, e.g. /usr/bin/gpk-application. [s]

transactions An array of past transactions, each array element is one transaction.

org.freedesktop.packagekit1.Transaction::UpdateDetails

    UpdateDetails (
      details a(sa{sv})
    )

This signal is sent when more details are required about specific updates.

The daemon may split the update details of a transaction into multiple emissions of this signal to stay within the D-Bus message size limits. The content of one signal will never duplicate the content of another, and a single emission may contain only one update.

Each array element describes one update as a struct: the package ID followed by a dictionary with the remaining fields. A key whose value is unset, unknown or empty is omitted, so an absent key means that the backend did not report the field. Clients must ignore keys they do not know and treat enum values they do not recognise as that enum’s unknown value.

  • updates: A list of package_id’s that are to be updated. [as]
  • obsoletes: A list of package_id’s that are to be obsoleted. [as]
  • issues: The issue references of the update, see below. [aa{sv}]
  • restart: A valid restart type, e.g. system. [u]
  • update-text: The update text describing the update. If formatting is required, then markdown syntax should be used, e.g. This is **critically** important [s]
  • changelog: The ChangeLog text describing the changes since the last version. [s]
  • state: The state of the update, e.g. stable or testing. [u]
  • time-issued: The ISO 8601 encoded time that the update was issued. [s]

Each element of issues describes an issue that this update resolves, as a dictionary with these keys:

  • kind: What is referenced, as a PkIssueKindEnum value: generic (1) for an issue tracker entry from any tracker, cve (2) for a CVE record or CVE tracker page, advisory (3) for the distributor’s own advisory page about the update. Always present. [u]
  • url: Where a user can read about the issue. Always present. [s]
  • id: A short identifier for display, e.g. the bug number or the CVE name. [s]
  • title: A one-line summary of the issue, not of the update. [s]

details An array of update details, each array element is one update.

org.freedesktop.packagekit1.Transaction::DistroUpgrade

    DistroUpgrade (
      type u,
      name s,
      summary s
    )

This signal allows the backend to communicate distribution upgrades to the session.

type A valid upgrade enumerated type, e.g. stable or unstable

name The short name of the distribution, e.g. Fedora Core 10 RC1

summary The multi-line description of the release.

org.freedesktop.packagekit1.Transaction::ItemProgress

    ItemProgress (
      id s,
      status u,
      percentage u
    )

This signal allows the backend to send infomation about package or repository progress when using Simultanous mode.

A backend signals that it is done with a package by sending the status finished with a percentage of 100.

Notes on id:

A repo_id may only be used when running RefreshCache.

id A valid package_id, e.g. hal;0.1.0;i386;fedora; or a repo_id.

status The status enumerated value that is being completed.

percentage The percentage of this package action is completed.

org.freedesktop.packagekit1.Transaction::Destroy

    Destroy ()

This signal is sent when the transaction has been destroyed and is no longer available for use.