summaryrefslogtreecommitdiff
path: root/data/org.freedesktop.UDisks2.xml
diff options
context:
space:
mode:
authorDavid Zeuthen <davidz@redhat.com>2011-08-24 14:27:19 -0400
committerDavid Zeuthen <davidz@redhat.com>2011-08-24 14:27:19 -0400
commite9f628ed420f90310d6078b7d27830114737a354 (patch)
treedfc4b8c965bff4270a27f7a77410c80c15cf3371 /data/org.freedesktop.UDisks2.xml
parente83956240c32f88c386964591f857444d0886e3e (diff)
Rename BlockDevice interface to Blockgdbus-port
Signed-off-by: David Zeuthen <davidz@redhat.com>
Diffstat (limited to 'data/org.freedesktop.UDisks2.xml')
-rw-r--r--data/org.freedesktop.UDisks2.xml77
1 files changed, 39 insertions, 38 deletions
diff --git a/data/org.freedesktop.UDisks2.xml b/data/org.freedesktop.UDisks2.xml
index fe9b395..280b846 100644
--- a/data/org.freedesktop.UDisks2.xml
+++ b/data/org.freedesktop.UDisks2.xml
@@ -39,7 +39,7 @@
LoopSetup:
@fd: An index for the file descriptor to use.
@options: Options - known options (in addition to <link linkend="udisks-std-options">standard options</link>) includes <parameter>offset</parameter> (of type 't'), <parameter>size</parameter> (of type 't') and <parameter>read-only</parameter> (of type 'b').
- @resulting_device: An object path to the object implementing the #org.freedesktop.UDisks2.BlockDevice interface.
+ @resulting_device: An object path to the object implementing the #org.freedesktop.UDisks2.Block interface.
Creates a block device for the file represented by @fd.
-->
@@ -59,12 +59,12 @@
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
+ #org.freedesktop.UDisks2.Block interface that is used for
+ 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.
+ #org.freedesktop.UDisks2.Block objects.
-->
<interface name="org.freedesktop.UDisks2.Drive">
<!-- Vendor: A name for the vendor of the drive or blank if unknown. -->
@@ -256,26 +256,27 @@
<!-- ********************************************************************** -->
<!--
- org.freedesktop.UDisks2.BlockDevice:
+ org.freedesktop.UDisks2.Block:
@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
+ 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.Block
+ 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">
+ <interface name="org.freedesktop.UDisks2.Block">
<!-- 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.
+ #org.freedesktop.UDisks2.Block:Device property.
For example, this array could include symlinks such as
<filename>/dev/disk/by-id/ata-INTEL_SSDSA2MH080G1GC_CVEM842101HD080DGN</filename>
@@ -292,7 +293,7 @@
<!-- PreferredDevice:
The special device file to present in the UI instead of the value
- of the #org.freedesktop.UDisks2.BlockDevice:Device property.
+ of the #org.freedesktop.UDisks2.Block:Device property.
For example this could be
e.g. <filename>/dev/mapper/mpathk</filename> for a multipath
@@ -336,7 +337,7 @@
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:
+ #org.freedesktop.UDisks2.Block:IdUsage property:
<variablelist>
<varlistentry><term>filesystem</term>
<listitem><para>The mountable file system that was detected (e.g. <literal>vfat</literal>).</para></listitem>
@@ -385,14 +386,14 @@
actual configuration data.
Use the
- org.freedesktop.UDisks2.BlockDevice.AddConfigurationItem(),
- org.freedesktop.UDisks2.BlockDevice.RemoveConfigurationItem()
+ org.freedesktop.UDisks2.Block.AddConfigurationItem(),
+ org.freedesktop.UDisks2.Block.RemoveConfigurationItem()
and
- org.freedesktop.UDisks2.BlockDevice.UpdateConfigurationItem()
+ org.freedesktop.UDisks2.Block.UpdateConfigurationItem()
methods to add, remove and update configuration items.
Use
- org.freedesktop.UDisks2.BlockDevice.GetSecretConfiguration()
+ org.freedesktop.UDisks2.Block.GetSecretConfiguration()
to get the secrets (e.g. passphrases) that may be part of the
configuration but isn't exported in this property for
security reasons.
@@ -452,7 +453,7 @@
<varlistentry>
<term>passphrase-contents (type <literal>'ay'</literal>)</term>
<listitem><para>The contents of the file containing the encryption password, if applicable.
- This is only available via the org.freedesktop.UDisks2.BlockDevice.GetSecretConfiguration()
+ This is only available via the org.freedesktop.UDisks2.Block.GetSecretConfiguration()
method.</para></listitem>
</varlistentry>
<varlistentry>
@@ -462,7 +463,7 @@
</variablelist>
For security reasons, when creating a new
<literal>crypttab</literal> entry (via the
- org.freedesktop.UDisks2.BlockDevice.AddConfigurationItem()
+ org.freedesktop.UDisks2.Block.AddConfigurationItem()
method), then the <option>passphrase-path</option> must
reference an unexisting file in the
<filename>/etc/luks-keys</filename> directory.
@@ -470,7 +471,7 @@
<property name="Configuration" type="a(sa{sv})" access="read"/>
<!-- CryptoBackingDevice:
- The #org.freedesktop.UDisks2.BlockDevice object that is
+ The #org.freedesktop.UDisks2.Block 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.
@@ -508,7 +509,7 @@
<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
+ #org.freedesktop.UDisks2.Block:PartTable is %TRUE, a
partition table was detected but its scheme is unknown.
-->
<property name="PartTableScheme" type="s" access="read"/>
@@ -518,7 +519,7 @@
<!-- 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.
+ See the #org.freedesktop.UDisks2.Block:PartTable property for known schemes.
-->
<property name="PartEntryScheme" type="s" access="read"/>
<!-- PartEntryType: The type of the partition. -->
@@ -534,7 +535,7 @@
<!-- 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
+ The object path of the #org.freedesktop.UDisks2.Block
partition table that the partition entry belongs to or
<literal>/</literal> if the device is not a partition.
-->
@@ -547,7 +548,7 @@
Adds a new configuration item.
- See the #org.freedesktop.UDisks2.BlockDevice:Configuration
+ See the #org.freedesktop.UDisks2.Block:Configuration
property for details about valid configuration items.
-->
<method name="AddConfigurationItem">
@@ -562,7 +563,7 @@
Removes an existing configuration item.
- See the #org.freedesktop.UDisks2.BlockDevice:Configuration
+ See the #org.freedesktop.UDisks2.Block:Configuration
property for details about valid configuration items.
-->
<method name="RemoveConfigurationItem">
@@ -578,13 +579,13 @@
Removes a configuration item and adds a new one. This is
equivalent to calling
- org.freedesktop.UDisks2.BlockDevice.RemoveConfigurationItem()
+ org.freedesktop.UDisks2.Block.RemoveConfigurationItem()
followed by
- org.freedesktop.UDisks2.BlockDevice.AddConfigurationItem()
+ org.freedesktop.UDisks2.Block.AddConfigurationItem()
with the change that only one PolicyKit check is made
and that @new_item can be validated against @old_item.
- See the #org.freedesktop.UDisks2.BlockDevice:Configuration
+ See the #org.freedesktop.UDisks2.Block:Configuration
property for details about valid configuration items.
-->
<method name="UpdateConfigurationItem">
@@ -599,7 +600,7 @@
@configuration: The resulting configuration.
Returns the same value as in the
- #org.freedesktop.UDisks2.BlockDevice:Configuration property
+ #org.freedesktop.UDisks2.Block:Configuration property
but without secret information filtered out.
-->
<method name="GetSecretConfiguration">
@@ -615,11 +616,11 @@
org.freedesktop.UDisks2.Filesystem:
@short_description: Block device containing a mountable filesystem
- This interface is used for #org.freedesktop.UDisks2.BlockDevice
+ This interface is used for #org.freedesktop.UDisks2.Block
devices that contain a mountable filesystem.
-->
<interface name="org.freedesktop.UDisks2.Filesystem">
- <!-- prereq: org.freedesktop.UDisks2.BlockDevice -->
+ <!-- prereq: org.freedesktop.UDisks2.Block -->
<!--
SetLabel:
@@ -727,11 +728,11 @@
org.freedesktop.UDisks2.Swapspace:
@short_description: Block device containing swap data
- This interface is used for #org.freedesktop.UDisks2.BlockDevice
+ This interface is used for #org.freedesktop.UDisks2.Block
devices that contain swap space.
-->
<interface name="org.freedesktop.UDisks2.Swapspace">
- <!-- prereq: org.freedesktop.UDisks2.BlockDevice -->
+ <!-- prereq: org.freedesktop.UDisks2.Block -->
<!-- Active: Set to %TRUE if the device is currently in use by the OS. -->
<property name="Active" type="b" access="read"/>
@@ -763,17 +764,17 @@
org.freedesktop.UDisks2.Encrypted:
@short_description: Block device containing encrypted data
- This interface is used for #org.freedesktop.UDisks2.BlockDevice
+ This interface is used for #org.freedesktop.UDisks2.Block
devices that contain encrypted data.
-->
<interface name="org.freedesktop.UDisks2.Encrypted">
- <!-- prereq: org.freedesktop.UDisks2.BlockDevice -->
+ <!-- prereq: org.freedesktop.UDisks2.Block -->
<!--
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 object implementing the #org.freedesktop.UDisks2.BlockDevice interface.
+ @cleartext_device: An object path to the unlocked object implementing the #org.freedesktop.UDisks2.Block interface.
Tries to unlock the encrypted device using @passphrase.
@@ -809,11 +810,11 @@
org.freedesktop.UDisks2.Loop:
@short_description: Block device backed by a file
- This interface is used for #org.freedesktop.UDisks2.BlockDevice
+ This interface is used for #org.freedesktop.UDisks2.Block
devices that are loop devices.
-->
<interface name="org.freedesktop.UDisks2.Loop">
- <!-- prereq: org.freedesktop.UDisks2.BlockDevice -->
+ <!-- prereq: org.freedesktop.UDisks2.Block -->
<!--
Delete: