UDisks.Filesystem

g GObject.GInterface GObject.GInterface UDisks.Filesystem UDisks.Filesystem GObject.GInterface->UDisks.Filesystem

Implementations:
 UDisks.FilesystemProxy, UDisks.FilesystemSkeleton

Methods

class interface_info ()
class override_properties (klass, property_id_begin)
  call_check (arg_options, cancellable, callback, *user_data)
  call_check_finish (res)
  call_check_sync (arg_options, cancellable)
  call_mount (arg_options, cancellable, callback, *user_data)
  call_mount_finish (res)
  call_mount_sync (arg_options, cancellable)
  call_repair (arg_options, cancellable, callback, *user_data)
  call_repair_finish (res)
  call_repair_sync (arg_options, cancellable)
  call_resize (arg_size, arg_options, cancellable, callback, *user_data)
  call_resize_finish (res)
  call_resize_sync (arg_size, arg_options, cancellable)
  call_set_label (arg_label, arg_options, cancellable, callback, *user_data)
  call_set_label_finish (res)
  call_set_label_sync (arg_label, arg_options, cancellable)
  call_take_ownership (arg_options, cancellable, callback, *user_data)
  call_take_ownership_finish (res)
  call_take_ownership_sync (arg_options, cancellable)
  call_unmount (arg_options, cancellable, callback, *user_data)
  call_unmount_finish (res)
  call_unmount_sync (arg_options, cancellable)
  complete_check (invocation, consistent)
  complete_mount (invocation, mount_path)
  complete_repair (invocation, repaired)
  complete_resize (invocation)
  complete_set_label (invocation)
  complete_take_ownership (invocation)
  complete_unmount (invocation)

Virtual Methods

  do_handle_check (invocation, arg_options)
  do_handle_mount (invocation, arg_options)
  do_handle_repair (invocation, arg_options)
  do_handle_resize (invocation, arg_size, arg_options)
  do_handle_set_label (invocation, arg_label, arg_options)
  do_handle_take_ownership (invocation, arg_options)
  do_handle_unmount (invocation, arg_options)

Properties

Name Type Flags Short Description
mount-points [str] r/w MountPoints
size int r/w Size

Signals

Name Short Description
handle-check Signal emitted when a remote caller is invoking the Check() D-Bus method.
handle-mount Signal emitted when a remote caller is invoking the Mount() D-Bus method.
handle-repair Signal emitted when a remote caller is invoking the Repair() D-Bus method.
handle-resize Signal emitted when a remote caller is invoking the Resize() D-Bus method.
handle-set-label Signal emitted when a remote caller is invoking the SetLabel() D-Bus method.
handle-take-ownership Signal emitted when a remote caller is invoking the TakeOwnership() D-Bus method.
handle-unmount Signal emitted when a remote caller is invoking the Unmount() D-Bus method.

Fields

None

Class Details

class UDisks.Filesystem
Bases:GObject.GInterface
Structure:UDisks.FilesystemIface

Abstract interface type for the D-Bus interface org.freedesktop.UDisks2.Filesystem.

classmethod interface_info()[source]
Returns:A Gio.DBusInterfaceInfo. Do not free.
Return type:Gio.DBusInterfaceInfo

Gets a machine-readable description of the org.freedesktop.UDisks2.Filesystem D-Bus interface.

classmethod override_properties(klass, property_id_begin)[source]
Parameters:
Returns:

The last property id.

Return type:

int

Overrides all GObject.Object properties in the UDisks.Filesystem interface for a concrete class. The properties are overridden in the order they are defined.

call_check(arg_options, cancellable, callback, *user_data)[source]
Parameters:

Asynchronously invokes the Check() D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.Filesystem.call_check_finish() to get the result of the operation.

See UDisks.Filesystem.call_check_sync() for the synchronous, blocking version of this method.

New in version 2.7.2.

call_check_finish(res)[source]
Parameters:res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.Filesystem.call_check().
Raises:GLib.Error
Returns:True if the call succeeded, False if error is set.
out_consistent:Return location for return parameter or None to ignore.
Return type:(bool, out_consistent: bool)

Finishes an operation started with UDisks.Filesystem.call_check().

New in version 2.7.2.

call_check_sync(arg_options, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

out_consistent:Return location for return parameter or None to ignore.

Return type:

(bool, out_consistent: bool)

Synchronously invokes the Check() D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.Filesystem.call_check() for the asynchronous version of this method.

New in version 2.7.2.

call_mount(arg_options, cancellable, callback, *user_data)[source]
Parameters:

Asynchronously invokes the Mount() D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.Filesystem.call_mount_finish() to get the result of the operation.

See UDisks.Filesystem.call_mount_sync() for the synchronous, blocking version of this method.

call_mount_finish(res)[source]
Parameters:res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.Filesystem.call_mount().
Raises:GLib.Error
Returns:True if the call succeeded, False if error is set.
out_mount_path:Return location for return parameter or None to ignore.
Return type:(bool, out_mount_path: str)

Finishes an operation started with UDisks.Filesystem.call_mount().

call_mount_sync(arg_options, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

out_mount_path:Return location for return parameter or None to ignore.

Return type:

(bool, out_mount_path: str)

Synchronously invokes the Mount() D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.Filesystem.call_mount() for the asynchronous version of this method.

call_repair(arg_options, cancellable, callback, *user_data)[source]
Parameters:

Asynchronously invokes the Repair() D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.Filesystem.call_repair_finish() to get the result of the operation.

See UDisks.Filesystem.call_repair_sync() for the synchronous, blocking version of this method.

New in version 2.7.2.

call_repair_finish(res)[source]
Parameters:res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.Filesystem.call_repair().
Raises:GLib.Error
Returns:True if the call succeeded, False if error is set.
out_repaired:Return location for return parameter or None to ignore.
Return type:(bool, out_repaired: bool)

Finishes an operation started with UDisks.Filesystem.call_repair().

New in version 2.7.2.

call_repair_sync(arg_options, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

out_repaired:Return location for return parameter or None to ignore.

Return type:

(bool, out_repaired: bool)

Synchronously invokes the Repair() D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.Filesystem.call_repair() for the asynchronous version of this method.

New in version 2.7.2.

call_resize(arg_size, arg_options, cancellable, callback, *user_data)[source]
Parameters:

Asynchronously invokes the Resize() D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.Filesystem.call_resize_finish() to get the result of the operation.

See UDisks.Filesystem.call_resize_sync() for the synchronous, blocking version of this method.

New in version 2.7.2.

call_resize_finish(res)[source]
Parameters:res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.Filesystem.call_resize().
Raises:GLib.Error
Returns:True if the call succeeded, False if error is set.
Return type:bool

Finishes an operation started with UDisks.Filesystem.call_resize().

New in version 2.7.2.

call_resize_sync(arg_size, arg_options, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the Resize() D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.Filesystem.call_resize() for the asynchronous version of this method.

New in version 2.7.2.

call_set_label(arg_label, arg_options, cancellable, callback, *user_data)[source]
Parameters:

Asynchronously invokes the SetLabel() D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.Filesystem.call_set_label_finish() to get the result of the operation.

See UDisks.Filesystem.call_set_label_sync() for the synchronous, blocking version of this method.

call_set_label_finish(res)[source]
Parameters:res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.Filesystem.call_set_label().
Raises:GLib.Error
Returns:True if the call succeeded, False if error is set.
Return type:bool

Finishes an operation started with UDisks.Filesystem.call_set_label().

call_set_label_sync(arg_label, arg_options, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the SetLabel() D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.Filesystem.call_set_label() for the asynchronous version of this method.

call_take_ownership(arg_options, cancellable, callback, *user_data)[source]
Parameters:

Asynchronously invokes the TakeOwnership() D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.Filesystem.call_take_ownership_finish() to get the result of the operation.

See UDisks.Filesystem.call_take_ownership_sync() for the synchronous, blocking version of this method.

New in version 2.7.2.

call_take_ownership_finish(res)[source]
Parameters:res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.Filesystem.call_take_ownership().
Raises:GLib.Error
Returns:True if the call succeeded, False if error is set.
Return type:bool

Finishes an operation started with UDisks.Filesystem.call_take_ownership().

New in version 2.7.2.

call_take_ownership_sync(arg_options, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the TakeOwnership() D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.Filesystem.call_take_ownership() for the asynchronous version of this method.

New in version 2.7.2.

call_unmount(arg_options, cancellable, callback, *user_data)[source]
Parameters:

Asynchronously invokes the Unmount() D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.Filesystem.call_unmount_finish() to get the result of the operation.

See UDisks.Filesystem.call_unmount_sync() for the synchronous, blocking version of this method.

call_unmount_finish(res)[source]
Parameters:res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.Filesystem.call_unmount().
Raises:GLib.Error
Returns:True if the call succeeded, False if error is set.
Return type:bool

Finishes an operation started with UDisks.Filesystem.call_unmount().

call_unmount_sync(arg_options, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the Unmount() D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.Filesystem.call_unmount() for the asynchronous version of this method.

complete_check(invocation, consistent)[source]
Parameters:

Helper function used in service implementations to finish handling invocations of the Check() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

New in version 2.7.2.

complete_mount(invocation, mount_path)[source]
Parameters:

Helper function used in service implementations to finish handling invocations of the Mount() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

complete_repair(invocation, repaired)[source]
Parameters:

Helper function used in service implementations to finish handling invocations of the Repair() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

New in version 2.7.2.

complete_resize(invocation)[source]
Parameters:invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the Resize() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

New in version 2.7.2.

complete_set_label(invocation)[source]
Parameters:invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the SetLabel() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

complete_take_ownership(invocation)[source]
Parameters:invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the TakeOwnership() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

New in version 2.7.2.

complete_unmount(invocation)[source]
Parameters:invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the Unmount() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

do_handle_check(invocation, arg_options) virtual
Parameters:
Return type:

bool

do_handle_mount(invocation, arg_options) virtual
Parameters:
Return type:

bool

do_handle_repair(invocation, arg_options) virtual
Parameters:
Return type:

bool

do_handle_resize(invocation, arg_size, arg_options) virtual
Parameters:
Return type:

bool

do_handle_set_label(invocation, arg_label, arg_options) virtual
Parameters:
Return type:

bool

do_handle_take_ownership(invocation, arg_options) virtual
Parameters:
Return type:

bool

do_handle_unmount(invocation, arg_options) virtual
Parameters:
Return type:

bool

Signal Details

UDisks.Filesystem.signals.handle_check(filesystem, invocation, arg_options)
Signal Name:

handle-check

Flags:

RUN_LAST

Parameters:
Returns:

True if the invocation was handled, False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the Check() D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.Filesystem.complete_check() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

New in version 2.7.2.

UDisks.Filesystem.signals.handle_mount(filesystem, invocation, arg_options)
Signal Name:

handle-mount

Flags:

RUN_LAST

Parameters:
Returns:

True if the invocation was handled, False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the Mount() D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.Filesystem.complete_mount() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

UDisks.Filesystem.signals.handle_repair(filesystem, invocation, arg_options)
Signal Name:

handle-repair

Flags:

RUN_LAST

Parameters:
Returns:

True if the invocation was handled, False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the Repair() D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.Filesystem.complete_repair() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

New in version 2.7.2.

UDisks.Filesystem.signals.handle_resize(filesystem, invocation, arg_size, arg_options)
Signal Name:

handle-resize

Flags:

RUN_LAST

Parameters:
Returns:

True if the invocation was handled, False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the Resize() D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.Filesystem.complete_resize() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

New in version 2.7.2.

UDisks.Filesystem.signals.handle_set_label(filesystem, invocation, arg_label, arg_options)
Signal Name:

handle-set-label

Flags:

RUN_LAST

Parameters:
Returns:

True if the invocation was handled, False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the SetLabel() D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.Filesystem.complete_set_label() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

UDisks.Filesystem.signals.handle_take_ownership(filesystem, invocation, arg_options)
Signal Name:

handle-take-ownership

Flags:

RUN_LAST

Parameters:
Returns:

True if the invocation was handled, False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the TakeOwnership() D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.Filesystem.complete_take_ownership() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

New in version 2.7.2.

UDisks.Filesystem.signals.handle_unmount(filesystem, invocation, arg_options)
Signal Name:

handle-unmount

Flags:

RUN_LAST

Parameters:
Returns:

True if the invocation was handled, False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the Unmount() D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.Filesystem.complete_unmount() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

Property Details

UDisks.Filesystem.props.mount_points
Name:mount-points
Type:[str]
Default Value:[]
Flags:READABLE, WRITABLE

Represents the D-Bus property “MountPoints”.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

UDisks.Filesystem.props.size
Name:size
Type:int
Default Value:0
Flags:READABLE, WRITABLE

Represents the D-Bus property “Size”.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.