Goa.PasswordBased¶

Implementations:: Goa.PasswordBasedProxy, Goa.PasswordBasedSkeleton

Methods¶

class	`interface_info` ()
class	`override_properties` (klass, property_id_begin)
	`call_get_password` (arg_id, cancellable, callback, *user_data)
	`call_get_password_finish` (res)
	`call_get_password_sync` (arg_id, cancellable)
	`complete_get_password` (invocation, password)

Virtual Methods¶

do_handle_get_password (invocation, arg_id)

Properties¶

None

Signals¶

Name	Short Description
`handle-get-password`	Signal emitted when a remote caller is invoking the ‘GetPassword() [gdbus-method-org-gnome-OnlineAccounts-PasswordBased.GetPassword]’ D-Bus method.

Fields¶

None

Class Details¶

class Goa.PasswordBased¶

Bases:: GObject.GInterface
Structure:: Goa.PasswordBasedIface

Abstract interface type for the D-Bus interface ‘org.gnome.OnlineAccounts.PasswordBased [gdbus-interface-org-gnome-OnlineAccounts-PasswordBased.top_of_page]’.

New in version 3.6.0.

classmethod interface_info()¶

Returns:: A Gio.DBusInterfaceInfo. Do not free.
Return type:: Gio.DBusInterfaceInfo

Gets a machine-readable description of the ‘org.gnome.OnlineAccounts.PasswordBased [gdbus-interface-org-gnome-OnlineAccounts-PasswordBased.top_of_page]’ D-Bus interface.

New in version 3.6.0.

classmethod override_properties(klass, property_id_begin)¶

Parameters:

klass (GObject.ObjectClass) – The class structure for a GObject.Object derived class.
property_id_begin (int) – The property id to assign to the first overridden property.

Returns:

The last property id.

Return type:

int

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

New in version 3.6.0.

call_get_password(arg_id, cancellable, callback, *user_data)¶

Parameters:

arg_id (str) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘GetPassword() [gdbus-method-org-gnome-OnlineAccounts-PasswordBased.GetPassword]’ 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 Goa.PasswordBased.call_get_password_finish() to get the result of the operation.

See Goa.PasswordBased.call_get_password_sync() for the synchronous, blocking version of this method.

New in version 3.6.0.

call_get_password_finish(res)¶

Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Goa.PasswordBased.call_get_password().

Raises:

GLib.Error

Returns:

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

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

Return type:

(bool, out_password: str)

Finishes an operation started with Goa.PasswordBased.call_get_password().

New in version 3.6.0.

call_get_password_sync(arg_id, cancellable)¶

Parameters:

arg_id (str) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

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

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

Return type:

(bool, out_password: str)

Synchronously invokes the ‘GetPassword() [gdbus-method-org-gnome-OnlineAccounts-PasswordBased.GetPassword]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See Goa.PasswordBased.call_get_password() for the asynchronous version of this method.

New in version 3.6.0.

complete_get_password(invocation, password)¶

Parameters:

invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
password (str) – Parameter to return.

Helper function used in service implementations to finish handling invocations of the ‘GetPassword() [gdbus-method-org-gnome-OnlineAccounts-PasswordBased.GetPassword]’ 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 3.6.0.

do_handle_get_password(invocation, arg_id) virtual¶

Parameters:

invocation (Gio.DBusMethodInvocation) –
arg_id (str) –

Return type:

bool

Handler for the Goa.PasswordBased ::handle-get-password signal.

Signal Details¶

Goa.PasswordBased.signals.handle_get_password(password_based, invocation, arg_id)¶

Signal Name:

handle-get-password

Flags:

RUN_LAST

Parameters:

password_based (Goa.PasswordBased) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
arg_id (str) – Argument passed by remote caller.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘GetPassword() [gdbus-method-org-gnome-OnlineAccounts-PasswordBased.GetPassword]’ 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 Goa.PasswordBased.complete_get_password() 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, the Gio.DBusError.UNKNOWN_METHOD error is returned.

New in version 3.6.0.