### Interface

# Goa OAuth2Based

#### Description [src]

    interface Goa.OAuth2Based : GObject.Object

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

#### Prerequisite

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

#### Implementations

- GoaOAuth2BasedProxy
- GoaOAuth2BasedSkeleton

#### Functions

###### goa_oauth2_based_interface_info

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

###### goa_oauth2_based_override_properties

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

#### Instance methods

###### goa_oauth2_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_oauth2_based_call_get_access_token_finish()` to get the result of the operation.

###### goa_oauth2_based_call_get_access_token_finish

Finishes an operation started with goa_oauth2_based_call_get_access_token().

###### goa_oauth2_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_oauth2_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_oauth2_based_dup_client_id

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

###### goa_oauth2_based_dup_client_secret

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

###### goa_oauth2_based_get_client_id

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

###### goa_oauth2_based_get_client_secret

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

###### goa_oauth2_based_set_client_id

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

###### goa_oauth2_based_set_client_secret

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

#### Properties

###### Goa.OAuth2Based:client-id

Represents the D-Bus property “ClientId”.

###### Goa.OAuth2Based:client-secret

Represents the D-Bus property “ClientSecret”.

#### Signals

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

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

#### Interface structure

    struct GoaOAuth2BasedIface {
      GTypeInterface parent_iface;
      gboolean (* handle_get_access_token) (
        GoaOAuth2Based* object,
        GDBusMethodInvocation* invocation
      );
      const gchar* (* get_client_id) (
        GoaOAuth2Based* object
      );
      const gchar* (* get_client_secret) (
        GoaOAuth2Based* object
      );

    }

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

###### Interface members

`parent_iface` |
    GTypeInterface
| The parent interface.
`handle_get_access_token` |
    gboolean (* handle_get_access_token) (
        GoaOAuth2Based* object,
        GDBusMethodInvocation* invocation
      )
| Handler for the `GoaOAuth2Based::handle-get-access-token` signal.
`get_client_id` |
    const gchar* (* get_client_id) (
        GoaOAuth2Based* object
      )
| Getter for the `GoaOAuth2Based:client-id` property.
`get_client_secret` |
    const gchar* (* get_client_secret) (
        GoaOAuth2Based* object
      )
| Getter for the `GoaOAuth2Based:client-secret` property.

#### Virtual methods

###### Goa.OAuth2Based.get_client_id

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

###### Goa.OAuth2Based.get_client_secret

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

###### Goa.OAuth2Based.handle_get_access_token

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