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
|
<!DOCTYPE node PUBLIC
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<!--
Copyright (C) 2011 David Zeuthen <zeuthen@gmail.com>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General
Public License along with this library; if not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330,
Boston, MA 02111-1307, USA.
-->
<!-- ********************************************************************** -->
<!--
org.freedesktop.UDisks2.Drive:
@short_description: Disk Drive
This interface is used to represent disk drives with or without
removable media.
This interface should not to be confused with the
#org.freedesktop.UDisks2.BlockDevice interface that is used for
any low-level block devices the OS knows about. For example, if
<filename>/dev/sda</filename> and <filename>/dev/sdb</filename>
are block devices for two paths to the same drive, there will be
only one #org.freedesktop.UDisks2.Drive object but two
#org.freedesktop.UDisks2.BlockDevice objects.
-->
<interface name="org.freedesktop.UDisks2.Drive">
<!-- Vendor: A name for the vendor of the drive or blank if unknown. -->
<property name="Vendor" type="ay" access="read"/>
<!-- Model: A name for the model of the drive or blank if unknown. -->
<property name="Model" type="ay" access="read"/>
<!-- Revision: Firmware Revision or blank if unknown. -->
<property name="Revision" type="ay" access="read"/>
<!-- Serial: Serial number of the drive or blank if unknown. -->
<property name="Serial" type="ay" access="read"/>
<!-- WWN:
The <ulink
url="http://en.wikipedia.org/wiki/World_Wide_Name">World Wide
Name</ulink> of the drive or blank if unknown.
-->
<property name="WWN" type="s" access="read"/>
<!-- MediaRemovable: Whether the media can be removed from the drive. -->
<property name="MediaRemovable" type="b" access="read"/>
<!-- Size: The size of the drive. Is set to 0 if, and only if, no media is inserted. -->
<property name="Size" type="t" access="read"/>
<!-- MediaCompatibility:
The physical kind of media the drive uses or blank if unknown.
Known values include
<variablelist>
<varlistentry><term>flash</term><listitem><para>Flash Card</para></listitem></varlistentry>
<varlistentry><term>flash_cf</term><listitem><para>CompactFlash</para></listitem></varlistentry>
<varlistentry><term>flash_ms</term><listitem><para>MemoryStick</para></listitem></varlistentry>
<varlistentry><term>flash_sm</term><listitem><para>SmartMedia</para></listitem></varlistentry>
<varlistentry><term>flash_sd</term><listitem><para>Secure Digital</para></listitem></varlistentry>
<varlistentry><term>flash_sdhc</term><listitem><para>Secure Digital High Capacity</para></listitem></varlistentry>
<varlistentry><term>flash_sdxc</term><listitem><para>Secure Digital eXtended Capacity</para></listitem></varlistentry>
<varlistentry><term>flash_mmc</term><listitem><para>MultiMediaCard</para></listitem></varlistentry>
<varlistentry><term>floppy</term><listitem><para>Floppy Disk</para></listitem></varlistentry>
<varlistentry><term>floppy_zip</term><listitem><para>Zip Disk</para></listitem></varlistentry>
<varlistentry><term>floppy_jaz</term><listitem><para>Jaz Disk</para></listitem></varlistentry>
<varlistentry><term>optical</term><listitem><para>Optical Disc</para></listitem></varlistentry>
<varlistentry><term>optical_cd</term><listitem><para>Compact Disc</para></listitem></varlistentry>
<varlistentry><term>optical_cd_r</term><listitem><para>Compact Disc Recordable</para></listitem></varlistentry>
<varlistentry><term>optical_cd_rw</term><listitem><para>Compact Disc Rewritable</para></listitem></varlistentry>
<varlistentry><term>optical_dvd</term><listitem><para>Digital Versatile Disc</para></listitem></varlistentry>
<varlistentry><term>optical_dvd_r</term><listitem><para>DVD-R</para></listitem></varlistentry>
<varlistentry><term>optical_dvd_rw</term><listitem><para>DVD-RW</para></listitem></varlistentry>
<varlistentry><term>optical_dvd_ram</term><listitem><para>DVD-RAM</para></listitem></varlistentry>
<varlistentry><term>optical_dvd_plus_r</term><listitem><para>DVD+R</para></listitem></varlistentry>
<varlistentry><term>optical_dvd_plus_rw</term><listitem><para>DVD+RW</para></listitem></varlistentry>
<varlistentry><term>optical_dvd_plus_r_dl</term><listitem><para>DVD+R Dual Layer</para></listitem></varlistentry>
<varlistentry><term>optical_dvd_plus_rw_dl</term><listitem><para>DVD+RW Dual Layer</para></listitem></varlistentry>
<varlistentry><term>optical_bd</term><listitem><para>Blu-ray Disc</para></listitem></varlistentry>
<varlistentry><term>optical_bd_r</term><listitem><para>Blu-ray Recordable</para></listitem></varlistentry>
<varlistentry><term>optical_bd_re</term><listitem><para>Blu-ray Rewritable</para></listitem></varlistentry>
<varlistentry><term>optical_hddvd</term><listitem><para>HD-DVD</para></listitem></varlistentry>
<varlistentry><term>optical_hddvd_r</term><listitem><para>HD-DVD Recordable</para></listitem></varlistentry>
<varlistentry><term>optical_hddvd_rw</term><listitem><para>HD-DVD Rewritable</para></listitem></varlistentry>
<varlistentry><term>optical_mo</term><listitem><para>Magneto Optical</para></listitem></varlistentry>
<varlistentry><term>optical_mrw</term><listitem><para>Can read Mount Rainer media</para></listitem></varlistentry>
<varlistentry><term>optical_mrw_w</term><listitem><para>Can write Mount Rainer media</para></listitem></varlistentry>
</variablelist>
-->
<property name="MediaCompatibility" type="as" access="read"/>
<!-- Media: The kind of media currently in the drive or blank if unknown.
See the #org.freedesktop.UDisks2.Drive:MediaCompatibility property for known values.
-->
<property name="Media" type="s" access="read"/>
<!-- RotationRate: The rotational rate of the drive.
<itemizedlist>
<listitem><para>-1 if known to be rotating media but rotation rate isn't known</para></listitem>
<listitem><para>0 if known to be non-rotating media</para></listitem>
<listitem><para>the rotation rate in rounds per minute otherwise</para></listitem>
</itemizedlist>
-->
<property name="RotationRate" type="i" access="read"/>
<!-- ConnectionBus:
The physical connection bus used for the drive as seen by the
user. This is typically used to draw a USB or Firewire emblem
on top of an icon in an user interface.
Note that this property has <emphasis>nothing</emphasis> to do
with the low-level command-set used (such as ATA-8) or what
low-level connection bus (such as SATA, eSATA, PATA, SAS2 etc)
is used.
Known values include:
<variablelist>
<varlistentry><term>usb</term><listitem><para>Connected via USB</para></listitem></varlistentry>
<varlistentry><term>ieee1394</term><listitem><para>Connected via Firewire</para></listitem></varlistentry>
</variablelist>
-->
<property name="ConnectionBus" type="s" access="read"/>
</interface>
<!-- ********************************************************************** -->
<!--
org.freedesktop.UDisks2.BlockDevice:
@short_description: Low-level Block Device
This interface represents a block device.
This should not be confused with the #org.freedesktop.UDisks2.Drive
interface that is used to represent disk drives. For example, the
#org.freedesktop.UDisks2.BlockDevice interface is also used for
block devices that do not correspond to drives at all (e.g. <ulink
url="http://en.wikipedia.org/wiki/Loop_device">Loop
Devices</ulink>).
-->
<interface name="org.freedesktop.UDisks2.BlockDevice">
<!-- Device: The special device file for the block device e.g. <filename>/dev/sda2</filename>. -->
<property name="Device" type="ay" access="read"/>
<!-- Symlinks:
Known symlinks in <filename>/dev</filename> that points to
the device file in the
#org.freedesktop.UDisks2.BlockDevice:Device property.
For example, this array could include symlinks such as
<filename>/dev/disk/by-id/ata-INTEL_SSDSA2MH080G1GC_CVEM842101HD080DGN</filename>
and
<filename>/dev/disk/by-id/wwn-0x5001517387d61905</filename>.
-->
<property name="Symlinks" type="aay" access="read"/>
<!-- Major: The major number of the device. -->
<property name="Major" type="x" access="read"/>
<!-- Minor: The minor number of the device. -->
<property name="Minor" type="x" access="read"/>
<!-- Size: The size of the block device. -->
<property name="Size" type="t" access="read"/>
<!-- PreferredDevice:
The special device file to present in the UI instead of the value
of the #org.freedesktop.UDisks2.BlockDevice:Device property.
For example this could be
e.g. <filename>/dev/mapper/mpathk</filename> for a multipath
device with special device file <filename>/dev/dm-9</filename>.
-->
<property name="PreferredDevice" type="ay" access="read"/>
<!-- Drive:
The #org.freedesktop.UDisks2.Drive object that the block device
belongs to, or '/' if no such object exists.
-->
<property name="Drive" type="o" access="read"/>
<!-- IdUsage:
A result of probing for signatures on the block device. Known values include:
<variablelist>
<varlistentry>
<term>filesystem</term>
<listitem><para>Used for mountable filesystems</para></listitem>
</varlistentry>
<varlistentry>
<term>crypto</term>
<listitem><para>Used for e.g. LUKS devices</para></listitem>
</varlistentry>
<varlistentry>
<term>raid</term>
<listitem><para>Used for e.g. RAID members and LVM PVs</para></listitem>
</varlistentry>
<varlistentry>
<term>other</term>
<listitem><para>Something else was detected.</para></listitem>
</varlistentry>
</variablelist>
If blank, no known signature was detected. This doesn't
necessarily mean the device contains no structured data; it
only means that no signature known to the probing code was
detected.
-->
<property name="IdUsage" type="s" access="read"/>
<!--
IdType:
This property contains more information about the result of
probing the block device. Its value depends of the value the
#org.freedesktop.UDisks2.BlockDevice:IdUsage property:
<variablelist>
<varlistentry><term>filesystem</term>
<listitem><para>The mountable file system that was detected (e.g. <literal>vfat</literal>).</para></listitem>
</varlistentry>
<varlistentry><term>crypto</term>
<listitem><para>Encrypted data. Known values include <literal>crypto_LUKS</literal>.</para></listitem>
</varlistentry>
<varlistentry><term>raid</term>
<listitem><para><ulink url="http://en.wikipedia.org/wiki/RAID">RAID</ulink> or similar. Known values include <literal>LVM2_member</literal> (for LVM2 components), <literal>linux_raid_member</literal> (for MD-RAID components.)</para></listitem>
</varlistentry>
<varlistentry><term>other</term>
<listitem><para>Something else. Known values include <literal>swap</literal> (for swap space), <literal>suspend</literal> (data used when resuming from suspend-to-disk.</para></listitem>
</varlistentry>
</variablelist>
-->
<property name="IdType" type="s" access="read"/>
<!-- IdVersion:
The version of the filesystem or other structured data on the block device.
Do not make any assumptions about the format.
This property is blank if there is no version or the version is unknown.
-->
<property name="IdVersion" type="s" access="read"/>
<!-- IdLabel:
The label of the filesystem or other structured data on the block device.
This property is blank if there is no label or the label is unknown.
-->
<property name="IdLabel" type="ay" access="read"/>
<!-- IdUUID:
The <ulink url="http://en.wikipedia.org/wiki/UUID">UUID</ulink> of the
filesystem or other structured data on the block device. Do not make
any assumptions about the UUID as its format depends on what kind of
data is on the device.
This property is blank if there is no UUID or the UUID is unknown.
-->
<property name="IdUUID" type="ay" access="read"/>
<!-- PartTable: Set to %TRUE if a partition table signature was detected on the device. -->
<property name="PartTable" type="b" access="read"/>
<!-- PartTableScheme: The type of partition table detected.
Known values include <literal>mbr</literal> (for <ulink
url="http://en.wikipedia.org/wiki/Master_Boot_Record">Master
Boot Record</ulink>), <literal>gpt</literal> (for <ulink
url="http://en.wikipedia.org/wiki/GUID_Partition_Table">GUID
Partition Table</ulink>) and <literal>apm</literal> (for
<ulink
url="http://en.wikipedia.org/wiki/Apple_Partition_Map">Apple
Partition Map</ulink>). If blank, and
#org.freedesktop.UDisks2.BlockDevice:PartTable is %TRUE, a
partition table was detected but its scheme is unknown.
-->
<property name="PartTableScheme" type="s" access="read"/>
<!-- PartEntry: Set to %TRUE if the block device represents a partition. -->
<property name="PartEntry" type="b" access="read"/>
<!-- PartEntryNumber: The number of the partition in the partition table. -->
<property name="PartEntryNumber" type="u" access="read"/>
<!-- PartEntryScheme: The partition table scheme or blank if unknown.
See the #org.freedesktop.UDisks2.BlockDevice:PartTable property for known schemes.
-->
<property name="PartEntryScheme" type="s" access="read"/>
<!-- PartEntryType: The type of the partition. -->
<property name="PartEntryType" type="s" access="read"/>
<!-- PartEntryFlags: Partition flags, e.g. <literal>boot</literal>. -->
<property name="PartEntryFlags" type="s" access="read"/>
<!-- PartEntryOffset: Offset of partition. -->
<property name="PartEntryOffset" type="t" access="read"/>
<!-- PartEntrySize: Size of partition. -->
<property name="PartEntrySize" type="t" access="read"/>
<!-- PartEntryLabel: Label of partition or blank if not supported or unknown. -->
<property name="PartEntryLabel" type="ay" access="read"/>
<!-- PartEntryUUID: The UUID of the partition or blank if not supported or unknown. -->
<property name="PartEntryUUID" type="ay" access="read"/>
<!-- PartEntryTable:
The object path of the #org.freedesktop.UDisks2.BlockDevice
partition table that the partition entry belongs to or
<literal>/</literal> if the device is not a partition.
-->
<property name="PartEntryTable" type="o" access="read"/>
<!-- CryptoBackingDevice:
The #org.freedesktop.UDisks2.BlockDevice object that is
backing the device or <literal>/</literal> if unknown or if
the block device is not the cleartext device for an encrypted
device.
-->
<property name="CryptoBackingDevice" type="o" access="read"/>
<!-- LoopBackingFile:
A path to the file that is backing the block device or blank
if unknown or not a loop device.
-->
<property name="LoopBackingFile" type="ay" access="read"/>
</interface>
<!-- ********************************************************************** -->
<!--
org.freedesktop.UDisks2.Filesystem:
@short_description: Block device containing a mountable filesystem
This interface is used for #org.freedesktop.UDisks2.BlockDevice
devices that contain a mountable filesystem.
-->
<interface name="org.freedesktop.UDisks2.Filesystem">
<!-- prereq: org.freedesktop.UDisks2.BlockDevice -->
<!--
SetLabel:
@label: The label to set.
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
Sets the filesystem label.
-->
<method name="SetLabel">
<arg name="label" direction="in" type="ay"/>
<arg name="options" direction="in" type="a{sv}"/>
</method>
<!-- MountPoints:
An array of filesystems paths for where the file system on
the device is mounted. If the device is not mounted, this
array is empty.
-->
<property name="MountPoints" type="aay" access="read"/>
<!--
Mount:
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>fstype</parameter> (of type 's') and <parameter>options</parameter> (of type 's').
@mount_path: The filesystem path where the device was mounted.
Mount the filesystem.
The file system type can be overridden with the
<parameter>fstype</parameter> option and mount options can be
given in <parameter>options</parameter> as a comma-separated
string. Note that the mount options are validated - only a
small subset per filesystem type is allowed.
-->
<method name="Mount">
<arg name="options" direction="in" type="a{sv}"/>
<arg name="mount_path" direction="out" type="ay"/>
</method>
<!--
Unmount:
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>force</parameter> (of type 'b').
Unmount a mounted device.
If the filesystem is busy, this operation fails unless the
option <parameter>force</parameter> is given.
-->
<method name="Unmount">
<arg name="options" direction="in" type="a{sv}"/>
</method>
</interface>
<!-- ********************************************************************** -->
<!--
org.freedesktop.UDisks2.Swapspace:
@short_description: Block device containing swap data
This interface is used for #org.freedesktop.UDisks2.BlockDevice
devices that contain swap space.
-->
<interface name="org.freedesktop.UDisks2.Swapspace">
<!-- prereq: org.freedesktop.UDisks2.BlockDevice -->
<!-- Active: Set to %TRUE if the device is currently in use by the OS. -->
<property name="Active" type="b" access="read"/>
<!--
Start:
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
Activates the swap device.
-->
<method name="Start">
<arg name="options" direction="in" type="a{sv}"/>
</method>
<!--
Stop:
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
Deactivates the swap device.
-->
<method name="Stop">
<arg name="options" direction="in" type="a{sv}"/>
</method>
</interface>
<!-- ********************************************************************** -->
<!--
org.freedesktop.UDisks2.Encrypted:
@short_description: Block device containing encrypted data
This interface is used for #org.freedesktop.UDisks2.BlockDevice
devices that contain encrypted data.
-->
<interface name="org.freedesktop.UDisks2.Encrypted">
<!-- prereq: org.freedesktop.UDisks2.BlockDevice -->
<!--
Unlock:
@passphrase: The passphrase to use.
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
@cleartext_device: An object path to the unlocked cleartext #org.freedesktop.UDisks2.BlockDevice.
Tries to unlock the encrypted device using @passphrase.
-->
<method name="Unlock">
<arg name="passphrase" direction="in" type="ay"/>
<arg name="options" direction="in" type="a{sv}"/>
<arg name="cleartext_device" direction="out" type="o"/>
</method>
<!--
Lock:
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
Locks the encrypted device.
-->
<method name="Lock">
<arg name="options" direction="in" type="a{sv}"/>
</method>
</interface>
<!-- ********************************************************************** -->
<!--
org.freedesktop.UDisks2.Job:
@short_description: Long-running tasks
This interface is used for long-running tasks.
-->
<interface name="org.freedesktop.UDisks2.Job">
<!-- Progress: How much progress has been made. Values are in the range 0 to 1. -->
<property name="Progress" type="d" access="read"/>
<!-- StartTime:
The point in time (seconds since the <ulink
url="http://en.wikipedia.org/wiki/Unix_epoch">Unix
Epoch</ulink>) that the job was started.
-->
<property name="StartTime" type="t" access="read"/>
<!-- ExpectedEndTime:
The expected point in time (seconds since the <ulink
url="http://en.wikipedia.org/wiki/Unix_epoch">Unix
Epoch</ulink>) that the job will complete.
-->
<property name="ExpectedEndTime" type="t" access="read"/>
<!--
Cancel:
@options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
Cancels the job.
-->
<method name="Cancel">
<arg name="options" direction="in" type="a{sv}"/>
</method>
<!--
Completed:
@success: If %TRUE, the job completed successfully.
@message: A message describing the completion of the job, e.g. an error message.
Emitted when a job completes.
-->
<signal name="Completed">
<arg name="success" type="b"/>
<arg name="message" type="s"/>
</signal>
</interface>
<!-- ********************************************************************** -->
</node>
|