GoaOAuthBased

GoaOAuthBased — Generated C code for the org.gnome.OnlineAccounts.OAuthBased D-Bus interface

Synopsis

                    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);

Object Hierarchy

  GInterface
   +----GoaOAuthBased

Prerequisites

GoaOAuthBased requires GObject.

Properties

  "consumer-key"             gchar*                : Read / Write
  "consumer-secret"          gchar*                : Read / Write

Signals

  "handle-get-access-token"                        : Run Last

Description

This section contains code for working with the org.gnome.OnlineAccounts.OAuthBased D-Bus interface in C.

Details

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.

GTypeInterface parent_iface;

The parent interface.

handle_get_access_token ()

Handler for the "handle-get-access-token" signal.

get_consumer_key ()

Getter for the "consumer-key" property.

get_consumer_secret ()

Getter for the "consumer-secret" property.

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.

Returns :

A GDBusInterfaceInfo. Do not free. [transfer none]

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.

klass :

The class structure for a GObject-derived class.

property_id_begin :

The property id to assign to the first overridden property.

Returns :

The last property id.

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.

proxy :

A GoaOAuthBasedProxy.

cancellable :

A GCancellable or NULL. [allow-none]

callback :

A GAsyncReadyCallback to call when the request is satisfied or NULL.

user_data :

User data to pass to callback.

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().

proxy :

A GoaOAuthBasedProxy.

out_access_token :

Return location for return parameter or NULL to ignore. [out]

out_access_token_secret :

Return location for return parameter or NULL to ignore. [out]

out_expires_in :

Return location for return parameter or NULL to ignore. [out]

res :

The GAsyncResult obtained from the GAsyncReadyCallback passed to goa_oauth_based_call_get_access_token().

error :

Return location for error or NULL.

Returns :

TRUE if the call succeded, FALSE if error is set. [skip]

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.

proxy :

A GoaOAuthBasedProxy.

out_access_token :

Return location for return parameter or NULL to ignore. [out]

out_access_token_secret :

Return location for return parameter or NULL to ignore. [out]

out_expires_in :

Return location for return parameter or NULL to ignore. [out]

cancellable :

A GCancellable or NULL. [allow-none]

error :

Return location for error or NULL.

Returns :

TRUE if the call succeded, FALSE if error is set. [skip]

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.

object :

A GoaOAuthBased.

invocation :

A GDBusMethodInvocation. [transfer full]

access_token :

Parameter to return.

access_token_secret :

Parameter to return.

expires_in :

Parameter to return.

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.

Warning

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_oauth_based_dup_consumer_key() if on another thread.

object :

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]

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.

object :

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]

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.

object :

A GoaOAuthBased.

value :

The value to set.

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.

Warning

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_oauth_based_dup_consumer_secret() if on another thread.

object :

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]

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.

object :

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]

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.

object :

A GoaOAuthBased.

value :

The value to set.

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.

GDBusProxyClass parent_class;

The parent class.

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.

connection :

A GDBusConnection.

flags :

Flags from the GDBusProxyFlags enumeration.

name :

A bus name (well-known or unique) or NULL if connection is not a message bus connection. [allow-none]

object_path :

An object path.

cancellable :

A GCancellable or NULL. [allow-none]

callback :

A GAsyncReadyCallback to call when the request is satisfied.

user_data :

User data to pass to callback.

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().

res :

The GAsyncResult obtained from the GAsyncReadyCallback passed to goa_oauth_based_proxy_new().

error :

Return location for error or NULL

Returns :

The constructed proxy object or NULL if error is set. [transfer full][type GoaOAuthBasedProxy]

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.

connection :

A GDBusConnection.

flags :

Flags from the GDBusProxyFlags enumeration.

name :

A bus name (well-known or unique) or NULL if connection is not a message bus connection. [allow-none]

object_path :

An object path.

cancellable :

A GCancellable or NULL. [allow-none]

error :

Return location for error or NULL

Returns :

The constructed proxy object or NULL if error is set. [transfer full][type GoaOAuthBasedProxy]

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.

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 NULL. [allow-none]

callback :

A GAsyncReadyCallback to call when the request is satisfied.

user_data :

User data to pass to callback.

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().

res :

The GAsyncResult obtained from the GAsyncReadyCallback passed to goa_oauth_based_proxy_new_for_bus().

error :

Return location for error or NULL

Returns :

The constructed proxy object or NULL if error is set. [transfer full][type GoaOAuthBasedProxy]

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.

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 NULL. [allow-none]

error :

Return location for error or NULL

Returns :

The constructed proxy object or NULL if error is set. [transfer full][type 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.

GDBusInterfaceSkeletonClass parent_class;

The parent class.

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.

Returns :

The skeleton object. [transfer full][type GoaOAuthBasedSkeleton]

Property Details

The "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


The "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

Signal Details

The "handle-get-access-token" signal

gboolean            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.

object :

A GoaOAuthBased.

invocation :

A GDBusMethodInvocation.

user_data :

user data set when the signal handler was connected.

Returns :

TRUE if the invocation was handled, FALSE to let other signal handlers run.