|  |  |  | GNOME Online Accounts Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Prerequisites | Properties | Signals | ||||
| GoaOAuth2BasedGoaOAuth2Based — Generated C code for the org.gnome.OnlineAccounts.OAuth2Based D-Bus interface | 
GoaOAuth2Based; struct GoaOAuth2BasedIface; GDBusInterfaceInfo * goa_oauth2_based_interface_info (void); guint goa_oauth2_based_override_properties (GObjectClass *klass,guint property_id_begin); const gchar * goa_oauth2_based_get_client_id (GoaOAuth2Based *object); void goa_oauth2_based_set_client_id (GoaOAuth2Based *object,const gchar *value); gchar * goa_oauth2_based_dup_client_id (GoaOAuth2Based *object); const gchar * goa_oauth2_based_get_client_secret (GoaOAuth2Based *object); void goa_oauth2_based_set_client_secret (GoaOAuth2Based *object,const gchar *value); gchar * goa_oauth2_based_dup_client_secret (GoaOAuth2Based *object); void goa_oauth2_based_call_get_access_token (GoaOAuth2Based *proxy,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); gboolean goa_oauth2_based_call_get_access_token_finish (GoaOAuth2Based *proxy,gchar **out_access_token,gint *out_expires_in,GAsyncResult *res,GError **error); gboolean goa_oauth2_based_call_get_access_token_sync (GoaOAuth2Based *proxy,gchar **out_access_token,gint *out_expires_in,GCancellable *cancellable,GError **error); void goa_oauth2_based_complete_get_access_token (GoaOAuth2Based *object,GDBusMethodInvocation *invocation,const gchar *access_token,gint expires_in); struct GoaOAuth2BasedProxy; struct GoaOAuth2BasedProxyClass; void goa_oauth2_based_proxy_new (GDBusConnection *connection,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); GoaOAuth2Based * goa_oauth2_based_proxy_new_finish (GAsyncResult *res,GError **error); GoaOAuth2Based * goa_oauth2_based_proxy_new_sync (GDBusConnection *connection,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GError **error); void goa_oauth2_based_proxy_new_for_bus (GBusType bus_type,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); GoaOAuth2Based * goa_oauth2_based_proxy_new_for_bus_finish (GAsyncResult *res,GError **error); GoaOAuth2Based * goa_oauth2_based_proxy_new_for_bus_sync (GBusType bus_type,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GError **error); struct GoaOAuth2BasedSkeleton; struct GoaOAuth2BasedSkeletonClass; GoaOAuth2Based * goa_oauth2_based_skeleton_new (void);
This section contains code for working with the org.gnome.OnlineAccounts.OAuth2Based D-Bus interface in C.
typedef struct _GoaOAuth2Based GoaOAuth2Based;
Abstract interface type for the D-Bus interface org.gnome.OnlineAccounts.OAuth2Based.
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.
| GTypeInterface  | The parent interface. | 
| Handler for the "handle-get-access-token" signal. | |
| Getter for the "client-id" property. | |
| Getter for the "client-secret" property. | 
GDBusInterfaceInfo * goa_oauth2_based_interface_info    (void);
Gets a machine-readable description of the org.gnome.OnlineAccounts.OAuth2Based D-Bus interface.
| Returns : | A GDBusInterfaceInfo. Do not free. [transfer none] | 
guint goa_oauth2_based_override_properties (GObjectClass *klass,guint property_id_begin);
Overrides all GObject properties in the GoaOAuth2Based interface for a concrete class. The properties are overridden in the order they are defined.
| 
 | The class structure for a GObject-derived class. | 
| 
 | The property id to assign to the first overridden property. | 
| Returns : | The last property id. | 
const gchar *       goa_oauth2_based_get_client_id      (GoaOAuth2Based *object);
Gets the value of the "ClientId" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
object was constructed. Use goa_oauth2_based_dup_client_id() if on another thread.
| 
 | A GoaOAuth2Based. | 
| Returns : | The property value or NULLif the property is not set. Do not free the returned value, it belongs toobject. [transfer none] | 
void goa_oauth2_based_set_client_id (GoaOAuth2Based *object,const gchar *value);
Sets the "ClientId" D-Bus property to value.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
| 
 | A GoaOAuth2Based. | 
| 
 | The value to set. | 
gchar *             goa_oauth2_based_dup_client_id      (GoaOAuth2Based *object);
Gets a copy of the "ClientId" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
| 
 | A GoaOAuth2Based. | 
| Returns : | The property value or NULLif the property is not set. The returned value should be freed withg_free(). [transfer full] | 
const gchar *       goa_oauth2_based_get_client_secret  (GoaOAuth2Based *object);
Gets the value of the "ClientSecret" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
object was constructed. Use goa_oauth2_based_dup_client_secret() if on another thread.
| 
 | A GoaOAuth2Based. | 
| Returns : | The property value or NULLif the property is not set. Do not free the returned value, it belongs toobject. [transfer none] | 
void goa_oauth2_based_set_client_secret (GoaOAuth2Based *object,const gchar *value);
Sets the "ClientSecret" D-Bus property to value.
Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.
| 
 | A GoaOAuth2Based. | 
| 
 | The value to set. | 
gchar *             goa_oauth2_based_dup_client_secret  (GoaOAuth2Based *object);
Gets a copy of the "ClientSecret" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
| 
 | A GoaOAuth2Based. | 
| Returns : | The property value or NULLif the property is not set. The returned value should be freed withg_free(). [transfer full] | 
void goa_oauth2_based_call_get_access_token (GoaOAuth2Based *proxy,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
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.
You can then call goa_oauth2_based_call_get_access_token_finish() to get the result of the operation.
See goa_oauth2_based_call_get_access_token_sync() for the synchronous, blocking version of this method.
| 
 | A GoaOAuth2BasedProxy. | 
| 
 | A GCancellable or NULL. [allow-none] | 
| 
 | A GAsyncReadyCallback to call when the request is satisfied or NULL. | 
| 
 | User data to pass to callback. | 
gboolean goa_oauth2_based_call_get_access_token_finish (GoaOAuth2Based *proxy,gchar **out_access_token,gint *out_expires_in,GAsyncResult *res,GError **error);
Finishes an operation started with goa_oauth2_based_call_get_access_token().
| 
 | A GoaOAuth2BasedProxy. | 
| 
 | Return location for return parameter or NULLto ignore. [out] | 
| 
 | Return location for return parameter or NULLto ignore. [out] | 
| 
 | The GAsyncResult obtained from the GAsyncReadyCallback passed to goa_oauth2_based_call_get_access_token(). | 
| 
 | Return location for error or NULL. | 
| Returns : | TRUEif the call succeded,FALSEiferroris set. [skip] | 
gboolean goa_oauth2_based_call_get_access_token_sync (GoaOAuth2Based *proxy,gchar **out_access_token,gint *out_expires_in,GCancellable *cancellable,GError **error);
Synchronously invokes the GetAccessToken() D-Bus method on proxy. The calling thread is blocked until a reply is received.
See goa_oauth2_based_call_get_access_token() for the asynchronous version of this method.
| 
 | A GoaOAuth2BasedProxy. | 
| 
 | Return location for return parameter or NULLto ignore. [out] | 
| 
 | Return location for return parameter or NULLto ignore. [out] | 
| 
 | A GCancellable or NULL. [allow-none] | 
| 
 | Return location for error or NULL. | 
| Returns : | TRUEif the call succeded,FALSEiferroris set. [skip] | 
void goa_oauth2_based_complete_get_access_token (GoaOAuth2Based *object,GDBusMethodInvocation *invocation,const gchar *access_token,gint expires_in);
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.
This method will free invocation, you cannot use it afterwards.
| 
 | A GoaOAuth2Based. | 
| 
 | A GDBusMethodInvocation. [transfer full] | 
| 
 | Parameter to return. | 
| 
 | Parameter to return. | 
struct GoaOAuth2BasedProxy {
};
The GoaOAuth2BasedProxy structure contains only private data and should only be accessed using the provided API.
struct GoaOAuth2BasedProxyClass {
  GDBusProxyClass parent_class;
};
Class structure for GoaOAuth2BasedProxy.
| GDBusProxyClass  | The parent class. | 
void goa_oauth2_based_proxy_new (GDBusConnection *connection,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously creates a proxy for the D-Bus interface org.gnome.OnlineAccounts.OAuth2Based. See g_dbus_proxy_new() for more details.
When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from.
You can then call goa_oauth2_based_proxy_new_finish() to get the result of the operation.
See goa_oauth2_based_proxy_new_sync() for the synchronous, blocking version of this constructor.
| 
 | A GDBusConnection. | 
| 
 | Flags from the GDBusProxyFlags enumeration. | 
| 
 | A bus name (well-known or unique) or NULLifconnectionis not a message bus connection. [allow-none] | 
| 
 | An object path. | 
| 
 | A GCancellable or NULL. [allow-none] | 
| 
 | A GAsyncReadyCallback to call when the request is satisfied. | 
| 
 | User data to pass to callback. | 
GoaOAuth2Based * goa_oauth2_based_proxy_new_finish (GAsyncResult *res,GError **error);
Finishes an operation started with goa_oauth2_based_proxy_new().
| 
 | The GAsyncResult obtained from the GAsyncReadyCallback passed to goa_oauth2_based_proxy_new(). | 
| 
 | Return location for error or NULL | 
| Returns : | The constructed proxy object or NULLiferroris set. [transfer full][type GoaOAuth2BasedProxy] | 
GoaOAuth2Based * goa_oauth2_based_proxy_new_sync (GDBusConnection *connection,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GError **error);
Synchronously creates a proxy for the D-Bus interface org.gnome.OnlineAccounts.OAuth2Based. See g_dbus_proxy_new_sync() for more details.
The calling thread is blocked until a reply is received.
See goa_oauth2_based_proxy_new() for the asynchronous version of this constructor.
| 
 | A GDBusConnection. | 
| 
 | Flags from the GDBusProxyFlags enumeration. | 
| 
 | A bus name (well-known or unique) or NULLifconnectionis not a message bus connection. [allow-none] | 
| 
 | An object path. | 
| 
 | A GCancellable or NULL. [allow-none] | 
| 
 | Return location for error or NULL | 
| Returns : | The constructed proxy object or NULLiferroris set. [transfer full][type GoaOAuth2BasedProxy] | 
void goa_oauth2_based_proxy_new_for_bus (GBusType bus_type,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Like goa_oauth2_based_proxy_new() but takes a GBusType instead of a GDBusConnection.
When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from.
You can then call goa_oauth2_based_proxy_new_for_bus_finish() to get the result of the operation.
See goa_oauth2_based_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor.
| 
 | A GBusType. | 
| 
 | Flags from the GDBusProxyFlags enumeration. | 
| 
 | A bus name (well-known or unique). | 
| 
 | An object path. | 
| 
 | A GCancellable or NULL. [allow-none] | 
| 
 | A GAsyncReadyCallback to call when the request is satisfied. | 
| 
 | User data to pass to callback. | 
GoaOAuth2Based * goa_oauth2_based_proxy_new_for_bus_finish (GAsyncResult *res,GError **error);
Finishes an operation started with goa_oauth2_based_proxy_new_for_bus().
| 
 | The GAsyncResult obtained from the GAsyncReadyCallback passed to goa_oauth2_based_proxy_new_for_bus(). | 
| 
 | Return location for error or NULL | 
| Returns : | The constructed proxy object or NULLiferroris set. [transfer full][type GoaOAuth2BasedProxy] | 
GoaOAuth2Based * goa_oauth2_based_proxy_new_for_bus_sync (GBusType bus_type,GDBusProxyFlags flags,const gchar *name,const gchar *object_path,GCancellable *cancellable,GError **error);
Like goa_oauth2_based_proxy_new_sync() but takes a GBusType instead of a GDBusConnection.
The calling thread is blocked until a reply is received.
See goa_oauth2_based_proxy_new_for_bus() for the asynchronous version of this constructor.
| 
 | A GBusType. | 
| 
 | Flags from the GDBusProxyFlags enumeration. | 
| 
 | A bus name (well-known or unique). | 
| 
 | An object path. | 
| 
 | A GCancellable or NULL. [allow-none] | 
| 
 | Return location for error or NULL | 
| Returns : | The constructed proxy object or NULLiferroris set. [transfer full][type GoaOAuth2BasedProxy] | 
struct GoaOAuth2BasedSkeleton {
};
The GoaOAuth2BasedSkeleton structure contains only private data and should only be accessed using the provided API.
struct GoaOAuth2BasedSkeletonClass {
  GDBusInterfaceSkeletonClass parent_class;
};
Class structure for GoaOAuth2BasedSkeleton.
| GDBusInterfaceSkeletonClass  | The parent class. | 
GoaOAuth2Based *    goa_oauth2_based_skeleton_new       (void);
Creates a skeleton object for the D-Bus interface org.gnome.OnlineAccounts.OAuth2Based.
| Returns : | The skeleton object. [transfer full][type GoaOAuth2BasedSkeleton] | 
"client-id" property"client-id" gchar* : Read / Write
Represents the D-Bus property "ClientId".
Since the D-Bus property for this GObject 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.
Default value: NULL
"client-secret" property"client-secret" gchar* : Read / Write
Represents the D-Bus property "ClientSecret".
Since the D-Bus property for this GObject 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.
Default value: NULL
"handle-get-access-token" signalgboolean            user_function                      (GoaOAuth2Based        *object,
                                                        GDBusMethodInvocation *invocation,
                                                        gpointer               user_data)       : Run Last
Signal emitted when a remote caller is invoking the 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_oauth2_based_complete_get_access_token() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the G_DBUS_ERROR_UNKNOWN_METHOD error is returned.
| 
 | A GoaOAuth2Based. | 
| 
 | A GDBusMethodInvocation. | 
| 
 | user data set when the signal handler was connected. | 
| Returns : | TRUEif the invocation was handled,FALSEto let other signal handlers run. |