Volume

Object Hierarchy:

Description:

public interface Volume : Object

The Volume interface represents user-visible objects that can be mounted.

Note, when porting from GnomeVFS, Volume is the moral equivalent of GnomeVFSDrive.

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

Typically, one will only want to pass null for the 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 GAsyncReady structure will be passed to the callback. That callback should then call mount.end with the Volume instance and the GAsyncReady data to see if the operation was completed successfully. If an error is present when mount.end is called, then it will be filled with any error information.

Volume Identifiers # {`volume`-identifier}

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 commandline). 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: VOLUME_IDENTIFIER_KIND_HAL_UDI, VOLUME_IDENTIFIER_KIND_LABEL, etc. Use get_identifier to obtain an identifier for a volume.

Note that 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 VOLUME_IDENTIFIER_KIND_UNIX_DEVICE identifier, which can be used to obtain a hal device by means of libhal_manager_find_device_string_match.

Namespace: GLib

Package: gio-2.0

Content:

Methods:

public abstract bool can_eject ()
Checks if a volume can be ejected.
public abstract bool can_mount ()
Checks if a volume can be mounted.
public abstract async bool eject (MountUnmountFlags flags, Cancellable? cancellable = null) throws Error
Ejects a volume.
public abstract async bool eject_with_operation (MountUnmountFlags flags, MountOperation? mount_operation, Cancellable? cancellable = null) throws Error
Ejects a volume.
public abstract string[] enumerate_identifiers ()
Gets the kinds of identifiers that this has.
public abstract File? get_activation_root ()
Gets the activation root for a Volume if it is known ahead of mount time.
public abstract Drive get_drive ()
Gets the drive for the this.
public abstract Icon get_icon ()
Gets the icon for this.
public abstract string get_identifier (string kind)
Gets the identifier of the given kind for this.
public abstract Mount get_mount ()
Gets the mount for the this.
public abstract string get_name ()
Gets the name of this.
public virtual unowned string get_sort_key ()
Gets the sort key for this, if any.
public abstract Icon get_symbolic_icon ()
Gets the symbolic icon for this.
public abstract string get_uuid ()
Gets the UUID for the this.
public abstract async bool mount (MountMountFlags flags, MountOperation? mount_operation, Cancellable? cancellable = null) throws Error
Mounts a volume.
public abstract bool should_automount ()
Returns whether the volume should be automatically mounted.

Signals:

public virtual signal void changed ()
Emitted when the volume has been changed.
public virtual signal void removed ()
This signal is emitted when the Volume have been removed.

Inherited Members:

All known members inherited from class GLib.Object