![]() |
![]() |
![]() |
GNOME Online Accounts Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Prerequisites | Properties | Signals |
GoaOAuthBasedGoaOAuthBased — Generated C code for the org.gnome.OnlineAccounts.OAuthBased D-Bus interface |
GoaOAuthBased; struct GoaOAuthBasedIface; GDBusInterfaceInfo * goa_oauth_based_interface_info (void
); guint goa_oauth_based_override_properties (GObjectClass *klass
,guint property_id_begin
); void goa_oauth_based_call_get_access_token (GoaOAuthBased *proxy
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean goa_oauth_based_call_get_access_token_finish (GoaOAuthBased *proxy
,gchar **out_access_token
,gchar **out_access_token_secret
,gint *out_expires_in
,GAsyncResult *res
,GError **error
); gboolean goa_oauth_based_call_get_access_token_sync (GoaOAuthBased *proxy
,gchar **out_access_token
,gchar **out_access_token_secret
,gint *out_expires_in
,GCancellable *cancellable
,GError **error
); void goa_oauth_based_complete_get_access_token (GoaOAuthBased *object
,GDBusMethodInvocation *invocation
,const gchar *access_token
,const gchar *access_token_secret
,gint expires_in
); const gchar * goa_oauth_based_get_consumer_key (GoaOAuthBased *object
); gchar * goa_oauth_based_dup_consumer_key (GoaOAuthBased *object
); void goa_oauth_based_set_consumer_key (GoaOAuthBased *object
,const gchar *value
); const gchar * goa_oauth_based_get_consumer_secret (GoaOAuthBased *object
); gchar * goa_oauth_based_dup_consumer_secret (GoaOAuthBased *object
); void goa_oauth_based_set_consumer_secret (GoaOAuthBased *object
,const gchar *value
); struct GoaOAuthBasedProxy; struct GoaOAuthBasedProxyClass; void goa_oauth_based_proxy_new (GDBusConnection *connection
,GDBusProxyFlags flags
,const gchar *name
,const gchar *object_path
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); GoaOAuthBased * goa_oauth_based_proxy_new_finish (GAsyncResult *res
,GError **error
); GoaOAuthBased * goa_oauth_based_proxy_new_sync (GDBusConnection *connection
,GDBusProxyFlags flags
,const gchar *name
,const gchar *object_path
,GCancellable *cancellable
,GError **error
); void goa_oauth_based_proxy_new_for_bus (GBusType bus_type
,GDBusProxyFlags flags
,const gchar *name
,const gchar *object_path
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); GoaOAuthBased * goa_oauth_based_proxy_new_for_bus_finish (GAsyncResult *res
,GError **error
); GoaOAuthBased * goa_oauth_based_proxy_new_for_bus_sync (GBusType bus_type
,GDBusProxyFlags flags
,const gchar *name
,const gchar *object_path
,GCancellable *cancellable
,GError **error
); struct GoaOAuthBasedSkeleton; struct GoaOAuthBasedSkeletonClass; GoaOAuthBased * goa_oauth_based_skeleton_new (void
);
This section contains code for working with the org.gnome.OnlineAccounts.OAuthBased D-Bus interface in C.
typedef struct _GoaOAuthBased GoaOAuthBased;
Abstract interface type for the D-Bus interface org.gnome.OnlineAccounts.OAuthBased.
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.
The parent interface. | |
Handler for the "handle-get-access-token" signal. | |
Getter for the "consumer-key" property. | |
Getter for the "consumer-secret" property. |
GDBusInterfaceInfo * goa_oauth_based_interface_info (void
);
Gets a machine-readable description of the org.gnome.OnlineAccounts.OAuthBased D-Bus interface.
Returns : |
A GDBusInterfaceInfo. Do not free. [transfer none] |
guint goa_oauth_based_override_properties (GObjectClass *klass
,guint property_id_begin
);
Overrides all GObject properties in the GoaOAuthBased 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. |
void goa_oauth_based_call_get_access_token (GoaOAuthBased *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_oauth_based_call_get_access_token_finish()
to get the result of the operation.
See goa_oauth_based_call_get_access_token_sync()
for the synchronous, blocking version of this method.
|
A GoaOAuthBasedProxy. |
|
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_oauth_based_call_get_access_token_finish (GoaOAuthBased *proxy
,gchar **out_access_token
,gchar **out_access_token_secret
,gint *out_expires_in
,GAsyncResult *res
,GError **error
);
Finishes an operation started with goa_oauth_based_call_get_access_token()
.
|
A GoaOAuthBasedProxy. |
|
Return location for return parameter or NULL to ignore. [out]
|
|
Return location for return parameter or NULL to ignore. [out]
|
|
Return location for return parameter or NULL to ignore. [out]
|
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to goa_oauth_based_call_get_access_token() . |
|
Return location for error or NULL . |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
gboolean goa_oauth_based_call_get_access_token_sync (GoaOAuthBased *proxy
,gchar **out_access_token
,gchar **out_access_token_secret
,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_oauth_based_call_get_access_token()
for the asynchronous version of this method.
|
A GoaOAuthBasedProxy. |
|
Return location for return parameter or NULL to ignore. [out]
|
|
Return location for return parameter or NULL to ignore. [out]
|
|
Return location for return parameter or NULL to ignore. [out]
|
|
A GCancellable or NULL . [allow-none]
|
|
Return location for error or NULL . |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
void goa_oauth_based_complete_get_access_token (GoaOAuthBased *object
,GDBusMethodInvocation *invocation
,const gchar *access_token
,const gchar *access_token_secret
,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 GoaOAuthBased. |
|
A GDBusMethodInvocation. [transfer full] |
|
Parameter to return. |
|
Parameter to return. |
|
Parameter to return. |
const gchar * goa_oauth_based_get_consumer_key (GoaOAuthBased *object
);
Gets the value of the "ConsumerKey" 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_oauth_based_dup_consumer_key()
if on another thread.
|
A GoaOAuthBased. |
Returns : |
The property value or NULL if the property is not set. Do not free the returned value, it belongs to object . [transfer none]
|
gchar * goa_oauth_based_dup_consumer_key (GoaOAuthBased *object
);
Gets a copy of the "ConsumerKey" 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 GoaOAuthBased. |
Returns : |
The property value or NULL if the property is not set. The returned value should be freed with g_free() . [transfer full]
|
void goa_oauth_based_set_consumer_key (GoaOAuthBased *object
,const gchar *value
);
Sets the "ConsumerKey" 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 GoaOAuthBased. |
|
The value to set. |
const gchar * goa_oauth_based_get_consumer_secret (GoaOAuthBased *object
);
Gets the value of the "ConsumerSecret" 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_oauth_based_dup_consumer_secret()
if on another thread.
|
A GoaOAuthBased. |
Returns : |
The property value or NULL if the property is not set. Do not free the returned value, it belongs to object . [transfer none]
|
gchar * goa_oauth_based_dup_consumer_secret (GoaOAuthBased *object
);
Gets a copy of the "ConsumerSecret" 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 GoaOAuthBased. |
Returns : |
The property value or NULL if the property is not set. The returned value should be freed with g_free() . [transfer full]
|
void goa_oauth_based_set_consumer_secret (GoaOAuthBased *object
,const gchar *value
);
Sets the "ConsumerSecret" 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 GoaOAuthBased. |
|
The value to set. |
struct GoaOAuthBasedProxy { };
The GoaOAuthBasedProxy structure contains only private data and should only be accessed using the provided API.
struct GoaOAuthBasedProxyClass { GDBusProxyClass parent_class; };
Class structure for GoaOAuthBasedProxy.
void goa_oauth_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.OAuthBased. 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_oauth_based_proxy_new_finish()
to get the result of the operation.
See goa_oauth_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 NULL if connection is 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 . |
GoaOAuthBased * goa_oauth_based_proxy_new_finish (GAsyncResult *res
,GError **error
);
Finishes an operation started with goa_oauth_based_proxy_new()
.
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to goa_oauth_based_proxy_new() . |
|
Return location for error or NULL
|
Returns : |
The constructed proxy object or NULL if error is set. [transfer full][type GoaOAuthBasedProxy]
|
GoaOAuthBased * goa_oauth_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.OAuthBased. See g_dbus_proxy_new_sync()
for more details.
The calling thread is blocked until a reply is received.
See goa_oauth_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 NULL if connection is 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 NULL if error is set. [transfer full][type GoaOAuthBasedProxy]
|
void goa_oauth_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_oauth_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_oauth_based_proxy_new_for_bus_finish()
to get the result of the operation.
See goa_oauth_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 . |
GoaOAuthBased * goa_oauth_based_proxy_new_for_bus_finish (GAsyncResult *res
,GError **error
);
Finishes an operation started with goa_oauth_based_proxy_new_for_bus()
.
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to goa_oauth_based_proxy_new_for_bus() . |
|
Return location for error or NULL
|
Returns : |
The constructed proxy object or NULL if error is set. [transfer full][type GoaOAuthBasedProxy]
|
GoaOAuthBased * goa_oauth_based_proxy_new_for_bus_sync (GBusType bus_type
,GDBusProxyFlags flags
,const gchar *name
,const gchar *object_path
,GCancellable *cancellable
,GError **error
);
Like goa_oauth_based_proxy_new_sync()
but takes a GBusType instead of a GDBusConnection.
The calling thread is blocked until a reply is received.
See goa_oauth_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 NULL if error is set. [transfer full][type GoaOAuthBasedProxy]
|
struct GoaOAuthBasedSkeleton { };
The GoaOAuthBasedSkeleton structure contains only private data and should only be accessed using the provided API.
struct GoaOAuthBasedSkeletonClass { GDBusInterfaceSkeletonClass parent_class; };
Class structure for GoaOAuthBasedSkeleton.
GoaOAuthBased * goa_oauth_based_skeleton_new (void
);
Creates a skeleton object for the D-Bus interface org.gnome.OnlineAccounts.OAuthBased.
Returns : |
The skeleton object. [transfer full][type GoaOAuthBasedSkeleton] |
"consumer-key"
property "consumer-key" gchar* : Read / Write
Represents the D-Bus property "ConsumerKey".
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
"consumer-secret"
property "consumer-secret" gchar* : Read / Write
Represents the D-Bus property "ConsumerSecret".
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 (GoaOAuthBased *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_oauth_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 GoaOAuthBased. |
|
A GDBusMethodInvocation. |
|
user data set when the signal handler was connected. |
Returns : |
TRUE if the invocation was handled, FALSE to let other signal handlers run. |