Goa.OAuthBased

Implementations:

Goa.OAuthBasedProxy, Goa.OAuthBasedSkeleton

Methods

class	interface_info ()
class	override_properties (klass, property_id_begin)
	call_get_access_token (cancellable, callback, *user_data)
	call_get_access_token_finish (res)
	call_get_access_token_sync (cancellable)
	complete_get_access_token (invocation, access_token, access_token_secret, expires_in)

Virtual Methods

do_handle_get_access_token (invocation)

Properties

Name	Type	Flags	Short Description
consumer-key	str	r/w	ConsumerKey
consumer-secret	str	r/w	ConsumerSecret

Signals

Name	Short Description
handle-get-access-token	Signal emitted when a remote caller is invoking the ‘GetAccessToken() [gdbus-method-org-gnome-OnlineAccounts-OAuthBased.GetAccessToken]’ D-Bus method.

Fields

None

Class Details

class Goa.OAuthBased

Bases:

GObject.GInterface

Structure:

Goa.OAuthBasedIface

Abstract interface type for the D-Bus interface ‘org.gnome.OnlineAccounts.OAuthBased [gdbus-interface-org-gnome-OnlineAccounts-OAuthBased.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.OAuthBased [gdbus-interface-org-gnome-OnlineAccounts-OAuthBased.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.OAuthBased interface for a concrete class. The properties are overridden in the order they are defined.

call_get_access_token(cancellable, callback, *user_data)

Parameters:

• 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 ‘GetAccessToken() [gdbus-method-org-gnome-OnlineAccounts-OAuthBased.GetAccessToken]’ 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.OAuthBased.call_get_access_token_finish() to get the result of the operation.

See Goa.OAuthBased.call_get_access_token_sync() for the synchronous, blocking version of this method.

call_get_access_token_finish(res)

Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Goa.OAuthBased.call_get_access_token().

Raises:

GLib.Error

Returns:

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

out_access_token:

Return location for return parameter or None to ignore.

out_access_token_secret:

Return location for return parameter or None to ignore.

out_expires_in:

Return location for return parameter or None to ignore.

Return type:

(bool, out_access_token: str, out_access_token_secret: str, out_expires_in: int)

Finishes an operation started with Goa.OAuthBased.call_get_access_token().

call_get_access_token_sync(cancellable)

Parameters:

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_access_token:

Return location for return parameter or None to ignore.

out_access_token_secret:

Return location for return parameter or None to ignore.

out_expires_in:

Return location for return parameter or None to ignore.

Return type:

(bool, out_access_token: str, out_access_token_secret: str, out_expires_in: int)

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

See Goa.OAuthBased.call_get_access_token() for the asynchronous version of this method.

complete_get_access_token(invocation, access_token, access_token_secret, expires_in)

Parameters:

• invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

• access_token (str) – Parameter to return.

• access_token_secret (str) – Parameter to return.

• expires_in (int) – Parameter to return.

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

Parameters:

invocation (Gio.DBusMethodInvocation) –

Return type:

bool

Handler for the Goa.OAuthBased ::handle-get-access-token signal.

Signal Details

Goa.OAuthBased.signals.handle_get_access_token(o_auth_based, invocation)

Signal Name:

handle-get-access-token

Flags:

RUN_LAST

Parameters:

• o_auth_based (Goa.OAuthBased) – The object which received the signal

• invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

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 ‘GetAccessToken() [gdbus-method-org-gnome-OnlineAccounts-OAuthBased.GetAccessToken]’ 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.OAuthBased.complete_get_access_token() 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.

Property Details

Goa.OAuthBased.props.consumer_key

Name:

consumer-key

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

Represents the D-Bus property ‘“ConsumerKey” [gdbus-property-org-gnome-OnlineAccounts-OAuthBased.ConsumerKey]’.

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.

Goa.OAuthBased.props.consumer_secret

Name:

consumer-secret

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

Represents the D-Bus property ‘“ConsumerSecret” [gdbus-property-org-gnome-OnlineAccounts-OAuthBased.ConsumerSecret]’.

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.