| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 5 |
<title>org.freedesktop.UDisks2.Drive: UDisks Reference Manual</title> |
| 6 |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> |
| 7 |
<link rel="home" href="index.html" title="UDisks Reference Manual"> |
| 8 |
<link rel="up" href="ch03.html" title="D-Bus Interfaces"> |
| 9 |
<link rel="prev" href="gdbus-org.freedesktop.UDisks2.Manager.html" title="org.freedesktop.UDisks2.Manager"> |
| 10 |
<link rel="next" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html" title="org.freedesktop.UDisks2.Drive.Ata"> |
| 11 |
<meta name="generator" content="GTK-Doc V1.35.1 (XML mode)"> |
| 12 |
<link rel="stylesheet" href="style.css" type="text/css"> |
| 13 |
</head> |
| 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="5"><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="#gdbus-org.freedesktop.UDisks2.Drive.description" class="shortcut">Description</a></span><span id="nav_properties"> <span class="dim">|</span> |
| 19 |
<a href="#gdbus-org.freedesktop.UDisks2.Drive.properties" class="shortcut">Properties</a></span> |
| 20 |
</td> |
| 21 |
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| 22 |
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| 23 |
<td><a accesskey="p" href="gdbus-org.freedesktop.UDisks2.Manager.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| 24 |
<td><a accesskey="n" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| 25 |
</tr></table> |
| 26 |
<div class="refentry"> |
| 27 |
<a name="gdbus-org.freedesktop.UDisks2.Drive"></a><div class="titlepage"></div> |
| 28 |
<div class="refnamediv"><table width="100%"><tr> |
| 29 |
<td valign="top"> |
| 30 |
<h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-UDisks2-Drive.top_of_page"></a>org.freedesktop.UDisks2.Drive</span></h2> |
| 31 |
<p>org.freedesktop.UDisks2.Drive — Disk drives</p> |
| 32 |
</td> |
| 33 |
<td class="gallery_image" valign="top" align="right"></td> |
| 34 |
</tr></table></div> |
| 35 |
<div class="refsynopsisdiv"> |
| 36 |
<h2>Methods</h2> |
| 37 |
<pre class="synopsis"> |
| 38 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-method-org-freedesktop-UDisks2-Drive.Eject" title="The Eject() method">Eject</a> (IN a{sv} options); |
| 39 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-method-org-freedesktop-UDisks2-Drive.SetConfiguration" title="The SetConfiguration() method">SetConfiguration</a> (IN a{sv} value, |
| 40 |
IN a{sv} options); |
| 41 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-method-org-freedesktop-UDisks2-Drive.PowerOff" title="The PowerOff() method">PowerOff</a> (IN a{sv} options); |
| 42 |
</pre> |
| 43 |
</div> |
| 44 |
<div class="refsect1"> |
| 45 |
<a name="id-1.3.3.3.4"></a><h2>Properties</h2> |
| 46 |
<pre class="synopsis"> |
| 47 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Vendor" title='The "Vendor" property'>Vendor</a> readable s |
| 48 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Model" title='The "Model" property'>Model</a> readable s |
| 49 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Revision" title='The "Revision" property'>Revision</a> readable s |
| 50 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Serial" title='The "Serial" property'>Serial</a> readable s |
| 51 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.WWN" title='The "WWN" property'>WWN</a> readable s |
| 52 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Id" title='The "Id" property'>Id</a> readable s |
| 53 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Configuration" title='The "Configuration" property'>Configuration</a> readable a{sv} |
| 54 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Media" title='The "Media" property'>Media</a> readable s |
| 55 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.MediaCompatibility" title='The "MediaCompatibility" property'>MediaCompatibility</a> readable as |
| 56 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.MediaRemovable" title='The "MediaRemovable" property'>MediaRemovable</a> readable b |
| 57 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.MediaAvailable" title='The "MediaAvailable" property'>MediaAvailable</a> readable b |
| 58 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.MediaChangeDetected" title='The "MediaChangeDetected" property'>MediaChangeDetected</a> readable b |
| 59 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Size" title='The "Size" property'>Size</a> readable t |
| 60 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.TimeDetected" title='The "TimeDetected" property'>TimeDetected</a> readable t |
| 61 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.TimeMediaDetected" title='The "TimeMediaDetected" property'>TimeMediaDetected</a> readable t |
| 62 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Optical" title='The "Optical" property'>Optical</a> readable b |
| 63 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.OpticalBlank" title='The "OpticalBlank" property'>OpticalBlank</a> readable b |
| 64 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.OpticalNumTracks" title='The "OpticalNumTracks" property'>OpticalNumTracks</a> readable u |
| 65 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.OpticalNumAudioTracks" title='The "OpticalNumAudioTracks" property'>OpticalNumAudioTracks</a> readable u |
| 66 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.OpticalNumDataTracks" title='The "OpticalNumDataTracks" property'>OpticalNumDataTracks</a> readable u |
| 67 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.OpticalNumSessions" title='The "OpticalNumSessions" property'>OpticalNumSessions</a> readable u |
| 68 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.RotationRate" title='The "RotationRate" property'>RotationRate</a> readable i |
| 69 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.ConnectionBus" title='The "ConnectionBus" property'>ConnectionBus</a> readable s |
| 70 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Seat" title='The "Seat" property'>Seat</a> readable s |
| 71 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Removable" title='The "Removable" property'>Removable</a> readable b |
| 72 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Ejectable" title='The "Ejectable" property'>Ejectable</a> readable b |
| 73 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.SortKey" title='The "SortKey" property'>SortKey</a> readable s |
| 74 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.CanPowerOff" title='The "CanPowerOff" property'>CanPowerOff</a> readable b |
| 75 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.SiblingId" title='The "SiblingId" property'>SiblingId</a> readable s |
| 76 |
</pre> |
| 77 |
</div> |
| 78 |
<div class="refsect1"> |
| 79 |
<a name="gdbus-interface-org-freedesktop-UDisks2-Drive"></a><h2>Description</h2> |
| 80 |
<p> |
| 81 |
This interface is used to represent both hard disks and disk |
| 82 |
drives (with or without removable media). |
| 83 |
</p> |
| 84 |
<p> |
| 85 |
This interface should not to be confused with the |
| 86 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a> interface that is used for |
| 87 |
low-level block devices the OS knows about. For example, if |
| 88 |
<code class="filename">/dev/sda</code> and <code class="filename">/dev/sdb</code> |
| 89 |
are block devices for two paths to the same drive, there will be |
| 90 |
only one <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-interface-org-freedesktop-UDisks2-Drive.top_of_page">org.freedesktop.UDisks2.Drive</a> object but two |
| 91 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a> objects. |
| 92 |
</p> |
| 93 |
</div> |
| 94 |
<div class="refsect1"> |
| 95 |
<a name="gdbus-methods-org.freedesktop.UDisks2.Drive"></a><h2>Method Details</h2> |
| 96 |
<div class="refsect2"> |
| 97 |
<a name="gdbus-method-org-freedesktop-UDisks2-Drive.Eject"></a><h3>The Eject() method</h3> |
| 98 |
<pre class="programlisting"> |
| 99 |
Eject (IN a{sv} options); |
| 100 |
</pre> |
| 101 |
<p> |
| 102 |
Ejects media from the drive. This is only meaningful to do on |
| 103 |
drives with removable media. |
| 104 |
</p> |
| 105 |
<p> |
| 106 |
There are not a lot of guarantees associated with this method |
| 107 |
so it should only be called in response to an user action. |
| 108 |
</p> |
| 109 |
<p> |
| 110 |
On some hardware the media may be physically ejected while on |
| 111 |
other hardware may simply eject the disc. On some hardware it |
| 112 |
may not do anything physical but it may cause e.g. a display |
| 113 |
on the hardware to show e.g. <span class="quote">“<span class="quote">It is now safe to remove |
| 114 |
the device</span>”</span>. |
| 115 |
</p> |
| 116 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 117 |
<colgroup> |
| 118 |
<col align="left" valign="top"> |
| 119 |
<col> |
| 120 |
</colgroup> |
| 121 |
<tbody><tr> |
| 122 |
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td> |
| 123 |
<td><p> |
| 124 |
Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>). |
| 125 |
</p></td> |
| 126 |
</tr></tbody> |
| 127 |
</table></div> |
| 128 |
</div> |
| 129 |
<hr> |
| 130 |
<div class="refsect2"> |
| 131 |
<a name="gdbus-method-org-freedesktop-UDisks2-Drive.SetConfiguration"></a><h3>The SetConfiguration() method</h3> |
| 132 |
<pre class="programlisting"> |
| 133 |
SetConfiguration (IN a{sv} value, |
| 134 |
IN a{sv} options); |
| 135 |
</pre> |
| 136 |
<p> |
| 137 |
Sets the configuration for the drive. This will store the |
| 138 |
configuration in the file-system and also apply it to the |
| 139 |
drive. |
| 140 |
</p> |
| 141 |
<p> |
| 142 |
See the <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Configuration" title='The "Configuration" property'>"Configuration"</a> property |
| 143 |
for details about valid values and the location of the |
| 144 |
configuration file that <em class="parameter"><code>value</code></em> will be written to. |
| 145 |
</p> |
| 146 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 147 |
<colgroup> |
| 148 |
<col align="left" valign="top"> |
| 149 |
<col> |
| 150 |
</colgroup> |
| 151 |
<tbody> |
| 152 |
<tr> |
| 153 |
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>value</code></em></code>:</span></p></td> |
| 154 |
<td><p> |
| 155 |
The configuration value to set. |
| 156 |
</p></td> |
| 157 |
</tr> |
| 158 |
<tr> |
| 159 |
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td> |
| 160 |
<td><p> |
| 161 |
Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>). |
| 162 |
</p></td> |
| 163 |
</tr> |
| 164 |
</tbody> |
| 165 |
</table></div> |
| 166 |
</div> |
| 167 |
<hr> |
| 168 |
<div class="refsect2"> |
| 169 |
<a name="gdbus-method-org-freedesktop-UDisks2-Drive.PowerOff"></a><h3>The PowerOff() method</h3> |
| 170 |
<pre class="programlisting"> |
| 171 |
PowerOff (IN a{sv} options); |
| 172 |
</pre> |
| 173 |
<p> |
| 174 |
Arranges for the drive to be safely removed and powered |
| 175 |
off. On the OS side this includes ensuring that no process is |
| 176 |
using the drive, then requesting that in-flight buffers and |
| 177 |
caches are committed to stable storage. The exact steps for |
| 178 |
powering off the drive depends on the drive itself and the |
| 179 |
interconnect used. For drives connected through USB, the |
| 180 |
effect is that the USB device will be deconfigured followed by |
| 181 |
disabling the upstream hub port it is connected to. |
| 182 |
</p> |
| 183 |
<p> |
| 184 |
Note that as some physical devices contain multiple drives |
| 185 |
(for example 4-in-1 flash card reader USB devices) powering |
| 186 |
off one drive may affect other drives. Applications can |
| 187 |
examine the <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.SiblingId" title='The "SiblingId" property'>"SiblingId"</a> property |
| 188 |
to determine such relationships. |
| 189 |
</p> |
| 190 |
<p> |
| 191 |
There are not a lot of guarantees associated with this method |
| 192 |
so it should only be called in response to an user |
| 193 |
action. Usually the effect is that the drive disappears as if |
| 194 |
it was unplugged. |
| 195 |
</p> |
| 196 |
<p> |
| 197 |
This method only works if the |
| 198 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.CanPowerOff" title='The "CanPowerOff" property'>"CanPowerOff"</a> property |
| 199 |
is set to <code class="constant">TRUE</code>. |
| 200 |
</p> |
| 201 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 202 |
<colgroup> |
| 203 |
<col align="left" valign="top"> |
| 204 |
<col> |
| 205 |
</colgroup> |
| 206 |
<tbody><tr> |
| 207 |
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td> |
| 208 |
<td><p> |
| 209 |
Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>). |
| 210 |
</p></td> |
| 211 |
</tr></tbody> |
| 212 |
</table></div> |
| 213 |
<p class="since">Since 2.0.0</p> |
| 214 |
</div> |
| 215 |
</div> |
| 216 |
<div class="refsect1"> |
| 217 |
<a name="gdbus-properties-org.freedesktop.UDisks2.Drive"></a><h2>Property Details</h2> |
| 218 |
<div class="refsect2"> |
| 219 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Vendor"></a><h3>The "Vendor" property</h3> |
| 220 |
<pre class="programlisting"> |
| 221 |
Vendor readable s |
| 222 |
</pre> |
| 223 |
<p> |
| 224 |
A name for the vendor of the drive or blank if unknown. |
| 225 |
</p> |
| 226 |
</div> |
| 227 |
<hr> |
| 228 |
<div class="refsect2"> |
| 229 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Model"></a><h3>The "Model" property</h3> |
| 230 |
<pre class="programlisting"> |
| 231 |
Model readable s |
| 232 |
</pre> |
| 233 |
<p> |
| 234 |
A name for the model of the drive or blank if unknown. |
| 235 |
</p> |
| 236 |
</div> |
| 237 |
<hr> |
| 238 |
<div class="refsect2"> |
| 239 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Revision"></a><h3>The "Revision" property</h3> |
| 240 |
<pre class="programlisting"> |
| 241 |
Revision readable s |
| 242 |
</pre> |
| 243 |
<p> |
| 244 |
Firmware Revision or blank if unknown. |
| 245 |
</p> |
| 246 |
</div> |
| 247 |
<hr> |
| 248 |
<div class="refsect2"> |
| 249 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Serial"></a><h3>The "Serial" property</h3> |
| 250 |
<pre class="programlisting"> |
| 251 |
Serial readable s |
| 252 |
</pre> |
| 253 |
<p> |
| 254 |
Serial number of the drive or blank if unknown. |
| 255 |
</p> |
| 256 |
</div> |
| 257 |
<hr> |
| 258 |
<div class="refsect2"> |
| 259 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.WWN"></a><h3>The "WWN" property</h3> |
| 260 |
<pre class="programlisting"> |
| 261 |
WWN readable s |
| 262 |
</pre> |
| 263 |
<p> |
| 264 |
The <a class="ulink" href="http://en.wikipedia.org/wiki/World_Wide_Name" target="_top">World Wide |
| 265 |
Name</a> of the drive or blank if unknown. |
| 266 |
</p> |
| 267 |
<p> |
| 268 |
In case of NVMe drives please refer to namespace-level WWN properties. |
| 269 |
</p> |
| 270 |
</div> |
| 271 |
<hr> |
| 272 |
<div class="refsect2"> |
| 273 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Id"></a><h3>The "Id" property</h3> |
| 274 |
<pre class="programlisting"> |
| 275 |
Id readable s |
| 276 |
</pre> |
| 277 |
<p> |
| 278 |
</p> |
| 279 |
<p> |
| 280 |
A unique and persistent identifier for the device or blank if |
| 281 |
no such identifier is available. |
| 282 |
</p> |
| 283 |
<p> |
| 284 |
This identifier is guaranteed to not include the slash |
| 285 |
character '/' (U+002F SOLIDUS) which means it can be used as |
| 286 |
a filename. |
| 287 |
</p> |
| 288 |
<p> |
| 289 |
Examples: |
| 290 |
<span class="quote">“<span class="quote">ST32000542AS-6XW00W51</span>”</span>, |
| 291 |
<span class="quote">“<span class="quote">HITACHI-HTS723232A7A364-E3834563KRG2HN</span>”</span>, |
| 292 |
<span class="quote">“<span class="quote">INTEL-SSDSA2MH080G1GC-CVEM842101HD080DGN</span>”</span>. |
| 293 |
</p> |
| 294 |
</div> |
| 295 |
<hr> |
| 296 |
<div class="refsect2"> |
| 297 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Configuration"></a><h3>The "Configuration" property</h3> |
| 298 |
<pre class="programlisting"> |
| 299 |
Configuration readable a{sv} |
| 300 |
</pre> |
| 301 |
<p> |
| 302 |
</p> |
| 303 |
<p> |
| 304 |
A set of configuration directives that are applied to the |
| 305 |
drive when it is connected (e.g. at start-up, hotplug or |
| 306 |
resume). |
| 307 |
</p> |
| 308 |
<p> |
| 309 |
This is an dict of items with the following known keys: |
| 310 |
</p> |
| 311 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 312 |
<colgroup> |
| 313 |
<col align="left" valign="top"> |
| 314 |
<col> |
| 315 |
</colgroup> |
| 316 |
<tbody> |
| 317 |
<tr> |
| 318 |
<td><p><span class="term">ata-pm-standby (type <code class="literal">'i'</code>)</span></p></td> |
| 319 |
<td><p> |
| 320 |
The spindown timeout for ATA drives (See ATA command <span class="quote">“<span class="quote">STANDBY</span>”</span>). |
| 321 |
</p></td> |
| 322 |
</tr> |
| 323 |
<tr> |
| 324 |
<td><p><span class="term">ata-apm-level (type <code class="literal">'i'</code>)</span></p></td> |
| 325 |
<td><p> |
| 326 |
The APM level for ATA drives (See ATA command <span class="quote">“<span class="quote">SET FEATURES</span>”</span>, sub-commands 0x05 and 0x85). |
| 327 |
</p></td> |
| 328 |
</tr> |
| 329 |
<tr> |
| 330 |
<td><p><span class="term">ata-aam-level (type <code class="literal">'i'</code>)</span></p></td> |
| 331 |
<td><p> |
| 332 |
The AAM level for ATA drives (See ATA command <span class="quote">“<span class="quote">SET FEATURES</span>”</span>, sub-commands 0x42 and 0xc2). |
| 333 |
</p></td> |
| 334 |
</tr> |
| 335 |
<tr> |
| 336 |
<td><p><span class="term">ata-write-cache-enabled (type <code class="literal">'b'</code>)</span></p></td> |
| 337 |
<td><p> |
| 338 |
Whether the write-cache is enabled (See ATA command <span class="quote">“<span class="quote">SET FEATURES</span>”</span>, sub-commands 0x82 and 0x02). Since 2.1. |
| 339 |
</p></td> |
| 340 |
</tr> |
| 341 |
<tr> |
| 342 |
<td><p><span class="term">ata-read-lookahead-enabled (type <code class="literal">'b'</code>)</span></p></td> |
| 343 |
<td><p> |
| 344 |
Whether the read look-ahead is enabled (See ATA command <span class="quote">“<span class="quote">SET FEATURES</span>”</span>, sub-commands 0x55 and 0xaa). Since 2.1.7. |
| 345 |
</p></td> |
| 346 |
</tr> |
| 347 |
</tbody> |
| 348 |
</table></div> |
| 349 |
<p> |
| 350 |
The contents of this property is read from the configuration |
| 351 |
file <code class="filename">/etc/udisks2/IDENTIFIER.conf</code> |
| 352 |
where <span class="emphasis"><em>IDENTIFIER</em></span> is the value of the |
| 353 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Id" title='The "Id" property'>"Id"</a> property. See <a class="xref" href="udisks.8.html" title="udisks"><span class="refentrytitle">udisks</span>(8)</a> for the file format of this file. |
| 354 |
</p> |
| 355 |
<p> |
| 356 |
Use the <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-method-org-freedesktop-UDisks2-Drive.SetConfiguration" title="The SetConfiguration() method">SetConfiguration()</a> |
| 357 |
method to change the value of this property. |
| 358 |
</p> |
| 359 |
</div> |
| 360 |
<hr> |
| 361 |
<div class="refsect2"> |
| 362 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Media"></a><h3>The "Media" property</h3> |
| 363 |
<pre class="programlisting"> |
| 364 |
Media readable s |
| 365 |
</pre> |
| 366 |
<p> |
| 367 |
The kind of media currently in the drive or blank if unknown. |
| 368 |
</p> |
| 369 |
<p> |
| 370 |
See the <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.MediaCompatibility" title='The "MediaCompatibility" property'>"MediaCompatibility"</a> property for known values. |
| 371 |
</p> |
| 372 |
</div> |
| 373 |
<hr> |
| 374 |
<div class="refsect2"> |
| 375 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.MediaCompatibility"></a><h3>The "MediaCompatibility" property</h3> |
| 376 |
<pre class="programlisting"> |
| 377 |
MediaCompatibility readable as |
| 378 |
</pre> |
| 379 |
<p> |
| 380 |
</p> |
| 381 |
<p> |
| 382 |
The physical kind of media the drive uses or the type of the drive or blank if unknown. |
| 383 |
Known values include |
| 384 |
</p> |
| 385 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 386 |
<colgroup> |
| 387 |
<col align="left" valign="top"> |
| 388 |
<col> |
| 389 |
</colgroup> |
| 390 |
<tbody> |
| 391 |
<tr> |
| 392 |
<td><p><span class="term">thumb</span></p></td> |
| 393 |
<td><p>The device is a thumb-drive with non-removable media (e.g. a USB stick)</p></td> |
| 394 |
</tr> |
| 395 |
<tr> |
| 396 |
<td><p><span class="term">flash</span></p></td> |
| 397 |
<td><p>Flash Card</p></td> |
| 398 |
</tr> |
| 399 |
<tr> |
| 400 |
<td><p><span class="term">flash_cf</span></p></td> |
| 401 |
<td><p>CompactFlash</p></td> |
| 402 |
</tr> |
| 403 |
<tr> |
| 404 |
<td><p><span class="term">flash_ms</span></p></td> |
| 405 |
<td><p>MemoryStick</p></td> |
| 406 |
</tr> |
| 407 |
<tr> |
| 408 |
<td><p><span class="term">flash_sm</span></p></td> |
| 409 |
<td><p>SmartMedia</p></td> |
| 410 |
</tr> |
| 411 |
<tr> |
| 412 |
<td><p><span class="term">flash_sd</span></p></td> |
| 413 |
<td><p>Secure Digital</p></td> |
| 414 |
</tr> |
| 415 |
<tr> |
| 416 |
<td><p><span class="term">flash_sdhc</span></p></td> |
| 417 |
<td><p>Secure Digital High Capacity</p></td> |
| 418 |
</tr> |
| 419 |
<tr> |
| 420 |
<td><p><span class="term">flash_sdxc</span></p></td> |
| 421 |
<td><p>Secure Digital eXtended Capacity</p></td> |
| 422 |
</tr> |
| 423 |
<tr> |
| 424 |
<td><p><span class="term">flash_sdio</span></p></td> |
| 425 |
<td><p>Secure Digital Input Output</p></td> |
| 426 |
</tr> |
| 427 |
<tr> |
| 428 |
<td><p><span class="term">flash_sd_combo</span></p></td> |
| 429 |
<td><p>Secure Digital Input Output combo card with storage and I/O functionality</p></td> |
| 430 |
</tr> |
| 431 |
<tr> |
| 432 |
<td><p><span class="term">flash_mmc</span></p></td> |
| 433 |
<td><p>MultiMediaCard</p></td> |
| 434 |
</tr> |
| 435 |
<tr> |
| 436 |
<td><p><span class="term">floppy</span></p></td> |
| 437 |
<td><p>Floppy Disk</p></td> |
| 438 |
</tr> |
| 439 |
<tr> |
| 440 |
<td><p><span class="term">floppy_zip</span></p></td> |
| 441 |
<td><p>Zip Disk</p></td> |
| 442 |
</tr> |
| 443 |
<tr> |
| 444 |
<td><p><span class="term">floppy_jaz</span></p></td> |
| 445 |
<td><p>Jaz Disk</p></td> |
| 446 |
</tr> |
| 447 |
<tr> |
| 448 |
<td><p><span class="term">optical</span></p></td> |
| 449 |
<td><p>Optical Disc</p></td> |
| 450 |
</tr> |
| 451 |
<tr> |
| 452 |
<td><p><span class="term">optical_cd</span></p></td> |
| 453 |
<td><p>Compact Disc</p></td> |
| 454 |
</tr> |
| 455 |
<tr> |
| 456 |
<td><p><span class="term">optical_cd_r</span></p></td> |
| 457 |
<td><p>Compact Disc Recordable</p></td> |
| 458 |
</tr> |
| 459 |
<tr> |
| 460 |
<td><p><span class="term">optical_cd_rw</span></p></td> |
| 461 |
<td><p>Compact Disc Rewritable</p></td> |
| 462 |
</tr> |
| 463 |
<tr> |
| 464 |
<td><p><span class="term">optical_dvd</span></p></td> |
| 465 |
<td><p>Digital Versatile Disc</p></td> |
| 466 |
</tr> |
| 467 |
<tr> |
| 468 |
<td><p><span class="term">optical_dvd_r</span></p></td> |
| 469 |
<td><p>DVD-R</p></td> |
| 470 |
</tr> |
| 471 |
<tr> |
| 472 |
<td><p><span class="term">optical_dvd_rw</span></p></td> |
| 473 |
<td><p>DVD-RW</p></td> |
| 474 |
</tr> |
| 475 |
<tr> |
| 476 |
<td><p><span class="term">optical_dvd_ram</span></p></td> |
| 477 |
<td><p>DVD-RAM</p></td> |
| 478 |
</tr> |
| 479 |
<tr> |
| 480 |
<td><p><span class="term">optical_dvd_plus_r</span></p></td> |
| 481 |
<td><p>DVD+R</p></td> |
| 482 |
</tr> |
| 483 |
<tr> |
| 484 |
<td><p><span class="term">optical_dvd_plus_rw</span></p></td> |
| 485 |
<td><p>DVD+RW</p></td> |
| 486 |
</tr> |
| 487 |
<tr> |
| 488 |
<td><p><span class="term">optical_dvd_plus_r_dl</span></p></td> |
| 489 |
<td><p>DVD+R Dual Layer</p></td> |
| 490 |
</tr> |
| 491 |
<tr> |
| 492 |
<td><p><span class="term">optical_dvd_plus_rw_dl</span></p></td> |
| 493 |
<td><p>DVD+RW Dual Layer</p></td> |
| 494 |
</tr> |
| 495 |
<tr> |
| 496 |
<td><p><span class="term">optical_bd</span></p></td> |
| 497 |
<td><p>Blu-ray Disc</p></td> |
| 498 |
</tr> |
| 499 |
<tr> |
| 500 |
<td><p><span class="term">optical_bd_r</span></p></td> |
| 501 |
<td><p>Blu-ray Recordable</p></td> |
| 502 |
</tr> |
| 503 |
<tr> |
| 504 |
<td><p><span class="term">optical_bd_re</span></p></td> |
| 505 |
<td><p>Blu-ray Rewritable</p></td> |
| 506 |
</tr> |
| 507 |
<tr> |
| 508 |
<td><p><span class="term">optical_hddvd</span></p></td> |
| 509 |
<td><p>HD-DVD</p></td> |
| 510 |
</tr> |
| 511 |
<tr> |
| 512 |
<td><p><span class="term">optical_hddvd_r</span></p></td> |
| 513 |
<td><p>HD-DVD Recordable</p></td> |
| 514 |
</tr> |
| 515 |
<tr> |
| 516 |
<td><p><span class="term">optical_hddvd_rw</span></p></td> |
| 517 |
<td><p>HD-DVD Rewritable</p></td> |
| 518 |
</tr> |
| 519 |
<tr> |
| 520 |
<td><p><span class="term">optical_mo</span></p></td> |
| 521 |
<td><p>Magneto Optical</p></td> |
| 522 |
</tr> |
| 523 |
<tr> |
| 524 |
<td><p><span class="term">optical_mrw</span></p></td> |
| 525 |
<td><p>Can read Mount Rainer media</p></td> |
| 526 |
</tr> |
| 527 |
<tr> |
| 528 |
<td><p><span class="term">optical_mrw_w</span></p></td> |
| 529 |
<td><p>Can write Mount Rainer media</p></td> |
| 530 |
</tr> |
| 531 |
</tbody> |
| 532 |
</table></div> |
| 533 |
<p> |
| 534 |
</p> |
| 535 |
</div> |
| 536 |
<hr> |
| 537 |
<div class="refsect2"> |
| 538 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.MediaRemovable"></a><h3>The "MediaRemovable" property</h3> |
| 539 |
<pre class="programlisting"> |
| 540 |
MediaRemovable readable b |
| 541 |
</pre> |
| 542 |
<p> |
| 543 |
</p> |
| 544 |
<p> |
| 545 |
Whether the media can be removed from the drive. |
| 546 |
</p> |
| 547 |
<p> |
| 548 |
Note that this may be overridden from what the hardware |
| 549 |
reports - for example, USB thumb drives often report that |
| 550 |
they are using removable media while in fact the media |
| 551 |
is not removable. |
| 552 |
</p> |
| 553 |
</div> |
| 554 |
<hr> |
| 555 |
<div class="refsect2"> |
| 556 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.MediaAvailable"></a><h3>The "MediaAvailable" property</h3> |
| 557 |
<pre class="programlisting"> |
| 558 |
MediaAvailable readable b |
| 559 |
</pre> |
| 560 |
<p> |
| 561 |
Set to <code class="constant">FALSE</code> if no medium is available. |
| 562 |
</p> |
| 563 |
<p> |
| 564 |
This is always <code class="constant">TRUE</code> if <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.MediaChangeDetected" title='The "MediaChangeDetected" property'>"MediaChangeDetected"</a> is <code class="constant">FALSE</code>. |
| 565 |
</p> |
| 566 |
</div> |
| 567 |
<hr> |
| 568 |
<div class="refsect2"> |
| 569 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.MediaChangeDetected"></a><h3>The "MediaChangeDetected" property</h3> |
| 570 |
<pre class="programlisting"> |
| 571 |
MediaChangeDetected readable b |
| 572 |
</pre> |
| 573 |
<p> |
| 574 |
Set to <code class="constant">TRUE</code> only if media changes are detected. |
| 575 |
</p> |
| 576 |
<p> |
| 577 |
Media changes are detected on all modern disk drives through |
| 578 |
either polling or an asynchronous notification mechanism. The |
| 579 |
only known disk drives that cannot report media changes are |
| 580 |
PC floppy drives. |
| 581 |
</p> |
| 582 |
</div> |
| 583 |
<hr> |
| 584 |
<div class="refsect2"> |
| 585 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Size"></a><h3>The "Size" property</h3> |
| 586 |
<pre class="programlisting"> |
| 587 |
Size readable t |
| 588 |
</pre> |
| 589 |
<p> |
| 590 |
The size of the drive (or the media currently in the drive). |
| 591 |
</p> |
| 592 |
<p> |
| 593 |
In case of NVMe this value indicates the total NVM capacity that is accessible by the NVMe controller. |
| 594 |
This is always 0 if <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.MediaChangeDetected" title='The "MediaChangeDetected" property'>"MediaChangeDetected"</a> is <code class="constant">FALSE</code>. |
| 595 |
</p> |
| 596 |
</div> |
| 597 |
<hr> |
| 598 |
<div class="refsect2"> |
| 599 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.TimeDetected"></a><h3>The "TimeDetected" property</h3> |
| 600 |
<pre class="programlisting"> |
| 601 |
TimeDetected readable t |
| 602 |
</pre> |
| 603 |
<p> |
| 604 |
The time the drive was first detected. |
| 605 |
</p> |
| 606 |
<p> |
| 607 |
This is expressed in micro-seconds since the Epoch Jan 1, 1970 0:00 UTC. |
| 608 |
</p> |
| 609 |
</div> |
| 610 |
<hr> |
| 611 |
<div class="refsect2"> |
| 612 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.TimeMediaDetected"></a><h3>The "TimeMediaDetected" property</h3> |
| 613 |
<pre class="programlisting"> |
| 614 |
TimeMediaDetected readable t |
| 615 |
</pre> |
| 616 |
<p> |
| 617 |
The earliest time media was last detected or 0 if media is not available. |
| 618 |
</p> |
| 619 |
<p> |
| 620 |
This is expressed in micro-seconds since the Epoch Jan 1, 1970 0:00 UTC. |
| 621 |
</p> |
| 622 |
</div> |
| 623 |
<hr> |
| 624 |
<div class="refsect2"> |
| 625 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Optical"></a><h3>The "Optical" property</h3> |
| 626 |
<pre class="programlisting"> |
| 627 |
Optical readable b |
| 628 |
</pre> |
| 629 |
<p> |
| 630 |
<code class="constant">TRUE</code> if the drive contains an optical disc. |
| 631 |
</p> |
| 632 |
</div> |
| 633 |
<hr> |
| 634 |
<div class="refsect2"> |
| 635 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.OpticalBlank"></a><h3>The "OpticalBlank" property</h3> |
| 636 |
<pre class="programlisting"> |
| 637 |
OpticalBlank readable b |
| 638 |
</pre> |
| 639 |
<p> |
| 640 |
<code class="constant">TRUE</code> if the disc is blank. |
| 641 |
</p> |
| 642 |
<p> |
| 643 |
This is only valid if the property <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Optical" title='The "Optical" property'>"Optical"</a> is <code class="constant">TRUE</code>. |
| 644 |
</p> |
| 645 |
</div> |
| 646 |
<hr> |
| 647 |
<div class="refsect2"> |
| 648 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.OpticalNumTracks"></a><h3>The "OpticalNumTracks" property</h3> |
| 649 |
<pre class="programlisting"> |
| 650 |
OpticalNumTracks readable u |
| 651 |
</pre> |
| 652 |
<p> |
| 653 |
The number of tracks. |
| 654 |
</p> |
| 655 |
<p> |
| 656 |
This is only valid if the property <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Optical" title='The "Optical" property'>"Optical"</a> is <code class="constant">TRUE</code>. |
| 657 |
</p> |
| 658 |
</div> |
| 659 |
<hr> |
| 660 |
<div class="refsect2"> |
| 661 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.OpticalNumAudioTracks"></a><h3>The "OpticalNumAudioTracks" property</h3> |
| 662 |
<pre class="programlisting"> |
| 663 |
OpticalNumAudioTracks readable u |
| 664 |
</pre> |
| 665 |
<p> |
| 666 |
The number of audio tracks. |
| 667 |
</p> |
| 668 |
<p> |
| 669 |
This is only valid if the property <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Optical" title='The "Optical" property'>"Optical"</a> is <code class="constant">TRUE</code>. |
| 670 |
</p> |
| 671 |
</div> |
| 672 |
<hr> |
| 673 |
<div class="refsect2"> |
| 674 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.OpticalNumDataTracks"></a><h3>The "OpticalNumDataTracks" property</h3> |
| 675 |
<pre class="programlisting"> |
| 676 |
OpticalNumDataTracks readable u |
| 677 |
</pre> |
| 678 |
<p> |
| 679 |
The number of data tracks. |
| 680 |
</p> |
| 681 |
<p> |
| 682 |
This is only valid if the property <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Optical" title='The "Optical" property'>"Optical"</a> is <code class="constant">TRUE</code>. |
| 683 |
</p> |
| 684 |
</div> |
| 685 |
<hr> |
| 686 |
<div class="refsect2"> |
| 687 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.OpticalNumSessions"></a><h3>The "OpticalNumSessions" property</h3> |
| 688 |
<pre class="programlisting"> |
| 689 |
OpticalNumSessions readable u |
| 690 |
</pre> |
| 691 |
<p> |
| 692 |
The number of sessions. |
| 693 |
</p> |
| 694 |
<p> |
| 695 |
This is only valid if the property <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.Optical" title='The "Optical" property'>"Optical"</a> is <code class="constant">TRUE</code>. |
| 696 |
</p> |
| 697 |
</div> |
| 698 |
<hr> |
| 699 |
<div class="refsect2"> |
| 700 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.RotationRate"></a><h3>The "RotationRate" property</h3> |
| 701 |
<pre class="programlisting"> |
| 702 |
RotationRate readable i |
| 703 |
</pre> |
| 704 |
<p> |
| 705 |
The rotational rate of the drive. |
| 706 |
</p> |
| 707 |
<p> |
| 708 |
</p> |
| 709 |
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> |
| 710 |
<li class="listitem"><p>-1 if known to be rotating media but rotation rate isn't known</p></li> |
| 711 |
<li class="listitem"><p>0 if known to be non-rotating media</p></li> |
| 712 |
<li class="listitem"><p>the rotation rate in rounds per minute otherwise</p></li> |
| 713 |
</ul></div> |
| 714 |
<p> |
| 715 |
</p> |
| 716 |
</div> |
| 717 |
<hr> |
| 718 |
<div class="refsect2"> |
| 719 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.ConnectionBus"></a><h3>The "ConnectionBus" property</h3> |
| 720 |
<pre class="programlisting"> |
| 721 |
ConnectionBus readable s |
| 722 |
</pre> |
| 723 |
<p> |
| 724 |
</p> |
| 725 |
<p> |
| 726 |
The physical connection bus used for the drive as seen by the |
| 727 |
user. This is typically used to draw a USB or Firewire emblem |
| 728 |
on top of an icon in an user interface. |
| 729 |
</p> |
| 730 |
<p> |
| 731 |
Note that this property has <span class="emphasis"><em>nothing</em></span> to do |
| 732 |
with the low-level command-set used (such as ATA-8) or what |
| 733 |
low-level connection bus (such as SATA, eSATA, PATA, SAS2 etc) |
| 734 |
is used. |
| 735 |
</p> |
| 736 |
<p> |
| 737 |
Known values include: |
| 738 |
</p> |
| 739 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 740 |
<colgroup> |
| 741 |
<col align="left" valign="top"> |
| 742 |
<col> |
| 743 |
</colgroup> |
| 744 |
<tbody> |
| 745 |
<tr> |
| 746 |
<td><p><span class="term">usb</span></p></td> |
| 747 |
<td><p>Connected via <a class="ulink" href="http://en.wikipedia.org/wiki/USB" target="_top">USB</a></p></td> |
| 748 |
</tr> |
| 749 |
<tr> |
| 750 |
<td><p><span class="term">sdio</span></p></td> |
| 751 |
<td><p>Connected via SDHC or <a class="ulink" href="http://en.wikipedia.org/wiki/Secure_Digital" target="_top">SDIO</a> controller (including eMMC).</p></td> |
| 752 |
</tr> |
| 753 |
<tr> |
| 754 |
<td><p><span class="term">ieee1394</span></p></td> |
| 755 |
<td><p>Connected via <a class="ulink" href="http://en.wikipedia.org/wiki/Firewire" target="_top">Firewire</a></p></td> |
| 756 |
</tr> |
| 757 |
</tbody> |
| 758 |
</table></div> |
| 759 |
<p> |
| 760 |
</p> |
| 761 |
</div> |
| 762 |
<hr> |
| 763 |
<div class="refsect2"> |
| 764 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Seat"></a><h3>The "Seat" property</h3> |
| 765 |
<pre class="programlisting"> |
| 766 |
Seat readable s |
| 767 |
</pre> |
| 768 |
<p> |
| 769 |
</p> |
| 770 |
<p> |
| 771 |
A string identifying what seat the drive is plugged into, if any. |
| 772 |
</p> |
| 773 |
</div> |
| 774 |
<hr> |
| 775 |
<div class="refsect2"> |
| 776 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Removable"></a><h3>The "Removable" property</h3> |
| 777 |
<pre class="programlisting"> |
| 778 |
Removable readable b |
| 779 |
</pre> |
| 780 |
<p> |
| 781 |
</p> |
| 782 |
<p> |
| 783 |
A hint whether the drive and/or its media is considered |
| 784 |
<span class="emphasis"><em>removable</em></span> by the user. |
| 785 |
</p> |
| 786 |
<p> |
| 787 |
This includes drives with removable media (cf. the |
| 788 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.MediaRemovable" title='The "MediaRemovable" property'>"MediaRemovable"</a> property), Flash |
| 789 |
media such as SD cards and drives on hotpluggable buses such |
| 790 |
as USB or Firewire (cf. the |
| 791 |
<a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-property-org-freedesktop-UDisks2-Drive.ConnectionBus" title='The "ConnectionBus" property'>"ConnectionBus"</a> property). |
| 792 |
</p> |
| 793 |
<p> |
| 794 |
Note that this is only a <span class="emphasis"><em>guess</em></span>. |
| 795 |
</p> |
| 796 |
</div> |
| 797 |
<hr> |
| 798 |
<div class="refsect2"> |
| 799 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.Ejectable"></a><h3>The "Ejectable" property</h3> |
| 800 |
<pre class="programlisting"> |
| 801 |
Ejectable readable b |
| 802 |
</pre> |
| 803 |
<p> |
| 804 |
</p> |
| 805 |
<p> |
| 806 |
Whether the media can be ejected from the drive or the drive |
| 807 |
accepts an eject command to switch its state so it displays |
| 808 |
e.g. a "Safe To Remove" message to the user. |
| 809 |
</p> |
| 810 |
<p> |
| 811 |
Note that this is only a <span class="emphasis"><em>guess</em></span>. |
| 812 |
</p> |
| 813 |
</div> |
| 814 |
<hr> |
| 815 |
<div class="refsect2"> |
| 816 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.SortKey"></a><h3>The "SortKey" property</h3> |
| 817 |
<pre class="programlisting"> |
| 818 |
SortKey readable s |
| 819 |
</pre> |
| 820 |
<p> |
| 821 |
</p> |
| 822 |
<p> |
| 823 |
A string that can be used for sorting drive objects. |
| 824 |
</p> |
| 825 |
</div> |
| 826 |
<hr> |
| 827 |
<div class="refsect2"> |
| 828 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.CanPowerOff"></a><h3>The "CanPowerOff" property</h3> |
| 829 |
<pre class="programlisting"> |
| 830 |
CanPowerOff readable b |
| 831 |
</pre> |
| 832 |
<p> |
| 833 |
</p> |
| 834 |
<p> |
| 835 |
<em class="parameter"><code>since</code></em>: 2.0.0 |
| 836 |
Whether the drive can be safely removed / powered off. See |
| 837 |
the <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-method-org-freedesktop-UDisks2-Drive.PowerOff" title="The PowerOff() method">PowerOff()</a> method for more |
| 838 |
information. |
| 839 |
</p> |
| 840 |
<p> |
| 841 |
See <a class="xref" href="udisks.8.html" title="udisks"><span class="refentrytitle">udisks</span>(8)</a> for how to influence the value of this property. |
| 842 |
</p> |
| 843 |
</div> |
| 844 |
<hr> |
| 845 |
<div class="refsect2"> |
| 846 |
<a name="gdbus-property-org-freedesktop-UDisks2-Drive.SiblingId"></a><h3>The "SiblingId" property</h3> |
| 847 |
<pre class="programlisting"> |
| 848 |
SiblingId readable s |
| 849 |
</pre> |
| 850 |
<p> |
| 851 |
</p> |
| 852 |
<p> |
| 853 |
<em class="parameter"><code>since</code></em>: 2.0.0 |
| 854 |
An opaque token that, if non-blank, is used to group drives |
| 855 |
that are part of the same physical device. |
| 856 |
</p> |
| 857 |
</div> |
| 858 |
</div> |
| 859 |
</div> |
| 860 |
<div class="footer"> |
| 861 |
<hr>Generated by GTK-Doc V1.35.1</div> |
| 862 |
</body> |
| 863 |
</html> |