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
|
<?xml version="1.0"?><!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="PackageKit">
<refmeta>
<refentrytitle role="top_of_page">org.freedesktop.PackageKit</refentrytitle>
</refmeta>
<refnamediv>
<refname>org.freedesktop.PackageKit</refname>
<refpurpose>PackageKit interface</refpurpose>
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Methods</title>
<synopsis><link linkend="PackageKit.CanAuthorize">CanAuthorize</link> (in 's' action_id,
out 's' result)
<link linkend="PackageKit.GetTid">GetTid</link> (out 's' tid)
<link linkend="PackageKit.GetTimeSinceAction">GetTimeSinceAction</link> (in 's' role,
out 'u' seconds)
<link linkend="PackageKit.GetTransactionList">GetTransactionList</link> (out 'as' transactions)
<link linkend="PackageKit.StateHasChanged">StateHasChanged</link> (in 's' reason)
<link linkend="PackageKit.SuggestDaemonQuit">SuggestDaemonQuit</link> ()
<link linkend="PackageKit.GetDaemonState">GetDaemonState</link> (out 's' state)
<link linkend="PackageKit.SetProxy">SetProxy</link> (in 's' proxy_http,
in 's' proxy_https,
in 's' proxy_ftp,
in 's' proxy_socks,
in 's' no_proxy,
in 's' pac)
<link linkend="PackageKit.SetRoot">SetRoot</link> (in 's' root)
</synopsis>
</refsynopsisdiv>
<refsect1 role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis><link linkend="PackageKit::TransactionListChanged">TransactionListChanged</link> ('as' transactions)
<link linkend="PackageKit::RestartSchedule">RestartSchedule</link> ()
<link linkend="PackageKit::RepoListChanged">RepoListChanged</link> ()
<link linkend="PackageKit::UpdatesChanged">UpdatesChanged</link> ()
<link linkend="PackageKit::Changed">Changed</link> ()
</synopsis>
</refsect1>
<refsect1 role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>org.freedesktop.PackageKit implements
org.freedesktop.DBus.Introspectable,
org.freedesktop.DBus.Properties
</para>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis><link linkend="PackageKit:VersionMajor">'VersionMajor'</link> read 'u'
<link linkend="PackageKit:VersionMinor">'VersionMinor'</link> read 'u'
<link linkend="PackageKit:VersionMicro">'VersionMicro'</link> read 'u'
<link linkend="PackageKit:BackendName">'BackendName'</link> read 's'
<link linkend="PackageKit:BackendDescription">'BackendDescription'</link> read 's'
<link linkend="PackageKit:BackendAuthor">'BackendAuthor'</link> read 's'
<link linkend="PackageKit:Roles">'Roles'</link> read 's'
<link linkend="PackageKit:Groups">'Groups'</link> read 's'
<link linkend="PackageKit:Filters">'Filters'</link> read 's'
<link linkend="PackageKit:MimeTypes">'MimeTypes'</link> read 's'
<link linkend="PackageKit:Locked">'Locked'</link> read 'b'
<link linkend="PackageKit:NetworkState">'NetworkState'</link> read 's'
<link linkend="PackageKit:DistroId">'DistroId'</link> read 's'
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
<para>
The root interface is used for interacting with the daemon.
</para>
</para>
</refsect1>
<refsect1 role="details"><title role="details.title">Details</title><refsect2><title><anchor role="function" id="PackageKit.CanAuthorize"/>CanAuthorize ()</title><indexterm><primary>CanAuthorize</primary><secondary>PackageKit</secondary></indexterm><programlisting>CanAuthorize (in 's' action_id,
out 's' result)</programlisting></refsect2>
<para>
Allows a client to find out if it would be allowed to authorize an action.
</para>
<variablelist role="params"><varlistentry><term><parameter>action_id</parameter>:</term><listitem><simpara>
The action ID, e.g. org.freedesktop.packagekit.system-network-proxy-configure
</simpara></listitem></varlistentry><varlistentry><term><parameter>result</parameter>:</term><listitem><simpara>
The result, either yes, no or interactive.
</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="PackageKit.GetTid"/>GetTid ()</title><indexterm><primary>GetTid</primary><secondary>PackageKit</secondary></indexterm><programlisting>GetTid (out 's' tid)</programlisting></refsect2>
<para>
Gets a new transaction ID from the daemon
</para>
<variablelist role="params"><varlistentry><term><parameter>tid</parameter>:</term><listitem><simpara>
The tid, e.g. 45_dafeca_checkpoint32
</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="PackageKit.GetTimeSinceAction"/>GetTimeSinceAction ()</title><indexterm><primary>GetTimeSinceAction</primary><secondary>PackageKit</secondary></indexterm><programlisting>GetTimeSinceAction (in 's' role,
out 'u' seconds)</programlisting></refsect2>
<para>
This method allows us to query how long since an action has successfully completed.
</para>
<variablelist role="params"><varlistentry><term><parameter>role</parameter>:</term><listitem><simpara>
The role, e.g. update-system
</simpara></listitem></varlistentry><varlistentry><term><parameter>seconds</parameter>:</term><listitem><simpara>
The amount of time in seconds
</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="PackageKit.GetTransactionList"/>GetTransactionList ()</title><indexterm><primary>GetTransactionList</primary><secondary>PackageKit</secondary></indexterm><programlisting>GetTransactionList (out 'as' transactions)</programlisting></refsect2>
<para>
Gets the transaction list of any transactions that are in progress
</para>
<variablelist role="params"><varlistentry><term><parameter>transactions</parameter>:</term><listitem><simpara>
A list of transaction ID's
</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="PackageKit.StateHasChanged"/>StateHasChanged ()</title><indexterm><primary>StateHasChanged</primary><secondary>PackageKit</secondary></indexterm><programlisting>StateHasChanged (in 's' reason)</programlisting></refsect2>
<para>
This method suggests to PackageKit that the package backend state may have changed.
This allows plugins to the native package manager to suggest that PackageKit drops
it's caches.
</para>
<variablelist role="params"><varlistentry><term><parameter>reason</parameter>:</term><listitem><simpara>
The reason of the state change. Valid reasons are resume or
posttrans.
Resume is given a lower priority than posttrans.
</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="PackageKit.SuggestDaemonQuit"/>SuggestDaemonQuit ()</title><indexterm><primary>SuggestDaemonQuit</primary><secondary>PackageKit</secondary></indexterm><programlisting>SuggestDaemonQuit ()</programlisting></refsect2>
<para>
Suggests to the daemon that it should quit as soon as possible, for instance if a native
package management tool is waiting to be used.
</para>
<variablelist role="params"/><refsect2><title><anchor role="function" id="PackageKit.GetDaemonState"/>GetDaemonState ()</title><indexterm><primary>GetDaemonState</primary><secondary>PackageKit</secondary></indexterm><programlisting>GetDaemonState (out 's' state)</programlisting></refsect2>
<para>
Gets the debugging state from the daemon.
No secure state will be shown, and all information is for reference only.
</para>
<variablelist role="params"><varlistentry><term><parameter>state</parameter>:</term><listitem><simpara>
The state of the dameon at this specific moment.
</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="PackageKit.SetProxy"/>SetProxy ()</title><indexterm><primary>SetProxy</primary><secondary>PackageKit</secondary></indexterm><programlisting>SetProxy (in 's' proxy_http,
in 's' proxy_https,
in 's' proxy_ftp,
in 's' proxy_socks,
in 's' no_proxy,
in 's' pac)</programlisting></refsect2>
<para>
Sets the proxy used by the dameon.
</para>
<variablelist role="params"><varlistentry><term><parameter>proxy_http</parameter>:</term><listitem><simpara>
The HTTP proxy, e.g. username:password@server:port.
</simpara></listitem></varlistentry><varlistentry><term><parameter>proxy_https</parameter>:</term><listitem><simpara>
The HTTPS proxy, e.g. username:password@server:port.
</simpara></listitem></varlistentry><varlistentry><term><parameter>proxy_ftp</parameter>:</term><listitem><simpara>
The FTP proxy, e.g. username:password@server:port.
</simpara></listitem></varlistentry><varlistentry><term><parameter>proxy_socks</parameter>:</term><listitem><simpara>
The SOCKS proxy, e.g. username:password@server:port.
</simpara></listitem></varlistentry><varlistentry><term><parameter>no_proxy</parameter>:</term><listitem><simpara>
The comma seporated list of sites to not use the proxy for, e.g.
127.0.0.1,localmirror.org.
</simpara></listitem></varlistentry><varlistentry><term><parameter>pac</parameter>:</term><listitem><simpara>
The PAC file for the proxy, e.g.
/etc/network/school.pac.
Note: Most backends will not be able to use a PAC file.
</simpara></listitem></varlistentry></variablelist><para role="permission">Callers need the org.freedesktop.packagekit.set-proxy</para><refsect2><title><anchor role="function" id="PackageKit.SetRoot"/>SetRoot ()</title><indexterm><primary>SetRoot</primary><secondary>PackageKit</secondary></indexterm><programlisting>SetRoot (in 's' root)</programlisting></refsect2>
<para>
Sets the root used by the dameon backend.
</para>
<variablelist role="params"><varlistentry><term><parameter>root</parameter>:</term><listitem><simpara>
The install root, e.g. / or /mnt/ltsp.
</simpara></listitem></varlistentry></variablelist><para role="permission">Callers need the org.freedesktop.packagekit.system-change-install-root</para></refsect1>
<refsect1 role="signals"><title role="signals.title">Signal Details</title><refsect2><title><anchor role="function" id="PackageKit::TransactionListChanged"/>The TransactionListChanged signal</title><indexterm><primary>TransactionListChanged</primary><secondary>PackageKit</secondary></indexterm><programlisting>TransactionListChanged ('as' transactions)</programlisting></refsect2>
<para>
The transaction list has changed, because either a transaction has finished or a new
transaction created.
</para>
<variablelist role="params"><varlistentry><term><parameter>transactions</parameter>:</term><listitem><simpara>
A list of transaction ID's.
</simpara></listitem></varlistentry></variablelist><refsect2><title><anchor role="function" id="PackageKit::RestartSchedule"/>The RestartSchedule signal</title><indexterm><primary>RestartSchedule</primary><secondary>PackageKit</secondary></indexterm><programlisting>RestartSchedule ()</programlisting></refsect2>
<para>
A system restart has been sceduled
</para>
<variablelist role="params"/><refsect2><title><anchor role="function" id="PackageKit::RepoListChanged"/>The RepoListChanged signal</title><indexterm><primary>RepoListChanged</primary><secondary>PackageKit</secondary></indexterm><programlisting>RepoListChanged ()</programlisting></refsect2>
<para>
This signal is emitted when the repository list has changed
</para>
<variablelist role="params"/><refsect2><title><anchor role="function" id="PackageKit::UpdatesChanged"/>The UpdatesChanged signal</title><indexterm><primary>UpdatesChanged</primary><secondary>PackageKit</secondary></indexterm><programlisting>UpdatesChanged ()</programlisting></refsect2>
<para>
This signal is emitted when the number of updates has changed
</para>
<variablelist role="params"/><refsect2><title><anchor role="function" id="PackageKit::Changed"/>The Changed signal</title><indexterm><primary>Changed</primary><secondary>PackageKit</secondary></indexterm><programlisting>Changed ()</programlisting></refsect2>
<para>
This signal is emitted when a property on the interface changes.
</para>
<variablelist role="params"/></refsect1>
<refsect1 role="property_details"><title role="property_details.title">Property Details</title><refsect2><title><anchor role="function" id="PackageKit:VersionMajor"/>The "VersionMajor" property</title><indexterm><primary>VersionMajor</primary><secondary>PackageKit</secondary></indexterm><programlisting>'VersionMajor' read 'u'
</programlisting></refsect2>
<para>
The major version number.
</para>
<variablelist role="params"/><refsect2><title><anchor role="function" id="PackageKit:VersionMinor"/>The "VersionMinor" property</title><indexterm><primary>VersionMinor</primary><secondary>PackageKit</secondary></indexterm><programlisting>'VersionMinor' read 'u'
</programlisting></refsect2>
<para>
The minor version number.
</para>
<variablelist role="params"/><refsect2><title><anchor role="function" id="PackageKit:VersionMicro"/>The "VersionMicro" property</title><indexterm><primary>VersionMicro</primary><secondary>PackageKit</secondary></indexterm><programlisting>'VersionMicro' read 'u'
</programlisting></refsect2>
<para>
The micro version number.
</para>
<variablelist role="params"/><refsect2><title><anchor role="function" id="PackageKit:BackendName"/>The "BackendName" property</title><indexterm><primary>BackendName</primary><secondary>PackageKit</secondary></indexterm><programlisting>'BackendName' read 's'
</programlisting></refsect2>
<para>
The backend name, e.g. "yum".
</para>
<variablelist role="params"/><refsect2><title><anchor role="function" id="PackageKit:BackendDescription"/>The "BackendDescription" property</title><indexterm><primary>BackendDescription</primary><secondary>PackageKit</secondary></indexterm><programlisting>'BackendDescription' read 's'
</programlisting></refsect2>
<para>
The backend description, e.g. "Yellow Dog Update Modifier".
</para>
<variablelist role="params"/><refsect2><title><anchor role="function" id="PackageKit:BackendAuthor"/>The "BackendAuthor" property</title><indexterm><primary>BackendAuthor</primary><secondary>PackageKit</secondary></indexterm><programlisting>'BackendAuthor' read 's'
</programlisting></refsect2>
<para>
The backend author, e.g. "Joe Bloggs <joe&blogs.com>".
</para>
<variablelist role="params"/><refsect2><title><anchor role="function" id="PackageKit:Roles"/>The "Roles" property</title><indexterm><primary>Roles</primary><secondary>PackageKit</secondary></indexterm><programlisting>'Roles' read 's'
</programlisting></refsect2>
<para>
The roles the backend supports, e.g. "search-name;refresh-cache".
</para>
<variablelist role="params"/><refsect2><title><anchor role="function" id="PackageKit:Groups"/>The "Groups" property</title><indexterm><primary>Groups</primary><secondary>PackageKit</secondary></indexterm><programlisting>'Groups' read 's'
</programlisting></refsect2>
<para>
The groups the backend supports, e.g. "accessories;games".
</para>
<variablelist role="params"/><refsect2><title><anchor role="function" id="PackageKit:Filters"/>The "Filters" property</title><indexterm><primary>Filters</primary><secondary>PackageKit</secondary></indexterm><programlisting>'Filters' read 's'
</programlisting></refsect2>
<para>
The filters the backend supports, e.g. "installed;newest".
</para>
<variablelist role="params"/><refsect2><title><anchor role="function" id="PackageKit:MimeTypes"/>The "MimeTypes" property</title><indexterm><primary>MimeTypes</primary><secondary>PackageKit</secondary></indexterm><programlisting>'MimeTypes' read 's'
</programlisting></refsect2>
<para>
The mime-types the backend supports, e.g. "application/x-rpm;application/x-deb".
</para>
<variablelist role="params"/><refsect2><title><anchor role="function" id="PackageKit:Locked"/>The "Locked" property</title><indexterm><primary>Locked</primary><secondary>PackageKit</secondary></indexterm><programlisting>'Locked' read 'b'
</programlisting></refsect2>
<para>
Set when the backend is locked and native tools would fail.
</para>
<variablelist role="params"/><refsect2><title><anchor role="function" id="PackageKit:NetworkState"/>The "NetworkState" property</title><indexterm><primary>NetworkState</primary><secondary>PackageKit</secondary></indexterm><programlisting>'NetworkState' read 's'
</programlisting></refsect2>
<para>
Gets the network state from the daemon. This is provided as some clients may not want
to use NetworkManager if the system daemon is configured to use something else.
</para>
<para>
If the system is managed using NetworkManager then the following
states are supported:
unknown, offline, online,
wifi, mobile or wired.
If the system is configured for legacy UNIX network fallback, or NetworkManager
is not running then the folowing states are supported:
unknown, offline or online.
</para>
<variablelist role="params"/><refsect2><title><anchor role="function" id="PackageKit:DistroId"/>The "DistroId" property</title><indexterm><primary>DistroId</primary><secondary>PackageKit</secondary></indexterm><programlisting>'DistroId' read 's'
</programlisting></refsect2>
<para>
The distribution identification, in the
distro;version;arch form e.g.
"debian;squeeze/sid;x86_64".
</para>
<variablelist role="params"/></refsect1>
</refentry>
|
