← Back to branch summary

~ubuntu-branches/ubuntu/trusty/udisks2/trusty-proposed

« back to all changes in this revision

Viewing changes to data/org.freedesktop.UDisks2.xml

  • Committer: Package Import Robot
  • Author(s): Martin Pitt
  • Date: 2012-07-28 13:35:04 UTC
  • mfrom: (1.1.2)
  • Revision ID: package-import@ubuntu.com-20120728133504-jmxgy789jegi5vmo
Tags: 1.99.0-1
https://launchpad.net/bugs/1030268
https://launchpad.net/bugs/1022497
* New upstream release (LP: #1030268)
  - Support Realtek rts5229 SD/MMC card readers. (LP: #1022497)
* Drop 00git_no_polkit_fallback.patch, upstream now.
* Drop debian/local/integration-test, shipped in upstream tarball now.
* debian/tests/upstream-system: Run test suite from upstream source.
* debian/tests/control: Simplify Depends: line using "@".
* debian/tests/control: Drop undefined "no-build-needed" feature.

Show diffs side-by-side

added added

removed removed

Lines of Context:
data/org.freedesktop.UDisks2.xml
83
83
    -->
84
84
    <property name="WWN" type="s" access="read"/>
85
85
 
 
86
    <!-- Id:
 
87
         A unique and persistent identifier for the device or blank if
 
88
         no such identifier is available.
 
89
 
 
90
         This identifier is guaranteed to not include the slash
 
91
         character '/' (U+002F SOLIDUS) which means it can be used as
 
92
         a filename.
 
93
 
 
94
         Examples:
 
95
         <quote>ST32000542AS-6XW00W51</quote>,
 
96
         <quote>HITACHI-HTS723232A7A364-E3834563KRG2HN</quote>,
 
97
         <quote>INTEL-SSDSA2MH080G1GC-CVEM842101HD080DGN</quote>.
 
98
    -->
 
99
    <property name="Id" type="s" access="read"/>
 
100
 
 
101
    <!-- Configuration:
 
102
         A set of configuration directives that are applied to the
 
103
         drive when it is connected (e.g. at start-up, hotplug or
 
104
         resume).
 
105
 
 
106
         This is an dict of items with the following known keys:
 
107
         <variablelist>
 
108
           <varlistentry>
 
109
             <term>ata-pm-standby (type <literal>'i'</literal>)</term>
 
110
             <listitem><para>
 
111
               The spindown timeout for ATA drives (See ATA command <quote>STANDBY</quote>).
 
112
             </para></listitem>
 
113
           </varlistentry>
 
114
           <varlistentry>
 
115
             <term>ata-apm-level (type <literal>'i'</literal>)</term>
 
116
             <listitem><para>
 
117
               The APM level for ATA drives (See ATA command <quote>SET FEATURES</quote>, sub-commands 0x05 and 0x85).
 
118
             </para></listitem>
 
119
           </varlistentry>
 
120
           <varlistentry>
 
121
             <term>ata-aam-level (type <literal>'i'</literal>)</term>
 
122
             <listitem><para>
 
123
               The AAM level for ATA drives (See ATA command <quote>SET FEATURES</quote>, sub-commands 0x42 and 0xc2).
 
124
             </para></listitem>
 
125
           </varlistentry>
 
126
         </variablelist>
 
127
         The contents of this property is read from the configuration
 
128
         file <filename>/etc/udisks2/IDENTIFIER.conf</filename>
 
129
         where <emphasis>IDENTIFIER</emphasis> is the value of the
 
130
         #org.freedesktop.UDisks2.Drive:Id property. See <xref
 
131
         linkend="udisks.8"/> for the file format of this file.
 
132
 
 
133
         Use the org.freedesktop.UDisks2.Drive.SetConfiguration()
 
134
         method to change the value of this property.
 
135
    -->
 
136
    <property name="Configuration" type="a{sv}" access="read"/>
 
137
 
86
138
    <!-- Media: The kind of media currently in the drive or blank if unknown.
87
139
         See the #org.freedesktop.UDisks2.Drive:MediaCompatibility property for known values.
88
140
    -->
276
328
    <method name="Eject">
277
329
      <arg name="options" direction="in" type="a{sv}"/>
278
330
    </method>
 
331
 
 
332
    <!--
 
333
        SetConfiguration:
 
334
        @value: The configuration value to set.
 
335
        @options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
 
336
 
 
337
        Sets the configuration for the drive. This will store the
 
338
        configuration in the file-system and also apply it to the
 
339
        drive.
 
340
 
 
341
        See the #org.freedesktop.UDisks2.Drive:Configuration property
 
342
        for details about valid values and the location of the
 
343
        configuration file that @value will be written to.
 
344
    -->
 
345
    <method name="SetConfiguration">
 
346
      <arg name="value" direction="in" type="a{sv}"/>
 
347
      <arg name="options" direction="in" type="a{sv}"/>
 
348
    </method>
 
349
 
279
350
  </interface>
280
351
 
281
352
  <!--
452
523
      <arg name="options" direction="in" type="a{sv}"/>
453
524
    </method>
454
525
 
 
526
    <!-- PmSupported: Whether the drive supports power management. -->
 
527
    <property name="PmSupported" type="b" access="read"/>
 
528
 
 
529
    <!-- PmEnabled: Whether power management is enabled. -->
 
530
    <property name="PmEnabled" type="b" access="read"/>
 
531
 
 
532
    <!-- ApmSupported: Whether the drive supports Advanced Power Management (APM). -->
 
533
    <property name="ApmSupported" type="b" access="read"/>
 
534
 
 
535
    <!-- ApmEnabled: Whether Advanced Power Management (APM) is enabled. -->
 
536
    <property name="ApmEnabled" type="b" access="read"/>
 
537
 
 
538
    <!-- AamSupported: Whether the drive supports Automatic Acoustic Management (AAM). -->
 
539
    <property name="AamSupported" type="b" access="read"/>
 
540
 
 
541
    <!-- AamEnabled: Whether Automatic Acoustic Management (AAM) is enabled. -->
 
542
    <property name="AamEnabled" type="b" access="read"/>
 
543
 
 
544
    <!-- AamVendorRecommendedValue: The vendor-recommended AAM value (or 0 if AAM is not supported). -->
 
545
    <property name="AamVendorRecommendedValue" type="i" access="read"/>
 
546
 
 
547
    <!--
 
548
        PmGetState:
 
549
        @options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
 
550
        @state: The current power state.
 
551
 
 
552
        Get the current power mode status. This is implemented as a
 
553
        method call as it involves sending a command from the host to
 
554
        the drive and no change notification is available.
 
555
 
 
556
        The format of @state is the result obtained from sending the
 
557
        ATA command <quote>CHECK POWER MODE</quote> to the drive.
 
558
        Known values include
 
559
        <variablelist>
 
560
        <varlistentry><term>0x00</term><listitem><para>Standby</para></listitem></varlistentry>
 
561
        <varlistentry><term>0x80</term><listitem><para>Idle</para></listitem></varlistentry>
 
562
        <varlistentry><term>0xff</term><listitem><para>Active/Idle</para></listitem></varlistentry>
 
563
        </variablelist>
 
564
        Typically user interfaces will report "Drive is spun down" if @state is
 
565
        0x00 and "Drive is spun up" otherwise.
 
566
    -->
 
567
    <method name="PmGetState">
 
568
      <arg name="options" direction="in" type="a{sv}"/>
 
569
      <arg name="state" direction="out" type="y"/>
 
570
    </method>
 
571
 
 
572
    <!--
 
573
        PmStandby:
 
574
        @options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
 
575
 
 
576
        Force the drive to immediately enter the low power consumption
 
577
        <emphasis>standby</emphasis> mode, usually causing it to spin
 
578
        down. This is done by sending the ATA command
 
579
        <quote>STANDBY IMMEDIATE</quote> to the drive.
 
580
    -->
 
581
    <method name="PmStandby">
 
582
      <arg name="options" direction="in" type="a{sv}"/>
 
583
    </method>
 
584
 
 
585
    <!--
 
586
        PmWakeup:
 
587
        @options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
 
588
 
 
589
        Force the drive to immediately wake up (exiting the low power
 
590
        consumption <emphasis>standby</emphasis> mode), usually
 
591
        causing it to spin up. This is done by reading data from the
 
592
        disk.
 
593
    -->
 
594
    <method name="PmWakeup">
 
595
      <arg name="options" direction="in" type="a{sv}"/>
 
596
    </method>
 
597
 
 
598
    <!-- SecurityEraseUnitMinutes:
 
599
         The estimated amount of minutes it takes to complete the
 
600
         <quote>SECURITY ERASE UNIT</quote> command or 0 if this
 
601
         command is not available.
 
602
 
 
603
         If set to 510 it means that it takes at least 508 minutes to
 
604
         complete the operation.
 
605
    -->
 
606
    <property name="SecurityEraseUnitMinutes" type="i" access="read"/>
 
607
 
 
608
    <!-- SecurityEnhancedEraseUnitMinutes:
 
609
         The estimated amount of minutes it takes to complete the
 
610
         <quote>SECURITY ERASE UNIT</quote> command with enhanced mode
 
611
         specified or 0 if enhanced erase is not available.
 
612
 
 
613
         If set to 510 it means that it takes at least 508 minutes to
 
614
         complete the operation.
 
615
    -->
 
616
    <property name="SecurityEnhancedEraseUnitMinutes" type="i" access="read"/>
 
617
 
 
618
    <!-- SecurityFrozen:
 
619
         If set to %TRUE the unit is frozen.
 
620
    -->
 
621
    <property name="SecurityFrozen" type="b" access="read"/>
 
622
 
 
623
    <!--
 
624
        SecurityEraseUnit:
 
625
        @options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>enhanced</parameter> (of type 'b').
 
626
 
 
627
        Does all the necessary checks and preparations and then sends
 
628
        the <quote>SECURITY ERASE UNIT</quote> command to the
 
629
        drive. If the option @enhanced is set to %TRUE an
 
630
        <emphasis>enhanced secure erase</emphasis> is requested.
 
631
 
 
632
        All data on the drive will be irrevocably erased.
 
633
 
 
634
        This operation takes either
 
635
        #org.freedesktop.UDisks2.Drive.Ata:SecurityEraseUnitMinutes or
 
636
        #org.freedesktop.UDisks2.Drive.Ata:SecurityEnhancedEraseUnitMinutes
 
637
        minutes to complete depending on whether the @enhanced option
 
638
        is %TRUE.
 
639
    -->
 
640
    <method name="SecurityEraseUnit">
 
641
      <arg name="options" direction="in" type="a{sv}"/>
 
642
    </method>
 
643
 
 
644
 
455
645
  </interface>
456
646
 
457
647
  <!-- ********************************************************************** -->
804
994
    <!--
805
995
        Format:
806
996
        @type: The type of file system, partition table or other content to format the device with.
807
 
        @options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>label</parameter> (of type 's'), <parameter>take-ownership</parameter> (of type 'b') and <parameter>encrypt.passphrase</parameter> (of type 's').
 
997
        @options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>label</parameter> (of type 's'), <parameter>take-ownership</parameter> (of type 'b'), <parameter>encrypt.passphrase</parameter> (of type 's') and <parameter>erase</parameter> (of type 's').
808
998
 
809
999
        Formats the device with a file system, partition table or
810
1000
        other well-known content.
833
1023
        given then a LUKS device is created with the given passphrase
834
1024
        and the file system is created on the unlocked device. The
835
1025
        unlocked device will be left open.
 
1026
 
 
1027
        If the option <parameter>erase</parameter> is used then the
 
1028
        underlying device will be erased. Valid values include
 
1029
        <quote>zero</quote> to write zeroes over the entire device
 
1030
        before formatting, <quote>ata-secure-erase</quote> to perform
 
1031
        a secure erase or <quote>ata-secure-erase-enhanced</quote> to
 
1032
        perform an enhanced secure erase.
836
1033
    -->
837
1034
    <method name="Format">
838
1035
      <arg name="type" direction="in" type="s"/>
869
1066
      <arg name="fd" direction="out" type="h"/>
870
1067
    </method>
871
1068
 
 
1069
    <!--
 
1070
        OpenForBenchmark:
 
1071
        @options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
 
1072
        @fd: An index for the returned file descriptor.
 
1073
 
 
1074
        Gets a file descriptor for the device that is suitable to be
 
1075
        used for benchmarking the device (transfer rate, access time
 
1076
        etc.). Note that the file descriptor may be opened with the
 
1077
        <literal>O_DIRECT</literal> and <literal>O_SYNC</literal>
 
1078
        flags so care must be taken to only perform page-aligned I/O.
 
1079
 
 
1080
        If the <parameter>writable</parameter> in @options is %TRUE
 
1081
        then the returned file descriptor will be writable. This only
 
1082
        works if the device is not already in use.
 
1083
    -->
 
1084
    <method name="OpenForBenchmark">
 
1085
      <annotation name="org.gtk.GDBus.C.UnixFD" value="1"/>
 
1086
      <arg name="options" direction="in" type="a{sv}"/>
 
1087
      <arg name="fd" direction="out" type="h"/>
 
1088
    </method>
 
1089
 
 
1090
    <!--
 
1091
        Rescan:
 
1092
        @options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
 
1093
 
 
1094
        Request that the kernel and core OS rescans the contents of
 
1095
        the device and update their state to reflect this (including
 
1096
        things such as the <filename>/dev/disk/</filename> hierarchy
 
1097
        of symlinks). This includes requesting that the kernel
 
1098
        re-reads the partition table, if appropriate.
 
1099
 
 
1100
        This is usually not needed since the OS automatically does
 
1101
        this when the last process with a writable file descriptor for
 
1102
        the device closes it.
 
1103
    -->
 
1104
    <method name="Rescan">
 
1105
      <arg name="options" direction="in" type="a{sv}"/>
 
1106
    </method>
 
1107
 
872
1108
  </interface>
873
1109
 
874
1110
  <!-- ********************************************************************** -->
1344
1580
      things, this can be used to draw a spinner in the user interface
1345
1581
      next to e.g. an icon for the drive or device in question.
1346
1582
 
1347
 
      A job <emphasis>may</emphasis> convey progress (if the
1348
 
      underlying tool used supports it), see the
1349
 
      #org.freedesktop.UDisks2.Job:ExpectedEndTime property.
 
1583
      The #org.freedesktop.UDisks2.Job:Operation property is used to
 
1584
      convey the type of job currently in progress.
 
1585
 
 
1586
      The user id of the user who started the job is set in the
 
1587
      #org.freedesktop.UDisks2.Job:StartedByUID property.
 
1588
 
 
1589
      A job <emphasis>may</emphasis> convey how much progress has been
 
1590
      made, see the #org.freedesktop.UDisks2.Job:Progress and
 
1591
      #org.freedesktop.UDisks2.Job:ProgressValid properties.
1350
1592
 
1351
1593
      When a job completes, the #org.freedesktop.UDisks2.Job::Completed signal
1352
1594
      is emitted.
1353
1595
 
1354
 
      To cancel a job use the org.freedesktop.UDisks2.Job.Cancel()
1355
 
      method. This will cause the job to complete (with @success set
1356
 
      to %FALSE) and the D-Bus method used to initiate the operation
1357
 
      to return, usually returning the <literal>org.freedesktop.UDisks2.Error.Cancelled</literal> error.
 
1596
      A job may or may not be cancelable, see the
 
1597
      #org.freedesktop.UDisks2.Job:Cancelable property. To cancel a
 
1598
      job use the org.freedesktop.UDisks2.Job.Cancel() method. This
 
1599
      will cause the job to complete (with @success set to %FALSE) and
 
1600
      the D-Bus method used to initiate the operation to return,
 
1601
      usually returning the
 
1602
      <literal>org.freedesktop.UDisks2.Error.Cancelled</literal>
 
1603
      error.
1358
1604
  -->
1359
1605
  <interface name="org.freedesktop.UDisks2.Job">
1360
1606
 
1361
 
    <!-- Progress: How much progress has been made. Values are in the range 0 to 1. -->
 
1607
    <!-- Operation:
 
1608
         The type of the operation that the job represents.
 
1609
 
 
1610
         Known job operation types include:
 
1611
         <variablelist>
 
1612
           <varlistentry><term>ata-smart-selftest</term>
 
1613
             <listitem><para>SMART self-test operation.</para></listitem></varlistentry>
 
1614
           <varlistentry><term>drive-eject</term>
 
1615
             <listitem><para>Ejecting the medium from a drive.</para></listitem></varlistentry>
 
1616
           <varlistentry><term>encrypted-unlock</term>
 
1617
             <listitem><para>Unlocking encrypted device.</para></listitem></varlistentry>
 
1618
           <varlistentry><term>encrypted-lock</term>
 
1619
             <listitem><para>Locking encrypted device.</para></listitem></varlistentry>
 
1620
           <varlistentry><term>encrypted-modify</term>
 
1621
             <listitem><para>Modifying encrypted device.</para></listitem></varlistentry>
 
1622
           <varlistentry><term>swapspace-start</term>
 
1623
             <listitem><para>Starting swapspace.</para></listitem></varlistentry>
 
1624
           <varlistentry><term>swapspace-stop</term>
 
1625
             <listitem><para>Stopping swapspace.</para></listitem></varlistentry>
 
1626
           <varlistentry><term>filesystem-mount</term>
 
1627
             <listitem><para>Mounting a filesystem.</para></listitem></varlistentry>
 
1628
           <varlistentry><term>filesystem-unmount</term>
 
1629
             <listitem><para>Unmounting a filesystem.</para></listitem></varlistentry>
 
1630
           <varlistentry><term>filesystem-modify</term>
 
1631
             <listitem><para>Modifying a filesystem.</para></listitem></varlistentry>
 
1632
           <varlistentry><term>format-erase</term>
 
1633
             <listitem><para>Erasing a device.</para></listitem></varlistentry>
 
1634
           <varlistentry><term>format-mkfs</term>
 
1635
             <listitem><para>Creating a filesystem.</para></listitem></varlistentry>
 
1636
           <varlistentry><term>loop-setup</term>
 
1637
             <listitem><para>Setting up a loop device.</para></listitem></varlistentry>
 
1638
           <varlistentry><term>partition-modify</term>
 
1639
             <listitem><para>Modifying a partition.</para></listitem></varlistentry>
 
1640
           <varlistentry><term>partition-delete</term>
 
1641
             <listitem><para>Deleting a partition.</para></listitem></varlistentry>
 
1642
           <varlistentry><term>partition-create</term>
 
1643
             <listitem><para>Creating a partition.</para></listitem></varlistentry>
 
1644
           <varlistentry><term>cleanup</term>
 
1645
             <listitem><para>Cleaning up devices that were removed without being properly unmounted or shut down.</para></listitem></varlistentry>
 
1646
         </variablelist>
 
1647
         The
 
1648
         <link linkend="udisks-client-get-job-description">udisks_client_get_job_description()</link>
 
1649
         function can be used to get a localized human readable description.
 
1650
    -->
 
1651
    <property name="Operation" type="s" access="read"/>
 
1652
 
 
1653
    <!-- Progress:
 
1654
         How much progress has been made. Values are in the range 0 to 1.
 
1655
 
 
1656
         Do not use unless #org.freedesktop.UDisks2.Job:ProgressValid is %TRUE.
 
1657
    -->
1362
1658
    <property name="Progress" type="d" access="read"/>
 
1659
 
 
1660
    <!-- ProgressValid: Set to %TRUE if the #org.freedesktop.UDisks2.Job:Progress is valid. -->
 
1661
    <property name="ProgressValid" type="b" access="read"/>
 
1662
 
1363
1663
    <!-- StartTime:
1364
1664
 
1365
 
         The point in time (seconds since the <ulink
 
1665
         The point in time (micro-seconds since the <ulink
1366
1666
         url="http://en.wikipedia.org/wiki/Unix_epoch">Unix
1367
1667
         Epoch</ulink>) that the job was started.
1368
1668
    -->
1369
1669
    <property name="StartTime" type="t" access="read"/>
 
1670
 
1370
1671
    <!-- ExpectedEndTime:
1371
1672
 
1372
 
         The expected point in time (seconds since the <ulink
 
1673
         The expected point in time (micro-seconds since the <ulink
1373
1674
         url="http://en.wikipedia.org/wiki/Unix_epoch">Unix
1374
1675
         Epoch</ulink>) that the job will complete or 0 if unknown.
1375
1676
    -->
1378
1679
    <!-- Objects: The objects that the job is related to, if any. -->
1379
1680
    <property name="Objects" type="ao" access="read"/>
1380
1681
 
 
1682
    <!-- StartedByUID:
 
1683
         The id of the user who started the job or 0 if started
 
1684
         by root or not through udisks.
 
1685
    -->
 
1686
    <property name="StartedByUID" type="u" access="read"/>
 
1687
 
1381
1688
    <!--
1382
1689
        Cancel:
1383
1690
        @options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
1384
1691
 
1385
 
        Cancels the job.
 
1692
        Cancels the job. Fails with the
 
1693
        <literal>org.freedesktop.UDisks2.Error.Failed</literal> error
 
1694
        if #org.freedesktop.UDisks2.Job:Cancelable is %FALSE.
1386
1695
    -->
1387
1696
    <method name="Cancel">
1388
1697
      <arg name="options" direction="in" type="a{sv}"/>
1389
1698
    </method>
1390
1699
 
 
1700
    <!-- Cancelable: Whether the job can be canceled. -->
 
1701
    <property name="Cancelable" type="b" access="read"/>
 
1702
 
1391
1703
    <!--
1392
1704
        Completed:
1393
1705
        @success: If %TRUE, the job completed successfully.