4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>org.freedesktop.UDisks</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
5
<title>udisks Reference Manual: org.freedesktop.UDisks</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="udisks Reference Manual">
8
8
<link rel="up" href="ref-dbus.html" title="D-Bus API Reference">
9
9
<link rel="prev" href="ref-dbus.html" title="D-Bus API Reference">
10
10
<link rel="next" href="Device.html" title="org.freedesktop.UDisks.Device">
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
<td><a accesskey="p" href="ref-dbus.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="ref-dbus.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
<th width="100%" align="center">udisks Reference Manual</th>
21
<td><a accesskey="n" href="Device.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#UDisks.synopsis" class="shortcut">Top</a>
26
<a href="#UDisks.description" class="shortcut">Description</a>
28
<a href="#UDisks.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
30
<a href="#UDisks.properties" class="shortcut">Properties</a>
32
<a href="#UDisks.signals" class="shortcut">Signals</a>
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
16
<td width="100%" align="left" class="shortcuts">
17
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
18
<a href="#UDisks.description" class="shortcut">Description</a></span><span id="nav_interfaces"> <span class="dim">|</span>
19
<a href="#UDisks.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
20
<a href="#UDisks.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
21
<a href="#UDisks.signals" class="shortcut">Signals</a></span>
23
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
24
<td><a accesskey="u" href="ref-dbus.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
25
<td><a accesskey="p" href="ref-dbus.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
26
<td><a accesskey="n" href="Device.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
35
28
<div class="refentry">
36
29
<a name="UDisks"></a><div class="titlepage"></div>
37
30
<div class="refnamediv"><table width="100%"><tr>
39
32
<h2><span class="refentrytitle">org.freedesktop.UDisks</span></h2>
40
33
<p>org.freedesktop.UDisks — UDisks interface</p>
42
<td valign="top" align="right"></td>
35
<td class="gallery_image" valign="top" align="right"></td>
43
36
</tr></table></div>
44
37
<div class="refsynopsisdiv">
46
<pre class="synopsis"><a class="link" href="UDisks.html#UDisks.EnumerateAdapters">EnumerateAdapters</a> (out 'ao' devices)
47
<a class="link" href="UDisks.html#UDisks.EnumerateExpanders">EnumerateExpanders</a> (out 'ao' devices)
48
<a class="link" href="UDisks.html#UDisks.EnumeratePorts">EnumeratePorts</a> (out 'ao' devices)
49
<a class="link" href="UDisks.html#UDisks.EnumerateDevices">EnumerateDevices</a> (out 'ao' devices)
50
<a class="link" href="UDisks.html#UDisks.EnumerateDeviceFiles">EnumerateDeviceFiles</a> (out 'as' device_files)
51
<a class="link" href="UDisks.html#UDisks.FindDeviceByDeviceFile">FindDeviceByDeviceFile</a> (in 's' device_file,
53
<a class="link" href="UDisks.html#UDisks.FindDeviceByMajorMinor">FindDeviceByMajorMinor</a> (in 'x' device_major,
56
<a class="link" href="UDisks.html#UDisks.DriveInhibitAllPolling">DriveInhibitAllPolling</a> (in 'as' options,
58
<a class="link" href="UDisks.html#UDisks.DriveUninhibitAllPolling">DriveUninhibitAllPolling</a> (in 's' cookie)
59
<a class="link" href="UDisks.html#UDisks.DriveSetAllSpindownTimeouts">DriveSetAllSpindownTimeouts</a> (in 'i' timeout_seconds,
62
<a class="link" href="UDisks.html#UDisks.DriveUnsetAllSpindownTimeouts">DriveUnsetAllSpindownTimeouts</a> (in 's' cookie)
63
<a class="link" href="UDisks.html#UDisks.LinuxLvm2VGStart">LinuxLvm2VGStart</a> (in 's' uuid,
65
<a class="link" href="UDisks.html#UDisks.LinuxLvm2VGStop">LinuxLvm2VGStop</a> (in 's' uuid,
67
<a class="link" href="UDisks.html#UDisks.LinuxLvm2VGSetName">LinuxLvm2VGSetName</a> (in 's' uuid,
69
<a class="link" href="UDisks.html#UDisks.LinuxLvm2VGAddPV">LinuxLvm2VGAddPV</a> (in 's' uuid,
70
in 'o' physical_volume,
72
<a class="link" href="UDisks.html#UDisks.LinuxLvm2VGRemovePV">LinuxLvm2VGRemovePV</a> (in 's' vg_uuid,
75
<a class="link" href="UDisks.html#UDisks.LinuxLvm2LVSetName">LinuxLvm2LVSetName</a> (in 's' group_uuid,
78
<a class="link" href="UDisks.html#UDisks.LinuxLvm2LVStart">LinuxLvm2LVStart</a> (in 's' group_uuid,
81
<a class="link" href="UDisks.html#UDisks.LinuxLvm2LVRemove">LinuxLvm2LVRemove</a> (in 's' group_uuid,
84
<a class="link" href="UDisks.html#UDisks.LinuxLvm2LVCreate">LinuxLvm2LVCreate</a> (in 's' group_uuid,
93
out 'o' created_device)
94
<a class="link" href="UDisks.html#UDisks.LinuxMdStart">LinuxMdStart</a> (in 'ao' components,
97
<a class="link" href="UDisks.html#UDisks.LinuxMdCreate">LinuxMdCreate</a> (in 'ao' components,
103
<a class="link" href="UDisks.html#UDisks.Inhibit">Inhibit</a> (out 's' cookie)
104
<a class="link" href="UDisks.html#UDisks.Uninhibit">Uninhibit</a> (in 's' cookie)
107
<div class="refsect1">
108
<a name="id372098"></a><h2>Signals</h2>
109
<pre class="synopsis"><a class="link" href="UDisks.html#UDisks::DeviceAdded">DeviceAdded</a> ('o' device)
110
<a class="link" href="UDisks.html#UDisks::DeviceRemoved">DeviceRemoved</a> ('o' device)
111
<a class="link" href="UDisks.html#UDisks::DeviceChanged">DeviceChanged</a> ('o' device)
112
<a class="link" href="UDisks.html#UDisks::DeviceJobChanged">DeviceJobChanged</a> ('o' device,
114
'b' job_is_cancellable,
119
'd' job_cur_task_percentage)
120
<a class="link" href="UDisks.html#UDisks::AdapterAdded">AdapterAdded</a> ('o' adapter)
121
<a class="link" href="UDisks.html#UDisks::AdapterRemoved">AdapterRemoved</a> ('o' adapter)
122
<a class="link" href="UDisks.html#UDisks::AdapterChanged">AdapterChanged</a> ('o' adapter)
123
<a class="link" href="UDisks.html#UDisks::ExpanderAdded">ExpanderAdded</a> ('o' expander)
124
<a class="link" href="UDisks.html#UDisks::ExpanderRemoved">ExpanderRemoved</a> ('o' expander)
125
<a class="link" href="UDisks.html#UDisks::ExpanderChanged">ExpanderChanged</a> ('o' expander)
126
<a class="link" href="UDisks.html#UDisks::PortAdded">PortAdded</a> ('o' port)
127
<a class="link" href="UDisks.html#UDisks::PortRemoved">PortRemoved</a> ('o' port)
128
<a class="link" href="UDisks.html#UDisks::PortChanged">PortChanged</a> ('o' port)
131
<div class="refsect1">
132
<a name="id372196"></a><h2>Implemented Interfaces</h2>
39
<pre class="synopsis"><a class="link" href="UDisks.html#UDisks.EnumerateAdapters">EnumerateAdapters</a>(out'ao'devices)
40
<a class="link" href="UDisks.html#UDisks.EnumerateExpanders">EnumerateExpanders</a>(out'ao'devices)
41
<a class="link" href="UDisks.html#UDisks.EnumeratePorts">EnumeratePorts</a>(out'ao'devices)
42
<a class="link" href="UDisks.html#UDisks.EnumerateDevices">EnumerateDevices</a>(out'ao'devices)
43
<a class="link" href="UDisks.html#UDisks.EnumerateDeviceFiles">EnumerateDeviceFiles</a>(out'as'device_files)
44
<a class="link" href="UDisks.html#UDisks.FindDeviceByDeviceFile">FindDeviceByDeviceFile</a>(in's'device_file,
46
<a class="link" href="UDisks.html#UDisks.FindDeviceByMajorMinor">FindDeviceByMajorMinor</a>(in'x'device_major,
49
<a class="link" href="UDisks.html#UDisks.DriveInhibitAllPolling">DriveInhibitAllPolling</a>(in'as'options,
51
<a class="link" href="UDisks.html#UDisks.DriveUninhibitAllPolling">DriveUninhibitAllPolling</a>(in's'cookie)
52
<a class="link" href="UDisks.html#UDisks.DriveSetAllSpindownTimeouts">DriveSetAllSpindownTimeouts</a>(in'i'timeout_seconds,
55
<a class="link" href="UDisks.html#UDisks.DriveUnsetAllSpindownTimeouts">DriveUnsetAllSpindownTimeouts</a>(in's'cookie)
56
<a class="link" href="UDisks.html#UDisks.LinuxLvm2VGStart">LinuxLvm2VGStart</a>(in's'uuid,
58
<a class="link" href="UDisks.html#UDisks.LinuxLvm2VGStop">LinuxLvm2VGStop</a>(in's'uuid,
60
<a class="link" href="UDisks.html#UDisks.LinuxLvm2VGSetName">LinuxLvm2VGSetName</a>(in's'uuid,
62
<a class="link" href="UDisks.html#UDisks.LinuxLvm2VGAddPV">LinuxLvm2VGAddPV</a>(in's'uuid,
65
<a class="link" href="UDisks.html#UDisks.LinuxLvm2VGRemovePV">LinuxLvm2VGRemovePV</a>(in's'vg_uuid,
68
<a class="link" href="UDisks.html#UDisks.LinuxLvm2LVSetName">LinuxLvm2LVSetName</a>(in's'group_uuid,
71
<a class="link" href="UDisks.html#UDisks.LinuxLvm2LVStart">LinuxLvm2LVStart</a>(in's'group_uuid,
74
<a class="link" href="UDisks.html#UDisks.LinuxLvm2LVRemove">LinuxLvm2LVRemove</a>(in's'group_uuid,
77
<a class="link" href="UDisks.html#UDisks.LinuxLvm2LVCreate">LinuxLvm2LVCreate</a>(in's'group_uuid,
87
<a class="link" href="UDisks.html#UDisks.LinuxMdStart">LinuxMdStart</a>(in'ao'components,
90
<a class="link" href="UDisks.html#UDisks.LinuxMdCreate">LinuxMdCreate</a>(in'ao'components,
96
<a class="link" href="UDisks.html#UDisks.Inhibit">Inhibit</a>(out's'cookie)
97
<a class="link" href="UDisks.html#UDisks.Uninhibit">Uninhibit</a>(in's'cookie)
100
<div class="refsect1">
101
<a name="id-1.2.3.4"></a><h2>Signals</h2>
102
<pre class="synopsis"><a class="link" href="UDisks.html#UDisks::DeviceAdded">DeviceAdded</a>('o'device)
103
<a class="link" href="UDisks.html#UDisks::DeviceRemoved">DeviceRemoved</a>('o'device)
104
<a class="link" href="UDisks.html#UDisks::DeviceChanged">DeviceChanged</a>('o'device)
105
<a class="link" href="UDisks.html#UDisks::DeviceJobChanged">DeviceJobChanged</a>('o'device,
107
'b'job_is_cancellable,
112
'd'job_cur_task_percentage)
113
<a class="link" href="UDisks.html#UDisks::AdapterAdded">AdapterAdded</a>('o'adapter)
114
<a class="link" href="UDisks.html#UDisks::AdapterRemoved">AdapterRemoved</a>('o'adapter)
115
<a class="link" href="UDisks.html#UDisks::AdapterChanged">AdapterChanged</a>('o'adapter)
116
<a class="link" href="UDisks.html#UDisks::ExpanderAdded">ExpanderAdded</a>('o'expander)
117
<a class="link" href="UDisks.html#UDisks::ExpanderRemoved">ExpanderRemoved</a>('o'expander)
118
<a class="link" href="UDisks.html#UDisks::ExpanderChanged">ExpanderChanged</a>('o'expander)
119
<a class="link" href="UDisks.html#UDisks::PortAdded">PortAdded</a>('o'port)
120
<a class="link" href="UDisks.html#UDisks::PortRemoved">PortRemoved</a>('o'port)
121
<a class="link" href="UDisks.html#UDisks::PortChanged">PortChanged</a>('o'port)
124
<div class="refsect1">
125
<a name="id-1.2.3.5"></a><h2>Implemented Interfaces</h2>
134
127
Objects implementing org.freedesktop.UDisks also implements
135
128
org.freedesktop.DBus.Introspectable,
139
132
<div class="refsect1">
140
<a name="id372212"></a><h2>Properties</h2>
141
<pre class="synopsis"><a class="link" href="UDisks.html#UDisks:DaemonVersion">'DaemonVersion'</a> read 's'
142
<a class="link" href="UDisks.html#UDisks:DaemonIsInhibited">'DaemonIsInhibited'</a> read 'b'
143
<a class="link" href="UDisks.html#UDisks:SupportsLuksDevices">'SupportsLuksDevices'</a> read 'b'
144
<a class="link" href="UDisks.html#UDisks:KnownFilesystems">'KnownFilesystems'</a> read 'a(ssbbbubbbbbbbb)'
133
<a name="id-1.2.3.6"></a><h2>Properties</h2>
134
<pre class="synopsis"><a class="link" href="UDisks.html#UDisks:DaemonVersion">'DaemonVersion'</a>read's'
135
<a class="link" href="UDisks.html#UDisks:DaemonIsInhibited">'DaemonIsInhibited'</a>read'b'
136
<a class="link" href="UDisks.html#UDisks:SupportsLuksDevices">'SupportsLuksDevices'</a>read'b'
137
<a class="link" href="UDisks.html#UDisks:KnownFilesystems">'KnownFilesystems'</a>read'a(ssbbbubbbbbbbb)'
147
140
<div class="refsect1">
148
<a name="id371492"></a><h2>Description</h2>
141
<a name="id-1.2.3.7"></a><h2>Description</h2>
151
144
<div class="refsect1">
152
<a name="id371507"></a><h2>Details</h2>
145
<a name="id-1.2.3.8"></a><h2>Details</h2>
153
146
<div class="refsect2">
154
<a name="id371515"></a><h3>
147
<a name="id-1.2.3.8.2"></a><h3>
155
148
<a name="UDisks.EnumerateAdapters"></a>EnumerateAdapters ()</h3>
156
<pre class="programlisting">EnumerateAdapters (out 'ao' devices)</pre>
149
<pre class="programlisting">EnumerateAdapters (out'ao'devices)</pre>
159
152
Enumerate all storage adapters on the system.
161
<div class="variablelist"><table border="0">
154
<div class="variablelist"><table border="0" class="variablelist">
162
156
<col align="left" valign="top">
164
160
<td><p><span class="term"><em class="parameter"><code>devices</code></em>:</span></p></td>
165
161
<td>An array of object paths for storage adapters.</td>
1550
1705
<div class="refsect1">
1551
<a name="id453679"></a><h2>Property Details</h2>
1706
<a name="id-1.2.3.10"></a><h2>Property Details</h2>
1552
1707
<div class="refsect2">
1553
<a name="id453689"></a><h3>
1708
<a name="id-1.2.3.10.2"></a><h3>
1554
1709
<a name="UDisks:DaemonVersion"></a>The "DaemonVersion" property</h3>
1555
<pre class="programlisting">'DaemonVersion' read 's'
1710
<pre class="programlisting">'DaemonVersion'read's'
1559
1714
The version of the running daemon.
1561
<div class="variablelist"><table border="0">
1716
<div class="variablelist"><table border="0" class="variablelist">
1562
1718
<col align="left" valign="top">
1563
1721
<tbody></tbody>
1566
1724
<div class="refsect2">
1567
<a name="id453724"></a><h3>
1725
<a name="id-1.2.3.10.5"></a><h3>
1568
1726
<a name="UDisks:DaemonIsInhibited"></a>The "DaemonIsInhibited" property</h3>
1569
<pre class="programlisting">'DaemonIsInhibited' read 'b'
1727
<pre class="programlisting">'DaemonIsInhibited'read'b'
1573
1731
TRUE only if the daemon is inhibited.
1575
<div class="variablelist"><table border="0">
1733
<div class="variablelist"><table border="0" class="variablelist">
1576
1735
<col align="left" valign="top">
1577
1738
<tbody></tbody>
1580
1741
<div class="refsect2">
1581
<a name="id453760"></a><h3>
1742
<a name="id-1.2.3.10.8"></a><h3>
1582
1743
<a name="UDisks:SupportsLuksDevices"></a>The "SupportsLuksDevices" property</h3>
1583
<pre class="programlisting">'SupportsLuksDevices' read 'b'
1744
<pre class="programlisting">'SupportsLuksDevices'read'b'