Volume

interface Volume

The GVolume interface represents user-visible objects that can be mounted. For example, a file system partition on a USB flash drive, or an optical disc inserted into a disc drive.

If a GVolume is currently mounted, the corresponding iface@Gio.Mount can be retrieved using method@Gio.Volume.get_mount.

Mounting a GVolume instance is an asynchronous operation. For more information about asynchronous operations, see iface@Gio.AsyncResult and class@Gio.Task. To mount a GVolume, first call method@Gio.Volume.mount with (at least) the GVolume instance, optionally a class@Gio.MountOperation object and a type@Gio.AsyncReadyCallback.

Typically, one will only want to pass NULL for the class@Gio.MountOperation if automounting all volumes when a desktop session starts since it’s not desirable to put up a lot of dialogs asking for credentials.

The callback will be fired when the operation has resolved (either with success or failure), and a iface@Gio.AsyncResult instance will be passed to the callback. That callback should then call method@Gio.Volume.mount_finish with the GVolume instance and the iface@Gio.AsyncResult data to see if the operation was completed successfully. If a type@GLib.Error is present when method@Gio.Volume.mount_finish is called, then it will be filled with any error information.

Note, when migrating-gnome-vfs.html, GVolume is the moral equivalent of GnomeVFSDrive.

Volume Identifiers

It is sometimes necessary to directly access the underlying operating system object behind a volume (e.g. for passing a volume to an application via the command line). For this purpose, GIO allows to obtain an ‘identifier’ for the volume. There can be different kinds of identifiers, such as Hal UDIs, filesystem labels, traditional Unix devices (e.g. /dev/sda2), UUIDs. GIO uses predefined strings as names for the different kinds of identifiers: G_VOLUME_IDENTIFIER_KIND_UUID, G_VOLUME_IDENTIFIER_KIND_LABEL, etc. Use method@Gio.Volume.get_identifier to obtain an identifier for a volume.

Note that G_VOLUME_IDENTIFIER_KIND_HAL_UDI will only be available when the GVFS hal volume monitor is in use. Other volume monitors will generally be able to provide the G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE identifier, which can be used to obtain a hal device by means of libhal_manager_find_device_string_match().

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
abstract val gioVolumePointer: <Error class: unknown class><<Error class: unknown class>>

Functions

Link copied to clipboard
open fun canEject(): Boolean

Checks if a volume can be ejected.

Link copied to clipboard
open fun canMount(): Boolean

Checks if a volume can be mounted.

Link copied to clipboard
open fun connectChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when the volume has been changed.

Link copied to clipboard
open fun connectRemoved(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

This signal is emitted when the #GVolume have been removed. If the recipient is holding references to the object they should release them so the object can be finalized.

Link copied to clipboard
open fun eject(flags: MountUnmountFlags, cancellable: Cancellable? = null, callback: AsyncReadyCallback)

Ejects a volume. This is an asynchronous operation, and is finished by calling g_volume_eject_finish() with the @volume and #GAsyncResult returned in the @callback.

Link copied to clipboard
open fun ejectFinish(result: AsyncResult): <Error class: unknown class><Boolean>

Finishes ejecting a volume. If any errors occurred during the operation,

Link copied to clipboard
open fun ejectWithOperation(flags: MountUnmountFlags, mountOperation: MountOperation? = null, cancellable: Cancellable? = null, callback: AsyncReadyCallback)

Ejects a volume. This is an asynchronous operation, and is finished by calling g_volume_eject_with_operation_finish() with the @volume and #GAsyncResult data returned in the @callback.

Link copied to clipboard
open fun ejectWithOperationFinish(result: AsyncResult): <Error class: unknown class><Boolean>

Finishes ejecting a volume. If any errors occurred during the operation,

Link copied to clipboard

Gets the kinds of #volume-identifiers that @volume has. Use g_volume_get_identifier() to obtain the identifiers themselves.

Link copied to clipboard
open fun getActivationRoot(): File?

Gets the activation root for a #GVolume if it is known ahead of mount time. Returns null otherwise. If not null and if @volume is mounted, then the result of g_mount_get_root() on the #GMount object obtained from g_volume_get_mount() will always either be equal or a prefix of what this function returns. In other words, in code

Link copied to clipboard
open fun getDrive(): Drive?

Gets the drive for the @volume.

Link copied to clipboard
open fun getIcon(): Icon

Gets the icon for @volume.

Link copied to clipboard
open fun getIdentifier(kind: String): String?

Gets the identifier of the given kind for @volume. See the #volume-identifiers for more information about volume identifiers.

Link copied to clipboard
open fun getMount(): Mount?

Gets the mount for the @volume.

Link copied to clipboard
open fun getName(): String

Gets the name of @volume.

Link copied to clipboard
open fun getSortKey(): String?

Gets the sort key for @volume, if any.

Link copied to clipboard
open fun getSymbolicIcon(): Icon

Gets the symbolic icon for @volume.

Link copied to clipboard
open fun getUuid(): String?

Gets the UUID for the @volume. The reference is typically based on the file system UUID for the volume in question and should be considered an opaque string. Returns null if there is no UUID available.

Link copied to clipboard
open fun mount(flags: MountMountFlags, mountOperation: MountOperation? = null, cancellable: Cancellable? = null, callback: AsyncReadyCallback)

Mounts a volume. This is an asynchronous operation, and is finished by calling g_volume_mount_finish() with the @volume and #GAsyncResult returned in the @callback.

Link copied to clipboard
open fun mountFinish(result: AsyncResult): <Error class: unknown class><Boolean>

Finishes mounting a volume. If any errors occurred during the operation,

Link copied to clipboard

Returns whether the volume should be automatically mounted.