UDisks.Encrypted¶
- Implementations:
Methods¶
class |
|
class |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
|
|
|
|
|
|
|
Properties¶
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r/w |
ChildConfiguration |
||
r/w |
CleartextDevice |
||
r/w |
HintEncryptionType |
||
r/w |
MetadataSize |
Signals¶
Name |
Short Description |
---|---|
Signal emitted when a remote caller is invoking the ChangePassphrase() D-Bus method. |
|
Signal emitted when a remote caller is invoking the Lock() D-Bus method. |
|
Signal emitted when a remote caller is invoking the Resize() D-Bus method. |
|
Signal emitted when a remote caller is invoking the Unlock() D-Bus method. |
Fields¶
None
Class Details¶
- class UDisks.Encrypted¶
- Bases:
- Structure:
Abstract interface type for the D-Bus interface org.freedesktop.UDisks2.Encrypted.
- classmethod interface_info()¶
- Returns:
A
Gio.DBusInterfaceInfo
. Do not free.- Return type:
Gets a machine-readable description of the org.freedesktop.UDisks2.Encrypted D-Bus interface.
- classmethod override_properties(klass, property_id_begin)¶
- Parameters:
klass (
GObject.ObjectClass
) – The class structure for aGObject.Object
derived class.property_id_begin (
int
) – The property id to assign to the first overridden property.
- Returns:
The last property id.
- Return type:
Overrides all
GObject.Object
properties in theUDisks.Encrypted
interface for a concrete class. The properties are overridden in the order they are defined.
- call_change_passphrase(arg_passphrase, arg_new_passphrase, arg_options, cancellable, callback, *user_data)¶
- Parameters:
arg_passphrase (
str
) – Argument to pass with the method invocation.arg_new_passphrase (
str
) – Argument to pass with the method invocation.arg_options (
GLib.Variant
) – Argument to pass with the method invocation.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.callback (
Gio.AsyncReadyCallback
orNone
) – AGio.AsyncReadyCallback
to call when the request is satisfied orNone
.
Asynchronously invokes the ChangePassphrase() 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 callUDisks.Encrypted.call_change_passphrase_finish
() to get the result of the operation.See
UDisks.Encrypted.call_change_passphrase_sync
() for the synchronous, blocking version of this method.
- call_change_passphrase_finish(res)¶
- Parameters:
res (
Gio.AsyncResult
) – TheGio.AsyncResult
obtained from theGio.AsyncReadyCallback
passed toUDisks.Encrypted.call_change_passphrase
().- Raises:
- Returns:
- Return type:
Finishes an operation started with
UDisks.Encrypted.call_change_passphrase
().
- call_change_passphrase_sync(arg_passphrase, arg_new_passphrase, arg_options, cancellable)¶
- Parameters:
arg_passphrase (
str
) – Argument to pass with the method invocation.arg_new_passphrase (
str
) – Argument to pass with the method invocation.arg_options (
GLib.Variant
) – Argument to pass with the method invocation.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.
- Raises:
- Returns:
- Return type:
Synchronously invokes the ChangePassphrase() D-Bus method on self. The calling thread is blocked until a reply is received.
See
UDisks.Encrypted.call_change_passphrase
() for the asynchronous version of this method.
- call_lock(arg_options, cancellable, callback, *user_data)¶
- Parameters:
arg_options (
GLib.Variant
) – Argument to pass with the method invocation.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.callback (
Gio.AsyncReadyCallback
orNone
) – AGio.AsyncReadyCallback
to call when the request is satisfied orNone
.
Asynchronously invokes the Lock() 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 callUDisks.Encrypted.call_lock_finish
() to get the result of the operation.See
UDisks.Encrypted.call_lock_sync
() for the synchronous, blocking version of this method.
- call_lock_finish(res)¶
- Parameters:
res (
Gio.AsyncResult
) – TheGio.AsyncResult
obtained from theGio.AsyncReadyCallback
passed toUDisks.Encrypted.call_lock
().- Raises:
- Returns:
- Return type:
Finishes an operation started with
UDisks.Encrypted.call_lock
().
- call_lock_sync(arg_options, cancellable)¶
- Parameters:
arg_options (
GLib.Variant
) – Argument to pass with the method invocation.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.
- Raises:
- Returns:
- Return type:
Synchronously invokes the Lock() D-Bus method on self. The calling thread is blocked until a reply is received.
See
UDisks.Encrypted.call_lock
() for the asynchronous version of this method.
- call_resize(arg_size, arg_options, cancellable, callback, *user_data)¶
- Parameters:
arg_size (
int
) – Argument to pass with the method invocation.arg_options (
GLib.Variant
) – Argument to pass with the method invocation.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.callback (
Gio.AsyncReadyCallback
orNone
) – AGio.AsyncReadyCallback
to call when the request is satisfied orNone
.
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 callUDisks.Encrypted.call_resize_finish
() to get the result of the operation.See
UDisks.Encrypted.call_resize_sync
() for the synchronous, blocking version of this method.New in version 2.8.0.
- call_resize_finish(res)¶
- Parameters:
res (
Gio.AsyncResult
) – TheGio.AsyncResult
obtained from theGio.AsyncReadyCallback
passed toUDisks.Encrypted.call_resize
().- Raises:
- Returns:
- Return type:
Finishes an operation started with
UDisks.Encrypted.call_resize
().New in version 2.8.0.
- call_resize_sync(arg_size, arg_options, cancellable)¶
- Parameters:
arg_size (
int
) – Argument to pass with the method invocation.arg_options (
GLib.Variant
) – Argument to pass with the method invocation.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.
- Raises:
- Returns:
- Return type:
Synchronously invokes the Resize() D-Bus method on self. The calling thread is blocked until a reply is received.
See
UDisks.Encrypted.call_resize
() for the asynchronous version of this method.New in version 2.8.0.
- call_unlock(arg_passphrase, arg_options, cancellable, callback, *user_data)¶
- Parameters:
arg_passphrase (
str
) – Argument to pass with the method invocation.arg_options (
GLib.Variant
) – Argument to pass with the method invocation.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.callback (
Gio.AsyncReadyCallback
orNone
) – AGio.AsyncReadyCallback
to call when the request is satisfied orNone
.
Asynchronously invokes the Unlock() 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 callUDisks.Encrypted.call_unlock_finish
() to get the result of the operation.See
UDisks.Encrypted.call_unlock_sync
() for the synchronous, blocking version of this method.
- call_unlock_finish(res)¶
- Parameters:
res (
Gio.AsyncResult
) – TheGio.AsyncResult
obtained from theGio.AsyncReadyCallback
passed toUDisks.Encrypted.call_unlock
().- Raises:
- Returns:
True
if the call succeeded,False
if error is set.- out_cleartext_device:
Return location for return parameter or
None
to ignore.
- Return type:
Finishes an operation started with
UDisks.Encrypted.call_unlock
().
- call_unlock_sync(arg_passphrase, arg_options, cancellable)¶
- Parameters:
arg_passphrase (
str
) – Argument to pass with the method invocation.arg_options (
GLib.Variant
) – Argument to pass with the method invocation.cancellable (
Gio.Cancellable
orNone
) – AGio.Cancellable
orNone
.
- Raises:
- Returns:
True
if the call succeeded,False
if error is set.- out_cleartext_device:
Return location for return parameter or
None
to ignore.
- Return type:
Synchronously invokes the Unlock() D-Bus method on self. The calling thread is blocked until a reply is received.
See
UDisks.Encrypted.call_unlock
() for the asynchronous version of this method.
- complete_change_passphrase(invocation)¶
- Parameters:
invocation (
Gio.DBusMethodInvocation
) – AGio.DBusMethodInvocation
.
Helper function used in service implementations to finish handling invocations of the ChangePassphrase() 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_lock(invocation)¶
- Parameters:
invocation (
Gio.DBusMethodInvocation
) – AGio.DBusMethodInvocation
.
Helper function used in service implementations to finish handling invocations of the Lock() 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_resize(invocation)¶
- Parameters:
invocation (
Gio.DBusMethodInvocation
) – AGio.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.8.0.
- complete_unlock(invocation, cleartext_device)¶
- Parameters:
invocation (
Gio.DBusMethodInvocation
) – AGio.DBusMethodInvocation
.cleartext_device (
str
) – Parameter to return.
Helper function used in service implementations to finish handling invocations of the Unlock() 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_change_passphrase(invocation, arg_passphrase, arg_new_passphrase, arg_options) virtual¶
- Parameters:
invocation (
Gio.DBusMethodInvocation
) –arg_passphrase (
str
) –arg_new_passphrase (
str
) –arg_options (
GLib.Variant
) –
- Return type:
Handler for the
UDisks.Encrypted
::handle-change-passphrase
signal.
- do_handle_lock(invocation, arg_options) virtual¶
- Parameters:
invocation (
Gio.DBusMethodInvocation
) –arg_options (
GLib.Variant
) –
- Return type:
Handler for the
UDisks.Encrypted
::handle-lock
signal.
- do_handle_resize(invocation, arg_size, arg_options) virtual¶
- Parameters:
invocation (
Gio.DBusMethodInvocation
) –arg_size (
int
) –arg_options (
GLib.Variant
) –
- Return type:
Handler for the
UDisks.Encrypted
::handle-resize
signal.
- do_handle_unlock(invocation, arg_passphrase, arg_options) virtual¶
- Parameters:
invocation (
Gio.DBusMethodInvocation
) –arg_passphrase (
str
) –arg_options (
GLib.Variant
) –
- Return type:
Handler for the
UDisks.Encrypted
::handle-unlock
signal.
Signal Details¶
- UDisks.Encrypted.signals.handle_change_passphrase(encrypted, invocation, arg_passphrase, arg_new_passphrase, arg_options)¶
- Signal Name:
handle-change-passphrase
- Flags:
- Parameters:
encrypted (
UDisks.Encrypted
) – The object which received the signalinvocation (
Gio.DBusMethodInvocation
) – AGio.DBusMethodInvocation
.arg_passphrase (
str
) – Argument passed by remote caller.arg_new_passphrase (
str
) – Argument passed by remote caller.arg_options (
GLib.Variant
) – Argument passed by remote caller.
- Returns:
Gio.DBUS_METHOD_INVOCATION_HANDLED
orTrue
if the invocation was handled,Gio.DBUS_METHOD_INVOCATION_UNHANDLED
orFalse
to let other signal handlers run.- Return type:
Signal emitted when a remote caller is invoking the ChangePassphrase() 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 callUDisks.Encrypted.complete_change_passphrase
() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, theGio.DBusError.UNKNOWN_METHOD
error is returned.
- UDisks.Encrypted.signals.handle_lock(encrypted, invocation, arg_options)¶
- Signal Name:
handle-lock
- Flags:
- Parameters:
encrypted (
UDisks.Encrypted
) – The object which received the signalinvocation (
Gio.DBusMethodInvocation
) – AGio.DBusMethodInvocation
.arg_options (
GLib.Variant
) – Argument passed by remote caller.
- Returns:
Gio.DBUS_METHOD_INVOCATION_HANDLED
orTrue
if the invocation was handled,Gio.DBUS_METHOD_INVOCATION_UNHANDLED
orFalse
to let other signal handlers run.- Return type:
Signal emitted when a remote caller is invoking the Lock() 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 callUDisks.Encrypted.complete_lock
() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, theGio.DBusError.UNKNOWN_METHOD
error is returned.
- UDisks.Encrypted.signals.handle_resize(encrypted, invocation, arg_size, arg_options)¶
- Signal Name:
handle-resize
- Flags:
- Parameters:
encrypted (
UDisks.Encrypted
) – The object which received the signalinvocation (
Gio.DBusMethodInvocation
) – AGio.DBusMethodInvocation
.arg_size (
int
) – Argument passed by remote caller.arg_options (
GLib.Variant
) – Argument passed by remote caller.
- Returns:
Gio.DBUS_METHOD_INVOCATION_HANDLED
orTrue
if the invocation was handled,Gio.DBUS_METHOD_INVOCATION_UNHANDLED
orFalse
to let other signal handlers run.- Return type:
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 callUDisks.Encrypted.complete_resize
() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, theGio.DBusError.UNKNOWN_METHOD
error is returned.New in version 2.8.0.
- UDisks.Encrypted.signals.handle_unlock(encrypted, invocation, arg_passphrase, arg_options)¶
- Signal Name:
handle-unlock
- Flags:
- Parameters:
encrypted (
UDisks.Encrypted
) – The object which received the signalinvocation (
Gio.DBusMethodInvocation
) – AGio.DBusMethodInvocation
.arg_passphrase (
str
) – Argument passed by remote caller.arg_options (
GLib.Variant
) – Argument passed by remote caller.
- Returns:
Gio.DBUS_METHOD_INVOCATION_HANDLED
orTrue
if the invocation was handled,Gio.DBUS_METHOD_INVOCATION_UNHANDLED
orFalse
to let other signal handlers run.- Return type:
Signal emitted when a remote caller is invoking the Unlock() 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 callUDisks.Encrypted.complete_unlock
() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, theGio.DBusError.UNKNOWN_METHOD
error is returned.
Property Details¶
- UDisks.Encrypted.props.child_configuration¶
- Name:
child-configuration
- Type:
- Default Value:
- Flags:
Represents the D-Bus property “ChildConfiguration”.
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.Encrypted.props.cleartext_device¶
-
Represents the D-Bus property “CleartextDevice”.
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.Encrypted.props.hint_encryption_type¶
-
Represents the D-Bus property “HintEncryptionType”.
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.Encrypted.props.metadata_size¶
-
Represents the D-Bus property “MetadataSize”.
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.