Goa.Manager¶

Implementations:: Goa.ManagerProxy, Goa.ManagerSkeleton

Methods¶

class	`interface_info` ()
class	`override_properties` (klass, property_id_begin)
	`call_add_account` (arg_provider, arg_identity, arg_presentation_identity, arg_credentials, arg_details, cancellable, callback, *user_data)
	`call_add_account_finish` (res)
	`call_add_account_sync` (arg_provider, arg_identity, arg_presentation_identity, arg_credentials, arg_details, cancellable)
	`call_is_supported_provider` (arg_provider_type, cancellable, callback, *user_data)
	`call_is_supported_provider_finish` (res)
	`call_is_supported_provider_sync` (arg_provider_type, cancellable)
	`complete_add_account` (invocation, account_object_path)
	`complete_is_supported_provider` (invocation, is_supported)

Virtual Methods¶

	`do_handle_add_account` (invocation, arg_provider, arg_identity, arg_presentation_identity, arg_credentials, arg_details)
	`do_handle_is_supported_provider` (invocation, arg_provider_type)

Properties¶

None

Signals¶

Name	Short Description
`handle-add-account`	Signal emitted when a remote caller is invoking the ‘AddAccount() [gdbus-method-org-gnome-OnlineAccounts-Manager.AddAccount]’ D-Bus method.
`handle-is-supported-provider`	Signal emitted when a remote caller is invoking the ‘IsSupportedProvider() [gdbus-method-org-gnome-OnlineAccounts-Manager.IsSupportedProvider]’ D-Bus method.

Fields¶

None

Class Details¶

class Goa.Manager¶

Bases:: GObject.GInterface
Structure:: Goa.ManagerIface

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

classmethod interface_info()¶

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

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

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.Manager interface for a concrete class. The properties are overridden in the order they are defined.

call_add_account(arg_provider, arg_identity, arg_presentation_identity, arg_credentials, arg_details, cancellable, callback, *user_data)¶

Parameters:

arg_provider (str) – Argument to pass with the method invocation.
arg_identity (str) – Argument to pass with the method invocation.
arg_presentation_identity (str) – Argument to pass with the method invocation.
arg_credentials (GLib.Variant) – Argument to pass with the method invocation.
arg_details (GLib.Variant) – 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 ‘AddAccount() [gdbus-method-org-gnome-OnlineAccounts-Manager.AddAccount]’ 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.Manager.call_add_account_finish() to get the result of the operation.

See Goa.Manager.call_add_account_sync() for the synchronous, blocking version of this method.

call_add_account_finish(res)¶

Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Goa.Manager.call_add_account().

Raises:

GLib.Error

Returns:

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

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

Return type:

(bool, out_account_object_path: str)

Finishes an operation started with Goa.Manager.call_add_account().

call_add_account_sync(arg_provider, arg_identity, arg_presentation_identity, arg_credentials, arg_details, cancellable)¶

Parameters:

arg_provider (str) – Argument to pass with the method invocation.
arg_identity (str) – Argument to pass with the method invocation.
arg_presentation_identity (str) – Argument to pass with the method invocation.
arg_credentials (GLib.Variant) – Argument to pass with the method invocation.
arg_details (GLib.Variant) – 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_account_object_path:: Return location for return parameter or None to ignore.

Return type:

(bool, out_account_object_path: str)

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

See Goa.Manager.call_add_account() for the asynchronous version of this method.

call_is_supported_provider(arg_provider_type, cancellable, callback, *user_data)¶

Parameters:

arg_provider_type (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 ‘IsSupportedProvider() [gdbus-method-org-gnome-OnlineAccounts-Manager.IsSupportedProvider]’ 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.Manager.call_is_supported_provider_finish() to get the result of the operation.

See Goa.Manager.call_is_supported_provider_sync() for the synchronous, blocking version of this method.

call_is_supported_provider_finish(res)¶

Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Goa.Manager.call_is_supported_provider().

Raises:

GLib.Error

Returns:

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

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

Return type:

(bool, out_is_supported: bool)

Finishes an operation started with Goa.Manager.call_is_supported_provider().

call_is_supported_provider_sync(arg_provider_type, cancellable)¶

Parameters:

arg_provider_type (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_is_supported:: Return location for return parameter or None to ignore.

Return type:

(bool, out_is_supported: bool)

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

See Goa.Manager.call_is_supported_provider() for the asynchronous version of this method.

complete_add_account(invocation, account_object_path)¶

Parameters:

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

Helper function used in service implementations to finish handling invocations of the ‘AddAccount() [gdbus-method-org-gnome-OnlineAccounts-Manager.AddAccount]’ 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_is_supported_provider(invocation, is_supported)¶

Parameters:

invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
is_supported (bool) – Parameter to return.

Helper function used in service implementations to finish handling invocations of the ‘IsSupportedProvider() [gdbus-method-org-gnome-OnlineAccounts-Manager.IsSupportedProvider]’ 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_add_account(invocation, arg_provider, arg_identity, arg_presentation_identity, arg_credentials, arg_details) virtual¶

Parameters:

invocation (Gio.DBusMethodInvocation) –
arg_provider (str) –
arg_identity (str) –
arg_presentation_identity (str) –
arg_credentials (GLib.Variant) –
arg_details (GLib.Variant) –

Return type:

bool

do_handle_is_supported_provider(invocation, arg_provider_type) virtual¶

Parameters:

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

Return type:

bool

Signal Details¶

Goa.Manager.signals.handle_add_account(manager, invocation, arg_provider, arg_identity, arg_presentation_identity, arg_credentials, arg_details)¶

Signal Name:

handle-add-account

Flags:

RUN_LAST

Parameters:

manager (Goa.Manager) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
arg_provider (str) – Argument passed by remote caller.
arg_identity (str) – Argument passed by remote caller.
arg_presentation_identity (str) – Argument passed by remote caller.
arg_credentials (GLib.Variant) – Argument passed by remote caller.
arg_details (GLib.Variant) – 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 ‘AddAccount() [gdbus-method-org-gnome-OnlineAccounts-Manager.AddAccount]’ 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.Manager.complete_add_account() 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.

Goa.Manager.signals.handle_is_supported_provider(manager, invocation, arg_provider_type)¶

Signal Name:

handle-is-supported-provider

Flags:

RUN_LAST

Parameters:

manager (Goa.Manager) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
arg_provider_type (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 ‘IsSupportedProvider() [gdbus-method-org-gnome-OnlineAccounts-Manager.IsSupportedProvider]’ 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.Manager.complete_is_supported_provider() 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.