/usr/share/dbus-1/interfaces/org.freedesktop.PackageKit.Transaction.xml is in packagekit 0.8.17-4ubuntu6~gcc5.4ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 | <!DOCTYPE node PUBLIC
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd" [
<!ENTITY ERROR_GENERAL "org.freedesktop.PackageKit.Denied">
]>
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<interface name="org.freedesktop.PackageKit.Transaction">
<doc:doc>
<doc:description>
<doc:para>
The transaction interface is used for interacting with individual transactions.
</doc:para>
</doc:description>
</doc:doc>
<!--*********************************************************************-->
<property name="Role" type="u" access="read">
<doc:doc>
<doc:description>
<doc:para>
The transaction role enum, e.g. <doc:tt>update-system</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="Status" type="u" access="read">
<doc:doc>
<doc:description>
<doc:para>
The transaction status enum, e.g. <doc:tt>downloading</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="LastPackage" type="s" access="read">
<doc:doc>
<doc:description>
<doc:para>
The last package_id that was processed, e.g. <doc:tt>hal;0.1.2;i386;fedora</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="Uid" type="u" access="read">
<doc:doc>
<doc:description>
<doc:para>
The uid of the user that started the transaction.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="Percentage" type="u" access="read">
<doc:doc>
<doc:description>
<doc:para>
The percentage complete of the transaction.
</doc:para>
<doc:para>
Backends should set this value to 101 if the amount complete cannot be calculated.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="AllowCancel" type="b" access="read">
<doc:doc>
<doc:description>
<doc:para>
If the transaction can be cancelled.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="CallerActive" type="b" access="read">
<doc:doc>
<doc:description>
<doc:para>
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.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="ElapsedTime" type="u" access="read">
<doc:doc>
<doc:description>
<doc:para>
The amount of time elapsed during the transaction in seconds.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="RemainingTime" type="u" access="read">
<doc:doc>
<doc:description>
<doc:para>
The estimated time remaining of the transaction in seconds, or 0 if not known.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="Speed" type="u" access="read">
<doc:doc>
<doc:description>
<doc:para>
The estimated speed of the transaction (copying, downloading, etc.) in bits per second, or 0 if not known.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="DownloadSizeRemaining" type="t" access="read">
<doc:doc>
<doc:description>
<doc:para>
The number of bytes remaining to download, 0 if nothing is left to download.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="TransactionFlags" type="t" access="read">
<doc:doc>
<doc:description>
<doc:para>
The flags set for this transaction, e.g. SIMULATE or ONLY_DOWNLOAD.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!--*********************************************************************-->
<method name="SetHints">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method allows the calling session to set transaction hints for
the package manager which can change as the transaction runs.
</doc:para>
<doc:para>
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.
</doc:para>
<doc:para>
Each parameter value is optional.
</doc:para>
</doc:description>
</doc:doc>
<arg type="as" name="hints" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
The values as an array of strings, for example
<doc:tt>['locale=en_GB.utf8','idle=true','interactive=false','cache-age=3600']</doc:tt>.
</doc:para>
<doc:para>
The following parameter values are understood:
</doc:para>
<doc:list>
<doc:item>
<doc:term>locale</doc:term>
<doc:definition>
The locale code, for example <doc:tt>en_GB</doc:tt>.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>background</doc:term>
<doc:definition>
If the method should be executed as a background task, valid
values are <doc:tt>true</doc:tt> and <doc:tt>false</doc:tt>,
and other values will result in an error.
Background tasks are normally treated with a low priority than
regular tasks, and normally only use idle CPU and network.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>interactive</doc:term>
<doc:definition>
If the method can ask interactive questions whilst running,
valid values are <doc:tt>true</doc:tt> and <doc:tt>false</doc:tt>,
and other values will result in an error.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>cache-age</doc:term>
<doc:definition>
This allows the frontend to set how fresh it needs the
metadata used in the transaction.
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 <doc:tt>GetUpdates</doc:tt>,
and choose something sane otherwise.
Most interactive clients will set this to <doc:tt>intmax</doc:tt>doc:tt>
which means "never download new metadata, unless required to return results".
Most transactions will not have this value set.
</doc:definition>
</doc:item>
</doc:list>
<doc:para>
Other values will cause a verbose warning in the daemon, but will
not cause the method to fail. This will preserve forward and
backwards compatibility for future API versions.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="AcceptEula">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method allows the user to accept a end user licence agreement.
</doc:para>
</doc:description>
<doc:permission>Callers need the org.freedesktop.packagekit.accept-eula</doc:permission>
</doc:doc>
<arg type="s" name="eula_id" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
A valid EULA ID
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="Cancel">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method cancels a transaction that is already running
</doc:para>
</doc:description>
</doc:doc>
</method>
<!--*********************************************************************-->
<method name="DownloadPackages">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method downloads packages into a temporary directory.
</doc:para>
<doc:para>
This method should emit one
<doc:tt>Files</doc:tt> 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:
</doc:para>
<doc:para>
<doc:tt>DownloadPackages('hal;0.1.2;i386;fedora','hal-info;2009-09-07;no-arch;updates')</doc:tt>
should send two signals, e.g.
<doc:tt>Files('hal;0.1.2;i386;fedora', '/tmp/hal-0.1.2.i386.rpm')</doc:tt>
and
<doc:tt>Files('hal-info;2009-09-07;no-arch;updates', '/tmp/hal-info-2009-09-07.noarch.rpm')</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
<arg type="b" name="store_in_cache" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
If the downloaded files should be stored in the system
package cache rather than copied into a newly created
directory.
</doc:para>
<doc:para>
See <doc:ulink url="http://packagekit.org/gtk-doc/introduction-ideas-transactions.html">
the developer docs</doc:ulink> for more details on how
this is supposed to work.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="package_ids" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
An array of package IDs.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="GetCategories">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method return the collection categories
</doc:para>
</doc:description>
<doc:para>
This method typically emits
<doc:tt>Categories</doc:tt> and <doc:tt>Error</doc:tt>.
</doc:para>
<doc:para>
Note: Categories can be returned that represent groups of
packages in a specific repository.
These will have a category prefix of <doc:tt>repo:</doc:tt>
which should be understood by <doc:tt>SearchGroups</doc:tt>
if this feature is used.
</doc:para>
</doc:doc>
</method>
<!--*********************************************************************-->
<method name="GetDepends">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method returns packages that this package depends on.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>Progress</doc:tt>,
<doc:tt>Status</doc:tt> and
<doc:tt>Error</doc:tt> and
<doc:tt>Package</doc:tt>.
</doc:para>
<doc:para>
<doc:tt>Package</doc:tt> enumerated types should be
<doc:tt>available</doc:tt> or <doc:tt>installed</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
<arg type="t" name="filter" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
A correct filter bitfield, e.g. <doc:tt>none</doc:tt> or <doc:tt>installed;~devel</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="package_ids" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
An array of package IDs.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="b" name="recursive" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
Either <doc:tt>true</doc:tt> or <doc:tt>false</doc:tt>. 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 GetDepends on
gnome-power-manager should return both HAL and NetworkManager.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="GetDetails">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method should return all the details about a specific
<doc:tt>package_id</doc:tt>.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>Progress</doc:tt>,
<doc:tt>Status</doc:tt> and
<doc:tt>Error</doc:tt> and
<doc:tt>Details</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
<arg type="as" name="package_ids" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
An array of package IDs.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="GetFiles">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method should return the file list of the <doc:tt>package_id</doc:tt>.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>Progress</doc:tt>,
<doc:tt>Status</doc:tt> and
<doc:tt>Error</doc:tt> and
<doc:tt>Files</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
<arg type="as" name="package_ids" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
An array of package IDs.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="GetOldTransactions">
<doc:doc>
<doc:description>
<doc:para>
This method allows a client to view details for old transactions.
</doc:para>
</doc:description>
</doc:doc>
<arg type="u" name="number" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
The number of past transactions, or 0 for all known transactions.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="GetPackages">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method returns all the packages without a search term.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>Progress</doc:tt>,
<doc:tt>Error</doc:tt> and
<doc:tt>Package</doc:tt>.
</doc:para>
<doc:para>
<doc:tt>Package</doc:tt> enumerated types should be
<doc:tt>available</doc:tt> or <doc:tt>installed</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
<arg type="t" name="filter" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
A correct filter bitfield, e.g. <doc:tt>none</doc:tt> or <doc:tt>installed;~devel</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="GetRepoList">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method returns the list of repositories used in the system.
</doc:para>
<doc:para>
This method should emit <doc:tt>RepoDetail</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
<arg type="t" name="filter" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
A correct filter bitfield, e.g. <doc:tt>none</doc:tt> or <doc:tt>installed;~devel</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="GetRequires">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method returns packages that depend on this package.
This is useful to know, as if <doc:tt>package_id</doc:tt> is being
removed, we can warn the user what else would be removed.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>Progress</doc:tt>,
<doc:tt>Status</doc:tt> and
<doc:tt>Error</doc:tt> and
<doc:tt>Package</doc:tt>.
</doc:para>
<doc:para>
<doc:tt>Package</doc:tt> enumerated types should be
<doc:tt>available</doc:tt> or <doc:tt>installed</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
<arg type="t" name="filter" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
A correct filter bitfield, e.g. <doc:tt>none</doc:tt> or <doc:tt>installed;~devel</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="package_ids" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
An array of package IDs.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="b" name="recursive" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
Either <doc:tt>true</doc:tt> or <doc:tt>false</doc:tt>. 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.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="GetUpdateDetail">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method returns details about a specific update.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>UpdateDetail</doc:tt> and
<doc:tt>Error</doc:tt>
</doc:para>
</doc:description>
</doc:doc>
<arg type="as" name="package_ids" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
An array of package IDs.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="GetUpdates">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
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.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>Progress</doc:tt>,
<doc:tt>Error</doc:tt> and
<doc:tt>Package</doc:tt>.
</doc:para>
<doc:para>
<doc:tt>Package</doc:tt> enumerated types should be
<doc:tt>blocked</doc:tt>,
<doc:tt>low</doc:tt>,
<doc:tt>normal</doc:tt>,
<doc:tt>important</doc:tt> or
<doc:tt>security</doc:tt>.
</doc:para>
<doc:para>
The status <doc:tt>blocked</doc:tt> 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.
</doc:para>
<doc:para>
A filter such as <doc:tt>basename</doc:tt> or <doc:tt>gui</doc:tt>
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 <doc:tt>none</doc:tt>
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.
</doc:para>
</doc:description>
</doc:doc>
<arg type="t" name="filter" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
A correct filter bitfield, e.g. <doc:tt>none</doc:tt> or <doc:tt>installed;~devel</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="GetDistroUpgrades">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method should return a list of distribution upgrades that are
available.
It should not return updates, only major upgrades.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>DistroUpgrade</doc:tt>,
<doc:tt>Error</doc:tt> and
</doc:para>
</doc:description>
</doc:doc>
</method>
<!--*********************************************************************-->
<method name="InstallFiles">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method installs local package files onto the local system.
</doc:para>
<doc:para>
The installer should always install extra dependant packages automatically.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>Progress</doc:tt>,
<doc:tt>Status</doc:tt> and
<doc:tt>Error</doc:tt> and
<doc:tt>Package</doc:tt>.
</doc:para>
<doc:para>
<doc:tt>Package</doc:tt> enumerated types should be
<doc:tt>downloading</doc:tt>,
<doc:tt>updating</doc:tt>,
<doc:tt>installing</doc:tt> or
<doc:tt>removing</doc:tt>.
</doc:para>
</doc:description>
<doc:permission>Callers need the org.freedesktop.packagekit.localinstall-untrusted</doc:permission>
</doc:doc>
<arg type="t" name="transaction_flags" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
If the transaction is only allowed to install trusted files.
Unsigned files should not be installed if this parameter is <doc:tt>TRUE</doc:tt>.
</doc:para>
<doc:para>
If this method is can only install trusted files, and the files are unsigned, then
the backend will send a <doc:tt>ErrorCode(missing-gpg-signature)</doc:tt>.
On recieving this error, the client may choose to retry with only_trusted <doc:tt>FALSE</doc:tt>
after gaining further authentication.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="full_paths" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
An array of full path and filenames to packages.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="InstallPackages">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method installs new packages on the local system.
</doc:para>
<doc:para>
The installer should always install extra packages automatically
as the use could call GetDepends prior to the install if a confirmation
is required in the UI.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>Progress</doc:tt>,
<doc:tt>Status</doc:tt> and
<doc:tt>Error</doc:tt> and
<doc:tt>Package</doc:tt>.
</doc:para>
<doc:para>
<doc:tt>Package</doc:tt> enumerated types should be
<doc:tt>downloading</doc:tt>,
<doc:tt>updating</doc:tt>,
<doc:tt>installing</doc:tt> or
<doc:tt>removing</doc:tt>.
</doc:para>
</doc:description>
<doc:permission>Callers need the org.freedesktop.packagekit.install-untrusted</doc:permission>
</doc:doc>
<arg type="t" name="transaction_flags" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
If the transaction is only allowed to install trusted packages.
Unsigned packages should not be installed if transaction_flags contains <doc:tt>ALLOW_UNTRUSTED</doc:tt>.
</doc:para>
<doc:para>
If this method is can only install trusted packages, and the packages are unsigned, then
the backend will send a <doc:tt>ErrorCode(missing-gpg-signature)</doc:tt>.
On recieving this error, the client may choose to retry with only_trusted <doc:tt>FALSE</doc:tt>
after gaining further authentication.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="package_ids" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
An array of package IDs.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="InstallSignature">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method allows us to install new security keys.
</doc:para>
</doc:description>
<doc:permission>Callers need the org.freedesktop.packagekit.install-signature</doc:permission>
</doc:doc>
<arg type="u" name="sig_type" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
A key type enum, e.g. <doc:tt>gpg</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="key_id" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
A key ID, e.g. <doc:tt>BB7576AC</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="package_id" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
A PackageID for the package that the user is trying to install
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="RefreshCache">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
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.
</doc:para>
<doc:para>
When fetching each software source, ensure to emit RepoDetail for the
current source 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 source.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>Progress</doc:tt>,
<doc:tt>Error</doc:tt> and
<doc:tt>RepoDetail</doc:tt>.
</doc:para>
</doc:description>
<doc:permission>Callers need the org.freedesktop.packagekit.refresh-cache</doc:permission>
</doc:doc>
<arg type="b" name="force" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
If the caches should be cleaned and reloaded even if there is valid, up to date data.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="RemovePackages">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method removes packages from the local system.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>Progress</doc:tt>,
<doc:tt>Status</doc:tt> and
<doc:tt>Error</doc:tt> and
<doc:tt>Package</doc:tt>.
</doc:para>
<doc:para>
<doc:tt>Package</doc:tt> enumerated types should be
<doc:tt>downloading</doc:tt>,
<doc:tt>updating</doc:tt>,
<doc:tt>installing</doc:tt> or
<doc:tt>removing</doc:tt>.
</doc:para>
</doc:description>
<doc:permission>Callers need the org.freedesktop.packagekit.remove</doc:permission>
</doc:doc>
<arg type="t" name="transaction_flags" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
If the transaction should be simulated or prepared.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="package_ids" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
An array of package IDs.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="b" name="allow_deps" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
Either <doc:tt>true</doc:tt> or <doc:tt>false</doc:tt>.
If <doc:tt>true</doc:tt> allow other packages to be removed with the package,
but <doc:tt>false</doc:tt> should cause the script to abort if other packages
are dependant on the package.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="b" name="autoremove" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
Either <doc:tt>true</doc:tt> or <doc:tt>false</doc:tt>.
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 OpenOffice, it might download libneon as a dependency.
When <doc:tt>auto_remove</doc:tt> is set to true, and you remove OpenOffice then
libneon will also get removed automatically.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="RepoEnable">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method enables the repository specified.
</doc:para>
</doc:description>
<doc:permission>Callers need the org.freedesktop.packagekit.repo-change</doc:permission>
</doc:doc>
<arg type="s" name="repo_id" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
A repository identifier, e.g. <doc:tt>fedora-development-debuginfo</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="b" name="enabled" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
<doc:tt>true</doc:tt> if enabled, <doc:tt>false</doc:tt> if disabled.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="RepoSetData">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method allows arbitary data to be passed to the repository handler.
</doc:para>
</doc:description>
<doc:permission>Callers need the org.freedesktop.packagekit.repo-change</doc:permission>
</doc:doc>
<arg type="s" name="repo_id" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
A repository identifier, e.g. <doc:tt>fedora-development-debuginfo</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="parameter" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
The backend specific value, e.g. <doc:tt>set-download-url</doc:tt>.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="value" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
The backend specific value, e.g. <doc:tt>http://foo.bar.org/baz</doc:tt>.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="Resolve">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method turns a single package name into a package_id suitable for the
other methods.
</doc:para>
<doc:para>
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.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>Error</doc:tt> and
<doc:tt>Package</doc:tt>.
</doc:para>
<doc:para>
<doc:tt>Package</doc:tt> enumerated types should be
<doc:tt>available</doc:tt> or <doc:tt>installed</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
<arg type="t" name="filter" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
A correct filter bitfield, e.g. <doc:tt>none</doc:tt> or <doc:tt>installed;~devel</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="packages" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
An array of package names, e.g. <doc:tt>scribus-clipart</doc:tt>.
</doc:para>
<doc:para>
The package names are case sensitive, so for instance:
<doc:tt>Resolve('Packagekit')</doc:tt> would not match <doc:tt>PackageKit</doc:tt>.
</doc:para>
<doc:para>
As a special case, if <doc:tt>Resolve()</doc:tt>doc:tt> is called
with a name prefixed with <doc:tt>@</doc:tt> then
this should be treated as a category, for example:
<doc:tt>@web-development</doc:tt>.
In this instance, a meta-package should be emitted, for example:
<doc:tt>web-development;;;meta</doc:tt> with the correct
installed status and summary for the category.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="SearchDetails">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method allows deeper searching than SearchName().
</doc:para>
<doc:para>
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.
</doc:para>
<doc:para>
Try to emit <doc:tt>installed</doc:tt> before
<doc:tt>available</doc:tt> packages first, as it allows the client
program to perform the GUI filtering and matching whilst the daemon is
running the transaction.
</doc:para>
<doc:para>
If the backend includes <doc:tt>installed</doc:tt> and
<doc:tt>available</doc:tt> versions of the same package when searching
then the <doc:tt>available</doc:tt> version will have to be filtered
in the backend.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>Progress</doc:tt>,
<doc:tt>Error</doc:tt> and
<doc:tt>Package</doc:tt>.
</doc:para>
<doc:para>
<doc:tt>Package</doc:tt> enumerated types should be
<doc:tt>available</doc:tt> or <doc:tt>installed</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
<arg type="t" name="filter" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
A correct filter bitfield, e.g. <doc:tt>none</doc:tt> or <doc:tt>installed;~devel</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="values" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
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 <doc:tt>AND</doc:tt> and the words can be found
in any details section/field. For example, search of
<doc:tt>GPL games</doc:tt> should returns every games with a GPL
license.
</doc:para>
<doc:para>
The search should not be treated as case sensitive.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="SearchFiles">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method searches for files on the local system and files in available packages.
</doc:para>
<doc:para>
This should search for files.
This should allow an application to find out what package owns
a file on the system.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>Progress</doc:tt>,
<doc:tt>Error</doc:tt> and
<doc:tt>Package</doc:tt>.
</doc:para>
<doc:para>
<doc:tt>Package</doc:tt> enumerated types should be
<doc:tt>available</doc:tt> or <doc:tt>installed</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
<arg type="t" name="filter" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
A correct filter bitfield, e.g. <doc:tt>none</doc:tt> or <doc:tt>installed;~devel</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="values" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
A filename or fully qualified path and filename on the system.
If the search term begins with a <doc:tt>/</doc:tt> 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 <doc:tt>/</doc:tt> then it should be treated as a single filename, which can be in any directory.
</doc:para>
<doc:para>
The search is case sensitive, and should not be escaped or surrounded in quotes.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="SearchGroups">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method returns packages from a given group enumerated type.
</doc:para>
<doc:para>
Do not refresh the package cache. This should be fast.
</doc:para>
<doc:para>
Try to emit <doc:tt>installed</doc:tt> before
<doc:tt>available</doc:tt> packages first, as it allows the client
program to perform the GUI filtering and matching whilst the daemon is
running the transaction.
</doc:para>
<doc:para>
If the backend includes <doc:tt>installed</doc:tt> and
<doc:tt>available</doc:tt> versions of the same package when searching
then the <doc:tt>available</doc:tt> version will have to be filtered
in the backend.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>Progress</doc:tt>,
<doc:tt>Error</doc:tt> and
<doc:tt>Package</doc:tt>.
</doc:para>
<doc:para>
<doc:tt>Package</doc:tt> enumerated types should be
<doc:tt>available</doc:tt> or <doc:tt>installed</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
<arg type="t" name="filter" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
A correct filter bitfield, e.g. <doc:tt>none</doc:tt> or <doc:tt>installed;~devel</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="values" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
An enumerated group type, or <doc:tt>unknown</doc:tt>. The search
cannot contain spaces.
The following recommendations are made below:
</doc:para>
<doc:para>
If the values strings are prefixed with <doc:tt>category:</doc:tt> then
the request is treated as a 'category search', for example:
<doc:tt>category:web-development</doc:tt>.
</doc:para>
<doc:para>
If the values strings are prefixed with <doc:tt>repo:</doc:tt> then
the request is treated as a 'repository search', for example:
<doc:tt>repo:fedora-debuginfo</doc:tt>.
In this instance all packages that were either installed
from, or can be installed from the <doc:tt>fedora-debuginfo</doc:tt>
source would be returned.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="SearchNames">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method searches the package database by package name.
</doc:para>
<doc:para>
Do not refresh the package cache. This should be fast.
</doc:para>
<doc:para>
Try to emit <doc:tt>installed</doc:tt> before
<doc:tt>available</doc:tt> packages first, as it allows the client
program to perform the GUI filtering and matching whilst the daemon is
running the transaction.
</doc:para>
<doc:para>
If the backend includes <doc:tt>installed</doc:tt> and
<doc:tt>available</doc:tt> versions of the same package when searching
then the <doc:tt>available</doc:tt> version will have to be filtered
in the backend.
</doc:para>
<doc:para>
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
<doc:tt>newest</doc:tt> filter should be used.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>Progress</doc:tt>,
<doc:tt>Error</doc:tt> and
<doc:tt>Package</doc:tt>.
</doc:para>
<doc:para>
<doc:tt>Package</doc:tt> enumerated types should be
<doc:tt>available</doc:tt> or <doc:tt>installed</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
<arg type="t" name="filter" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
A correct filter bitfield, e.g. <doc:tt>none</doc:tt> or <doc:tt>installed;~devel</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="values" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
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 <doc:tt>AND</doc:tt>. For example, search of
<doc:tt>gnome power</doc:tt> should returns
<doc:tt>gnome-power-manager</doc:tt> but not
<doc:tt>gnomesword</doc:tt> or <doc:tt>powertop</doc:tt>.
</doc:para>
<doc:para>
The search should not be treated as case sensitive.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="UpdatePackages">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method updates existing packages on the local system.
</doc:para>
<doc:para>
The installer should always update extra packages automatically to fulfil dependencies.
</doc:para>
<doc:para>
This should allow an application to find out what package owns a file on the system.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>Progress</doc:tt>,
<doc:tt>Status</doc:tt> and
<doc:tt>Error</doc:tt> and
<doc:tt>Package</doc:tt>.
</doc:para>
</doc:description>
<doc:permission>Callers need the org.freedesktop.packagekit.update-package</doc:permission>
</doc:doc>
<arg type="t" name="transaction_flags" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
If the transaction is only allowed to update to trusted packages.
Unsigned packages should not be installed if this transaction_flags has <doc:tt>ONLY_TRUSTED</doc:tt>.
</doc:para>
<doc:para>
If this method is can only update trusted packages, and the packages are unsigned, then
the backend will send a <doc:tt>ErrorCode(missing-gpg-signature)</doc:tt>.
On recieving this error, the client may choose to retry with only_trusted <doc:tt>FALSE</doc:tt>
after gaining further authentication.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="package_ids" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
An array of package IDs.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="WhatProvides">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
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.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>Progress</doc:tt>,
<doc:tt>Status</doc:tt> and
<doc:tt>Error</doc:tt> and
<doc:tt>Package</doc:tt>.
</doc:para>
<doc:para>
<doc:tt>Package</doc:tt> enumerated types should be
<doc:tt>available</doc:tt> or <doc:tt>installed</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
<arg type="t" name="filter" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
A correct filter bitfield, e.g. <doc:tt>none</doc:tt> or <doc:tt>installed;~devel</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="u" name="type" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
A PkProvideType, e.g. <doc:tt>PK_PROVIDES_ENUM_CODEC</doc:tt>.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="values" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
The data to send to the backend to get the packages.
Note: This is backend specific.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="UpgradeSystem">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method perfoms a distribution upgrade to the specified
version.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>Progress</doc:tt>,
<doc:tt>Status</doc:tt> and
<doc:tt>Error</doc:tt> and
<doc:tt>Package</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
<arg type="s" name="distro_id" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
The distribution ID to upgrade to, e.g. <doc:tt>fedora-14</doc:tt>.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="u" name="upgrade_kind" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
The type of upgrade, e.g. <doc:tt>minimal</doc:tt>, <doc:tt>default</doc:tt> or <doc:tt>complete</doc:tt>.
Minimal upgrades will download the smallest amount of data
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.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<method name="RepairSystem">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
This method recovers the package management system from e.g.
unsatisfied dependencies of installed packages.
</doc:para>
<doc:para>
This method typically emits
<doc:tt>Progress</doc:tt>,
<doc:tt>Status</doc:tt> and
<doc:tt>Error</doc:tt> and
<doc:tt>Package</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
<arg type="t" name="transaction_flags" direction="in">
<doc:doc>
<doc:summary>
<doc:para>
If the transaction is only allowed to install trusted packages.
Unsigned packages should not be installed if this transaction_flags has <doc:tt>ONLY_TRUSTED</doc:tt>.
</doc:para>
<doc:para>
If this method is can only install trusted packages, and the packages are unsigned, then
the backend will send a <doc:tt>ErrorCode(missing-gpg-signature)</doc:tt>.
On recieving this error, the client may choose to retry with only_trusted <doc:tt>FALSE</doc:tt>
after gaining further authentication.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--*********************************************************************-->
<signal name="Category">
<doc:doc>
<doc:description>
<doc:para>
This signal send information about a collection category
</doc:para>
</doc:description>
</doc:doc>
<arg type="s" name="parent_id" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The parent identifier, e.g. <doc:tt>applications</doc:tt>.
If the category is a root entry, use a blank parent.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="cat_id" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The category identifier, e.g. <doc:tt>applications;system-tools</doc:tt>.
The identifier does not have to be related to the <doc:tt>parent_id</doc:tt>
in any way.
A menu tree is made from multiple Category signals.
The tree does not have any depth or bredth limits, although it should be kept
to less than about 100 entries as this will be shown to the user in a menu.
</doc:para>
<doc:para>
The <doc:tt>cat_id</doc:tt> will be sent as a parameter to <doc:tt>SearchGroup</doc:tt>
so you may have to prefix or otherwise identify the ID to not confuse the search method.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="name" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The localised name of the category, e.g. <doc:tt>System Tools</doc:tt>.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="summary" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The localised category summary, e.g. <doc:tt>Tools for mangaing system state</doc:tt>.
This is not normally shown in the menus, but may be shown in helper popups.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="icon" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The icon name for the category, e.g. <doc:tt>server-cfg</doc:tt>.
If the icon is not known, then it should be set to <doc:tt>image-missing</doc:tt>.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</signal>
<!--*********************************************************************-->
<signal name="Details">
<doc:doc>
<doc:description>
<doc:para>
This signal allows the backend to convey more details about the package.
</doc:para>
</doc:description>
</doc:doc>
<arg type="s" name="package_id" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The package ID
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="license" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The license string, e.g. <doc:tt>GPLv2+</doc:tt> or <doc:tt>BSD and (MPLv1.1 or GPLv2+)</doc:tt>.
</doc:para>
<doc:para>
More details about the correct way to format licensing strings can be found on the
<doc:ulink url="http://fedoraproject.org/wiki/Packaging/LicensingGuidelines">Fedora packaging wiki</doc:ulink>.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="u" name="group" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The enumerated package group description
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="detail" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The multi-line package description.
</doc:para>
<doc:para>
If formatting is required, then markdown syntax should be used,
e.g. <doc:tt>This is **critically** important</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="url" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The upstream project homepage
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="t" name="size" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The size of the package in bytes. This should be the size of the entire package file,
not the size of the files installed on the system.
If the package is not installed, and already downloaded and
present in the package manager cache, then this value should be set to zero.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</signal>
<!--*********************************************************************-->
<signal name="ErrorCode">
<doc:doc>
<doc:description>
<doc:para>
This signal is used to report errors back to the session program.
</doc:para>
<doc:para>
Errors should only be send on fatal abort.
</doc:para>
</doc:description>
</doc:doc>
<arg type="u" name="code" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
Enumerated type, e.g. <doc:tt>no-network</doc:tt>.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="details" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
Long description or error, e.g. <doc:tt>failed to connect to mytry.xml</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</signal>
<!--*********************************************************************-->
<signal name="Files">
<doc:doc>
<doc:description>
<doc:para>
This signal is used to push file lists from the backend to the session.
</doc:para>
</doc:description>
</doc:doc>
<arg type="s" name="package_id" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The Package ID that called the method.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="file_list" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The file list as an array.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</signal>
<!--*********************************************************************-->
<signal name="Finished">
<doc:doc>
<doc:description>
<doc:para>
This signal is used to signal that the transaction has finished.
</doc:para>
</doc:description>
</doc:doc>
<arg type="u" name="exit" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The PkExitEnum describing the exit status of the transaction.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="u" name="runtime" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The amount of time in milliseconds that the transaction ran for.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</signal>
<!--*********************************************************************-->
<signal name="Message">
<doc:doc>
<doc:description>
<doc:para>
This signal is sent when the backend wants to send a message to the session.
</doc:para>
<doc:para>
This allows the backend to queue up a message to be shown after the transaction has
completed.
</doc:para>
</doc:description>
</doc:doc>
<arg type="u" name="type" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
One of <doc:tt>warning</doc:tt>, <doc:tt>notice</doc:tt>, or
<doc:tt>daemon</doc:tt>.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="details" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
Required details about the message, non-localised.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</signal>
<!--*********************************************************************-->
<signal name="Package">
<doc:doc>
<doc:description>
<doc:para>
This signal allows the backend to communicate packages to the session.
</doc:para>
<doc:para>
If updating, as packages are updated then emit them to the screen.
This allows a summary to be presented after the transaction.
</doc:para>
<doc:para>
When returning results from a search always return
<doc:tt>installed</doc:tt> before <doc:tt>available</doc:tt> for
the same package name.
</doc:para>
</doc:description>
</doc:doc>
<arg type="u" name="info" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
A valid <doc:tt>info</doc:tt> enumerated type
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="package_id" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
This identifier is of the form <doc:tt>name;version;arch;data</doc:tt>
in a single string and is meant to represent a single package
unique across all local and remote data stores.
</doc:para>
<doc:para>
For a remote, not-installed package the data field should
be set as the repository identifier or repository name.
</doc:para>
<doc:para>
The data field for an installed package must be prefixed
with <doc:tt>installed</doc:tt> as this is used to identify
which packages are installable or installed in the client
tools.
</doc:para>
<doc:para>
As a special extension, if the package manager is able to
track which repository a package was originally installed
from, then the data field can be set to
<doc:tt>installed:REPO-NAME</doc:tt> which allows the
frontend client to advise the user of the package origin.
</doc:para>
<doc:para>
The data field for a non-installed local package must be
<doc:tt>local</doc:tt> as this signifies a repository name is
not available and that package resides locally on the
client system rather than in any specific repository.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="summary" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The one line package summary, e.g. Clipart for OpenOffice
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</signal>
<!--*********************************************************************-->
<signal name="RepoDetail">
<doc:doc>
<doc:description>
<doc:para>
This signal describes a repository on the system.
</doc:para>
</doc:description>
</doc:doc>
<arg type="s" name="repo_id" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The repository ID.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="description" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
A description of the repository.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="b" name="enabled" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
If the repository is enabled and in use.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</signal>
<!--*********************************************************************-->
<signal name="RepoSignatureRequired">
<doc:doc>
<doc:description>
<doc:para>
This signal is emitted when a transaction is not possible due to a missing security
certificate.
</doc:para>
<doc:para>
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.
</doc:para>
<doc:para>
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.
</doc:para>
</doc:description>
</doc:doc>
<arg type="s" name="package_id" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
A package ID for the package that is trying to be installed
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="repository_name" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The name of the repository associated with the provided key.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="key_url" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The URL provided with the key.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="key_userid" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The user id associated with the key.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="key_id" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
A unique identifier for the key.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="key_fingerprint" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The hashed fingerprint of the key.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="key_timestamp" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The date the key was created.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="u" name="type" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The type of signature used. <doc:tt>gpg</doc:tt>, for example.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</signal>
<!--*********************************************************************-->
<signal name="EulaRequired">
<doc:doc>
<doc:description>
<doc:para>
This signal is emitted when a transaction is not possible due to a EULA that needs to
be agreed to at install time.
</doc:para>
<doc:para>
Some backends support EULAs, which have to be agreed to before the install can proceed.
</doc:para>
</doc:description>
</doc:doc>
<arg type="s" name="eula_id" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The <doc:tt>eula_id</doc:tt> 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 <doc:tt>eula_id</doc:tt>'s is <doc:tt>vmware5_single_user</doc:tt>.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="package_id" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
A package ID for the package that is trying to be installed.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="vendor_name" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The vendor that is providing the EULA.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="license_agreement" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The full text EULA.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</signal>
<!--*********************************************************************-->
<signal name="MediaChangeRequired">
<doc:doc>
<doc:description>
<doc:para>
This signal is emitted when a transaction needsneeds a different media
to grab the packages.
</doc:para>
<doc:para>
Some backends support Media changing, which will fail the transaction each time it needs
a new media.
</doc:para>
</doc:description>
</doc:doc>
<arg type="u" name="media_type" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
Enumerated type, e.g. <doc:tt>dvd</doc:tt>.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="media_id" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The <doc:tt>media_id</doc:tt> which identifies the Media - this is provided
so that if DeviceKit or another program is able to identify the right media
before continuing, note however that it's not the DeviceKit oblication to
check the media when the transaction is re-scheduled this is the backend task.
An example <doc:tt>media_id</doc:tt>'s is <doc:tt>Debian testing amd64 Bin-1</doc:tt>.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="media_text" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
Might be used for the disk label too, something like <doc:tt>Fedora Disk 1</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</signal>
<!--*********************************************************************-->
<signal name="RequireRestart">
<doc:doc>
<doc:description>
<doc:para>
This signal is sent when the session program should notify the user that a restart is
required.
</doc:para>
<doc:para>
This is optional, but highly recommended.
</doc:para>
<doc:para>
This can be sent as many times as needed by the backend script.
PackageKit will always choose the 'worst' method in the UI notification.
</doc:para>
</doc:description>
</doc:doc>
<arg type="u" name="type" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
One of <doc:tt>system</doc:tt>, <doc:tt>application</doc:tt> or
<doc:tt>session</doc:tt>.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="package_id" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The package ID that caused the restart notifier.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</signal>
<!--*********************************************************************-->
<signal name="Transaction">
<doc:doc>
<doc:description>
<doc:para>
This signal is sent when more details are required about a specific transaction.
</doc:para>
</doc:description>
</doc:doc>
<arg type="o" name="object_path" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The transaction ID of the old transaction.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="timespec" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The timespec of the old transaction in ISO8601 format.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="b" name="succeeded" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
If the transaction succeeded.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="u" name="role" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The role enumerated type.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="u" name="duration" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The duration of the transaction in milliseconds.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="data" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
Any data associated with the transaction.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="u" name="uid" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The user ID of the user that scheduled the action.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="cmdline" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The command line of the tool that scheduled the action, e.g.
<doc:tt>/usr/bin/gpk-application</doc:tt>.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</signal>
<!--*********************************************************************-->
<signal name="UpdateDetail">
<doc:doc>
<doc:description>
<doc:para>
This signal is sent when more details are required about a specific update.
</doc:para>
</doc:description>
</doc:doc>
<arg type="s" name="package_id" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The package ID
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="updates" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
A list of package_id's that are to be updated.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="obsoletes" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
A list of package_id's that are to be obsoleted.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="vendor_urls" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
A list of URLs with more details on the update, e.g. a page with more
information on the update.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="bugzilla_urls" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
A list of bugzilla URL with more details on the update.
If no URLs are available then this field should be left empty.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="as" name="cve_urls" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
A list of CVE URLs with more details on the security advisory.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="u" name="restart" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
A valid restart type, e.g. <doc:tt>system</doc:tt>.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="update_text" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The update text describing the update.
</doc:para>
<doc:para>
If formatting is required, then markdown syntax should be used,
e.g. <doc:tt>This is **critically** important</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="changelog" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The ChangeLog text describing the changes since the last version.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="u" name="state" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The state of the update, e.g. <doc:tt>stable</doc:tt> or
<doc:tt>testing</doc:tt>.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="issued" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The ISO8601 encoded date that the update was issued.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="updated" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The ISO8601 encoded date that the update was updated.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</signal>
<!--*********************************************************************-->
<signal name="DistroUpgrade">
<doc:doc>
<doc:description>
<doc:para>
This signal allows the backend to communicate distribution
upgrades to the session.
</doc:para>
</doc:description>
</doc:doc>
<arg type="u" name="type" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
A valid upgrade enumerated type, e.g. <doc:tt>stable</doc:tt>
or <doc:tt>unstable</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="name" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The short name of the distribution, e.g. <doc:tt>Fedora Core 10 RC1</doc:tt>
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="s" name="summary" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The multi-line description of the release.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</signal>
<!--*********************************************************************-->
<signal name="ItemProgress">
<doc:doc>
<doc:description>
<doc:para>
This signal allows the backend to send infomation about
package or repository progress when using Simultanous mode.
</doc:para>
</doc:description>
</doc:doc>
<arg type="s" name="id" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
A valid package_id, e.g. <doc:tt>hal;0.1.0;i386;fedora</doc:tt>
or a repo_id.
</doc:para>
<doc:para>
A repo_id may only be used when running RefreshCache.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="u" name="status" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The status enumerated value that is being completed.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type="u" name="percentage" direction="out">
<doc:doc>
<doc:summary>
<doc:para>
The percentage of this package action is completed.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</signal>
<!--*********************************************************************-->
<signal name="Changed">
<doc:doc>
<doc:description>
<doc:para>
This signal is emitted when a property on the interface changes.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!--*********************************************************************-->
<signal name="Destroy">
<doc:doc>
<doc:description>
<doc:para>
This signal is sent when the transaction has been destroyed and is
no longer available for use.
</doc:para>
</doc:description>
</doc:doc>
</signal>
</interface>
</node>
|