Top |
GoaOAuthBasedGoaOAuthBased — Generated C code for the org.gnome.OnlineAccounts.OAuthBased D-Bus interface |
Functions
GDBusInterfaceInfo * | goa_oauth_based_interface_info () |
guint | goa_oauth_based_override_properties () |
void | goa_oauth_based_call_get_access_token () |
gboolean | goa_oauth_based_call_get_access_token_finish () |
gboolean | goa_oauth_based_call_get_access_token_sync () |
void | goa_oauth_based_complete_get_access_token () |
const gchar * | goa_oauth_based_get_consumer_key () |
gchar * | goa_oauth_based_dup_consumer_key () |
void | goa_oauth_based_set_consumer_key () |
const gchar * | goa_oauth_based_get_consumer_secret () |
gchar * | goa_oauth_based_dup_consumer_secret () |
void | goa_oauth_based_set_consumer_secret () |
void | goa_oauth_based_proxy_new () |
GoaOAuthBased * | goa_oauth_based_proxy_new_finish () |
GoaOAuthBased * | goa_oauth_based_proxy_new_sync () |
void | goa_oauth_based_proxy_new_for_bus () |
GoaOAuthBased * | goa_oauth_based_proxy_new_for_bus_finish () |
GoaOAuthBased * | goa_oauth_based_proxy_new_for_bus_sync () |
GoaOAuthBased * | goa_oauth_based_skeleton_new () |
Types and Values
GoaOAuthBased | |
struct | GoaOAuthBasedIface |
struct | GoaOAuthBasedProxy |
struct | GoaOAuthBasedProxyClass |
struct | GoaOAuthBasedSkeleton |
struct | GoaOAuthBasedSkeletonClass |
Object Hierarchy
GInterface ╰── GoaOAuthBased GObject ├── GDBusInterfaceSkeleton │ ╰── GoaOAuthBasedSkeleton ╰── GDBusProxy ╰── GoaOAuthBasedProxy
Implemented Interfaces
GoaOAuthBasedProxy implements GDBusInterface, GInitable, GAsyncInitable and GoaOAuthBased.
GoaOAuthBasedSkeleton implements GDBusInterface and GoaOAuthBased.
Description
This section contains code for working with the org.gnome.OnlineAccounts.OAuthBased D-Bus interface in C.
Functions
goa_oauth_based_interface_info ()
GDBusInterfaceInfo *
goa_oauth_based_interface_info (void
);
Gets a machine-readable description of the org.gnome.OnlineAccounts.OAuthBased D-Bus interface.
goa_oauth_based_override_properties ()
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.
goa_oauth_based_call_get_access_token ()
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.
goa_oauth_based_call_get_access_token_finish ()
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()
.
Parameters
proxy |
||
out_access_token |
Return location for return parameter or |
[out] |
out_access_token_secret |
Return location for return parameter or |
[out] |
out_expires_in |
Return location for return parameter or |
[out] |
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to |
|
error |
Return location for error or |
goa_oauth_based_call_get_access_token_sync ()
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.
Parameters
proxy |
||
out_access_token |
Return location for return parameter or |
[out] |
out_access_token_secret |
Return location for return parameter or |
[out] |
out_expires_in |
Return location for return parameter or |
[out] |
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
goa_oauth_based_complete_get_access_token ()
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.
goa_oauth_based_get_consumer_key ()
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.[skip]
goa_oauth_based_dup_consumer_key ()
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.
[skip]
goa_oauth_based_set_consumer_key ()
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.
[skip]
goa_oauth_based_get_consumer_secret ()
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.[skip]
goa_oauth_based_dup_consumer_secret ()
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.
[skip]
goa_oauth_based_set_consumer_secret ()
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.
[skip]
goa_oauth_based_proxy_new ()
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.
Parameters
connection |
A GDBusConnection. |
|
flags |
Flags from the GDBusProxyFlags enumeration. |
|
name |
A bus name (well-known or unique) or |
[allow-none] |
object_path |
An object path. |
|
cancellable |
A GCancellable or |
[allow-none] |
callback |
A GAsyncReadyCallback to call when the request is satisfied. |
|
user_data |
User data to pass to |
goa_oauth_based_proxy_new_finish ()
GoaOAuthBased * goa_oauth_based_proxy_new_finish (GAsyncResult *res
,GError **error
);
Finishes an operation started with goa_oauth_based_proxy_new()
.
Parameters
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to |
|
error |
Return location for error or |
goa_oauth_based_proxy_new_sync ()
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.
Parameters
connection |
A GDBusConnection. |
|
flags |
Flags from the GDBusProxyFlags enumeration. |
|
name |
A bus name (well-known or unique) or |
[allow-none] |
object_path |
An object path. |
|
cancellable |
A GCancellable or |
[allow-none] |
error |
Return location for error or |
goa_oauth_based_proxy_new_for_bus ()
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.
Parameters
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 |
[allow-none] |
callback |
A GAsyncReadyCallback to call when the request is satisfied. |
|
user_data |
User data to pass to |
goa_oauth_based_proxy_new_for_bus_finish ()
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()
.
Parameters
res |
The GAsyncResult obtained from the GAsyncReadyCallback passed to |
|
error |
Return location for error or |
goa_oauth_based_proxy_new_for_bus_sync ()
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.
goa_oauth_based_skeleton_new ()
GoaOAuthBased *
goa_oauth_based_skeleton_new (void
);
Creates a skeleton object for the D-Bus interface org.gnome.OnlineAccounts.OAuthBased.
Types and Values
GoaOAuthBased
typedef struct _GoaOAuthBased GoaOAuthBased;
Abstract interface type for the D-Bus interface org.gnome.OnlineAccounts.OAuthBased.
struct GoaOAuthBasedIface
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.
Members
The parent interface. |
||
Handler for the “handle-get-access-token” signal. |
||
Getter for the “consumer-key” property. |
||
Getter for the “consumer-secret” property. |
struct GoaOAuthBasedProxy
struct GoaOAuthBasedProxy;
The GoaOAuthBasedProxy structure contains only private data and should only be accessed using the provided API.
struct GoaOAuthBasedProxyClass
struct GoaOAuthBasedProxyClass { GDBusProxyClass parent_class; };
Class structure for GoaOAuthBasedProxy.
struct GoaOAuthBasedSkeleton
struct GoaOAuthBasedSkeleton;
The GoaOAuthBasedSkeleton structure contains only private data and should only be accessed using the provided API.
struct GoaOAuthBasedSkeletonClass
struct GoaOAuthBasedSkeletonClass { GDBusInterfaceSkeletonClass parent_class; };
Class structure for GoaOAuthBasedSkeleton.
Property Details
The “consumer-key”
property
“consumer-key” gchar *
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.
Flags: Read / Write
Default value: NULL
The “consumer-secret”
property
“consumer-secret” gchar *
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.
Flags: Read / Write
Default value: NULL
Signal Details
The “handle-get-access-token”
signal
gboolean user_function (GoaOAuthBased *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_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.
Parameters
object |
||
invocation |
A GDBusMethodInvocation. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last