| Top |  |  |  |  | 
| GoaOAuth2BasedGoaOAuth2Based — Generated C code for the org.gnome.OnlineAccounts.OAuth2Based D-Bus interface | 
| GoaOAuth2Based | |
| struct | GoaOAuth2BasedIface | 
| struct | GoaOAuth2BasedProxy | 
| struct | GoaOAuth2BasedProxyClass | 
| struct | GoaOAuth2BasedSkeleton | 
| struct | GoaOAuth2BasedSkeletonClass | 
GInterface ╰── GoaOAuth2Based GObject ├── GDBusInterfaceSkeleton │ ╰── GoaOAuth2BasedSkeleton ╰── GDBusProxy ╰── GoaOAuth2BasedProxy
GoaOAuth2BasedProxy implements GDBusInterface, GInitable, GAsyncInitable and GoaOAuth2Based.
GoaOAuth2BasedSkeleton implements GDBusInterface and GoaOAuth2Based.
GoaOAuth2Based is implemented by GoaOAuth2BasedProxy and GoaOAuth2BasedSkeleton.
This section contains code for working with the org.gnome.OnlineAccounts.OAuth2Based D-Bus interface in C.
GDBusInterfaceInfo *
goa_oauth2_based_interface_info (void);
Gets a machine-readable description of the org.gnome.OnlineAccounts.OAuth2Based D-Bus interface.
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.
| klass | The class structure for a GObject derived class. | |
| property_id_begin | The property id to assign to the first overridden property. | 
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.
The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where object
 was constructed. Use goa_oauth2_based_dup_client_id() if on another thread.
[skip]
The property value or NULL if the property is not set. Do not free the returned value, it belongs to object
. 
[transfer none][nullable]
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.
[skip]
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.
[skip]
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.
The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where object
 was constructed. Use goa_oauth2_based_dup_client_secret() if on another thread.
[skip]
The property value or NULL if the property is not set. Do not free the returned value, it belongs to object
. 
[transfer none][nullable]
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.
[skip]
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.
[skip]
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 (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.
See goa_oauth2_based_call_get_access_token_sync() for the synchronous, blocking version of this method.
| proxy | ||
| cancellable | A GCancellable or  | [nullable] | 
| callback | A GAsyncReadyCallback to call when the request is satisfied or  | |
| user_data | User data to pass to  | 
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().
| proxy | ||
| out_access_token | Return location for return parameter or  | [out][optional] | 
| out_expires_in | Return location for return parameter or  | [out][optional] | 
| res | The GAsyncResult obtained from the GAsyncReadyCallback passed to  | |
| error | Return location for error or  | 
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.
| proxy | ||
| out_access_token | Return location for return parameter or  | [out][optional] | 
| out_expires_in | Return location for return parameter or  | [out][optional] | 
| cancellable | A GCancellable or  | [nullable] | 
| error | Return location for error or  | 
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.
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 (see g_main_context_push_thread_default()).
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.
| connection | ||
| flags | Flags from the GDBusProxyFlags enumeration. | |
| name | A bus name (well-known or unique) or  | [nullable] | 
| object_path | An object path. | |
| cancellable | A GCancellable or  | [nullable] | 
| callback | A GAsyncReadyCallback to call when the request is satisfied. | |
| user_data | User data to pass to  | 
GoaOAuth2Based * goa_oauth2_based_proxy_new_finish (GAsyncResult *res,GError **error);
Finishes an operation started with goa_oauth2_based_proxy_new().
| res | The GAsyncResult obtained from the GAsyncReadyCallback passed to  | |
| error | Return location for error or  | 
The constructed proxy object or NULL if error
is 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.
| connection | ||
| flags | Flags from the GDBusProxyFlags enumeration. | |
| name | A bus name (well-known or unique) or  | [nullable] | 
| object_path | An object path. | |
| cancellable | A GCancellable or  | [nullable] | 
| error | Return location for error or  | 
The constructed proxy object or NULL if error
is 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 (see g_main_context_push_thread_default()).
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.
| bus_type | A GBusType. | |
| flags | Flags from the GDBusProxyFlags enumeration. | |
| name | A bus name (well-known or unique). | |
| object_path | An object path. | |
| cancellable | A GCancellable or  | [nullable] | 
| callback | A GAsyncReadyCallback to call when the request is satisfied. | |
| user_data | User data to pass to  | 
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().
| res | The GAsyncResult obtained from the GAsyncReadyCallback passed to  | |
| error | Return location for error or  | 
The constructed proxy object or NULL if error
is 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.
| bus_type | A GBusType. | |
| flags | Flags from the GDBusProxyFlags enumeration. | |
| name | A bus name (well-known or unique). | |
| object_path | An object path. | |
| cancellable | A GCancellable or  | [nullable] | 
| error | Return location for error or  | 
The constructed proxy object or NULL if error
is set. 
[transfer full][type GoaOAuth2BasedProxy]
GoaOAuth2Based *
goa_oauth2_based_skeleton_new (void);
Creates a skeleton object for the D-Bus interface org.gnome.OnlineAccounts.OAuth2Based.
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. | 
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.
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.
“client-id” property  “client-id”                char *
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.
Owner: GoaOAuth2Based
Flags: Read / Write
Default value: NULL
“client-secret” property  “client-secret”            char *
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.
Owner: GoaOAuth2Based
Flags: Read / Write
Default value: NULL
“handle-get-access-token” signalgboolean user_function (GoaOAuth2Based *object, GDBusMethodInvocation *invocation, gpointer user_data)
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.
Flags: Run Last