### Interface

# Goa OAuthBased

#### Description [src]

    interface Goa.OAuthBased : GObject.Object

Abstract interface type for the D-Bus interface org.gnome.OnlineAccounts.OAuthBased.

#### Prerequisite

In order to implement OAuthBased, your type must inherit from`GObject`.

#### Implementations

- GoaOAuthBasedProxy
- GoaOAuthBasedSkeleton

#### Functions

###### goa_oauth_based_interface_info

Gets a machine-readable description of the org.gnome.OnlineAccounts.OAuthBased D-Bus interface.

###### goa_oauth_based_override_properties

Overrides all `GObject` properties in the `GoaOAuthBased` interface for a concrete class. The properties are overridden in the order they are defined.

#### Instance methods

###### goa_oauth_based_call_get_access_token

Asynchronously invokes the GetAccessToken() D-Bus method on `proxy`. 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 g_main_context_push_thread_default()). You can then call `goa_oauth_based_call_get_access_token_finish()` to get the result of the operation.

###### goa_oauth_based_call_get_access_token_finish

Finishes an operation started with goa_oauth_based_call_get_access_token().

###### goa_oauth_based_call_get_access_token_sync

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

###### goa_oauth_based_complete_get_access_token

Helper function used in service implementations to finish handling invocations of the 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.

###### goa_oauth_based_dup_consumer_key

Gets a copy of the “ConsumerKey” D-Bus property.

###### goa_oauth_based_dup_consumer_secret

Gets a copy of the “ConsumerSecret” D-Bus property.

###### goa_oauth_based_get_consumer_key

Gets the value of the “ConsumerKey” D-Bus property.

###### goa_oauth_based_get_consumer_secret

Gets the value of the “ConsumerSecret” D-Bus property.

###### goa_oauth_based_set_consumer_key

Sets the “ConsumerKey” D-Bus property to `value`.

###### goa_oauth_based_set_consumer_secret

Sets the “ConsumerSecret” D-Bus property to `value`.

#### Properties

###### Goa.OAuthBased:consumer-key

Represents the D-Bus property “ConsumerKey”.

###### Goa.OAuthBased:consumer-secret

Represents the D-Bus property “ConsumerSecret”.

#### Signals

###### Goa.OAuthBased::handle-get-access-token

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

#### Interface structure

    struct GoaOAuthBasedIface {
      GTypeInterface parent_iface;
      gboolean (* handle_get_access_token) (
        GoaOAuthBased* object,
        GDBusMethodInvocation* invocation
      );
      const gchar* (* get_consumer_key) (
        GoaOAuthBased* object
      );
      const gchar* (* get_consumer_secret) (
        GoaOAuthBased* object
      );

    }

Virtual table for the D-Bus interface org.gnome.OnlineAccounts.OAuthBased.

###### Interface members

`parent_iface` |
    GTypeInterface
| The parent interface.
`handle_get_access_token` |
    gboolean (* handle_get_access_token) (
        GoaOAuthBased* object,
        GDBusMethodInvocation* invocation
      )
| Handler for the `GoaOAuthBased::handle-get-access-token` signal.
`get_consumer_key` |
    const gchar* (* get_consumer_key) (
        GoaOAuthBased* object
      )
| Getter for the `GoaOAuthBased:consumer-key` property.
`get_consumer_secret` |
    const gchar* (* get_consumer_secret) (
        GoaOAuthBased* object
      )
| Getter for the `GoaOAuthBased:consumer-secret` property.

#### Virtual methods

###### Goa.OAuthBased.get_consumer_key

Gets the value of the “ConsumerKey” D-Bus property.

###### Goa.OAuthBased.get_consumer_secret

Gets the value of the “ConsumerSecret” D-Bus property.

###### Goa.OAuthBased.handle_get_access_token

Handler for the `GoaOAuthBased::handle-get-access-token` signal.