Blame doc/html/GoaOAuth2Based.html

Packit 79f644
Packit 79f644
<html>
Packit 79f644
<head>
Packit 79f644
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 79f644
<title>GoaOAuth2Based: GNOME Online Accounts Reference Manual</title>
Packit 79f644
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit 79f644
<link rel="home" href="index.html" title="GNOME Online Accounts Reference Manual">
Packit 79f644
<link rel="up" href="ref-library-generated.html" title="Generated Code">
Packit 79f644
<link rel="prev" href="GoaOAuthBased.html" title="GoaOAuthBased">
Packit 79f644
<link rel="next" href="GoaPasswordBased.html" title="GoaPasswordBased">
Packit 79f644
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
Packit 79f644
<link rel="stylesheet" href="style.css" type="text/css">
Packit 79f644
</head>
Packit 79f644
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 79f644
Packit 79f644
Packit 79f644
Top  | 
Packit 79f644
                  Description  | 
Packit 79f644
                  Object Hierarchy  | 
Packit 79f644
                  Implemented Interfaces  | 
Packit 79f644
                  Prerequisites  | 
Packit 79f644
                  Known Implementations  | 
Packit 79f644
                  Properties  | 
Packit 79f644
                  Signals
Packit 79f644
Packit 79f644
Home
Packit 79f644
Up
Packit 79f644
Prev
Packit 79f644
Next
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

GoaOAuth2Based

Packit 79f644

GoaOAuth2Based — Generated C code for the org.gnome.OnlineAccounts.OAuth2Based D-Bus interface

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Functions

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
GDBusInterfaceInfo *
Packit 79f644
Packit 79f644
Packit 79f644
goa_oauth2_based_interface_info ()
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
guint
Packit 79f644
Packit 79f644
Packit 79f644
goa_oauth2_based_override_properties ()
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
const gchar *
Packit 79f644
Packit 79f644
Packit 79f644
goa_oauth2_based_get_client_id ()
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
void
Packit 79f644
Packit 79f644
Packit 79f644
goa_oauth2_based_set_client_id ()
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
gchar *
Packit 79f644
Packit 79f644
Packit 79f644
goa_oauth2_based_dup_client_id ()
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
const gchar *
Packit 79f644
Packit 79f644
Packit 79f644
goa_oauth2_based_get_client_secret ()
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
void
Packit 79f644
Packit 79f644
Packit 79f644
goa_oauth2_based_set_client_secret ()
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
gchar *
Packit 79f644
Packit 79f644
Packit 79f644
goa_oauth2_based_dup_client_secret ()
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
void
Packit 79f644
Packit 79f644
Packit 79f644
goa_oauth2_based_call_get_access_token ()
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
gboolean
Packit 79f644
Packit 79f644
Packit 79f644
goa_oauth2_based_call_get_access_token_finish ()
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
gboolean
Packit 79f644
Packit 79f644
Packit 79f644
goa_oauth2_based_call_get_access_token_sync ()
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
void
Packit 79f644
Packit 79f644
Packit 79f644
goa_oauth2_based_complete_get_access_token ()
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
void
Packit 79f644
Packit 79f644
Packit 79f644
goa_oauth2_based_proxy_new ()
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
GoaOAuth2Based *
Packit 79f644
Packit 79f644
Packit 79f644
goa_oauth2_based_proxy_new_finish ()
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
GoaOAuth2Based *
Packit 79f644
Packit 79f644
Packit 79f644
goa_oauth2_based_proxy_new_sync ()
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
void
Packit 79f644
Packit 79f644
Packit 79f644
goa_oauth2_based_proxy_new_for_bus ()
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
GoaOAuth2Based *
Packit 79f644
Packit 79f644
Packit 79f644
goa_oauth2_based_proxy_new_for_bus_finish ()
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
GoaOAuth2Based *
Packit 79f644
Packit 79f644
Packit 79f644
goa_oauth2_based_proxy_new_for_bus_sync ()
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
GoaOAuth2Based *
Packit 79f644
Packit 79f644
Packit 79f644
goa_oauth2_based_skeleton_new ()
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Properties

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
gchar *
Packit 79f644
client-id
Packit 79f644
Read / Write
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
gchar *
Packit 79f644
client-secret
Packit 79f644
Read / Write
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Signals

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
gboolean
Packit 79f644
handle-get-access-token
Packit 79f644
Run Last
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Types and Values

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
 
Packit 79f644
GoaOAuth2Based
Packit 79f644
Packit 79f644
Packit 79f644
struct
Packit 79f644
GoaOAuth2BasedIface
Packit 79f644
Packit 79f644
Packit 79f644
struct
Packit 79f644
GoaOAuth2BasedProxy
Packit 79f644
Packit 79f644
Packit 79f644
struct
Packit 79f644
GoaOAuth2BasedProxyClass
Packit 79f644
Packit 79f644
Packit 79f644
struct
Packit 79f644
GoaOAuth2BasedSkeleton
Packit 79f644
Packit 79f644
Packit 79f644
struct
Packit 79f644
GoaOAuth2BasedSkeletonClass
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Object Hierarchy

Packit 79f644
    GInterface
Packit 79f644
    ╰── GoaOAuth2Based
Packit 79f644
    GObject
Packit 79f644
    ├── GDBusInterfaceSkeleton
Packit 79f644
       ╰── GoaOAuth2BasedSkeleton
Packit 79f644
    ╰── GDBusProxy
Packit 79f644
        ╰── GoaOAuth2BasedProxy
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Prerequisites

Packit 79f644

Packit 79f644
GoaOAuth2Based requires
Packit 79f644
 GObject.

Packit 79f644
Packit 79f644
Packit 79f644

Implemented Interfaces

Packit 79f644

Packit 79f644
GoaOAuth2BasedProxy implements
Packit 79f644
 GDBusInterface,  GInitable,  GAsyncInitable and  GoaOAuth2Based.

Packit 79f644

Packit 79f644
GoaOAuth2BasedSkeleton implements
Packit 79f644
 GDBusInterface and  GoaOAuth2Based.

Packit 79f644
Packit 79f644
Packit 79f644

Known Implementations

Packit 79f644

Packit 79f644
GoaOAuth2Based is implemented by
Packit 79f644
 GoaOAuth2BasedProxy and  GoaOAuth2BasedSkeleton.

Packit 79f644
Packit 79f644
Packit 79f644

Description

Packit 79f644

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

Packit 79f644
Packit 79f644
Packit 79f644

Functions

Packit 79f644
Packit 79f644

goa_oauth2_based_interface_info ()

Packit 79f644
GDBusInterfaceInfo *
Packit 79f644
goa_oauth2_based_interface_info (void);
Packit 79f644

Gets a machine-readable description of the org.gnome.OnlineAccounts.OAuth2Based D-Bus interface.

Packit 79f644
Packit 79f644

Returns

Packit 79f644

A GDBusInterfaceInfo. Do not free.

Packit 79f644

[transfer none]

Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

goa_oauth2_based_override_properties ()

Packit 79f644
guint
Packit 79f644
goa_oauth2_based_override_properties (GObjectClass *klass,
Packit 79f644
                                      guint property_id_begin);
Packit 79f644

Overrides all GObject properties in the GoaOAuth2Based interface for a concrete class.

Packit 79f644
The properties are overridden in the order they are defined.

Packit 79f644
Packit 79f644

Parameters

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

klass

Packit 79f644

The class structure for a GObject derived class.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

property_id_begin

Packit 79f644

The property id to assign to the first overridden property.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Returns

Packit 79f644

The last property id.

Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

goa_oauth2_based_get_client_id ()

Packit 79f644
const gchar *
Packit 79f644
goa_oauth2_based_get_client_id (GoaOAuth2Based *object);
Packit 79f644

Gets the value of the "ClientId" D-Bus property.

Packit 79f644

Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.

Packit 79f644
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.
Packit 79f644

[skip]

Packit 79f644
Packit 79f644

Parameters

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

object

Packit 79f644

A GoaOAuth2Based.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Returns

Packit 79f644

The property value or NULL if the property is not set. Do not free the returned value, it belongs to object

Packit 79f644
. 

Packit 79f644

[transfer none]

Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

goa_oauth2_based_set_client_id ()

Packit 79f644
void
Packit 79f644
goa_oauth2_based_set_client_id (GoaOAuth2Based *object,
Packit 79f644
                                const gchar *value);
Packit 79f644

Sets the "ClientId" D-Bus property to value

Packit 79f644
.

Packit 79f644

Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.

Packit 79f644

[skip]

Packit 79f644
Packit 79f644

Parameters

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

object

Packit 79f644

A GoaOAuth2Based.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

value

Packit 79f644

The value to set.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

goa_oauth2_based_dup_client_id ()

Packit 79f644
gchar *
Packit 79f644
goa_oauth2_based_dup_client_id (GoaOAuth2Based *object);
Packit 79f644

Gets a copy of the "ClientId" D-Bus property.

Packit 79f644

Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.

Packit 79f644

[skip]

Packit 79f644
Packit 79f644

Parameters

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

object

Packit 79f644

A GoaOAuth2Based.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Returns

Packit 79f644

The property value or NULL if the property is not set. The returned value should be freed with g_free().

Packit 79f644

[transfer full]

Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

goa_oauth2_based_get_client_secret ()

Packit 79f644
const gchar *
Packit 79f644
goa_oauth2_based_get_client_secret (GoaOAuth2Based *object);
Packit 79f644

Gets the value of the "ClientSecret" D-Bus property.

Packit 79f644

Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.

Packit 79f644
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.
Packit 79f644

[skip]

Packit 79f644
Packit 79f644

Parameters

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

object

Packit 79f644

A GoaOAuth2Based.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Returns

Packit 79f644

The property value or NULL if the property is not set. Do not free the returned value, it belongs to object

Packit 79f644
. 

Packit 79f644

[transfer none]

Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

goa_oauth2_based_set_client_secret ()

Packit 79f644
void
Packit 79f644
goa_oauth2_based_set_client_secret (GoaOAuth2Based *object,
Packit 79f644
                                    const gchar *value);
Packit 79f644

Sets the "ClientSecret" D-Bus property to value

Packit 79f644
.

Packit 79f644

Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.

Packit 79f644

[skip]

Packit 79f644
Packit 79f644

Parameters

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

object

Packit 79f644

A GoaOAuth2Based.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

value

Packit 79f644

The value to set.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

goa_oauth2_based_dup_client_secret ()

Packit 79f644
gchar *
Packit 79f644
goa_oauth2_based_dup_client_secret (GoaOAuth2Based *object);
Packit 79f644

Gets a copy of the "ClientSecret" D-Bus property.

Packit 79f644

Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.

Packit 79f644

[skip]

Packit 79f644
Packit 79f644

Parameters

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

object

Packit 79f644

A GoaOAuth2Based.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Returns

Packit 79f644

The property value or NULL if the property is not set. The returned value should be freed with g_free().

Packit 79f644

[transfer full]

Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

goa_oauth2_based_call_get_access_token ()

Packit 79f644
void
Packit 79f644
goa_oauth2_based_call_get_access_token
Packit 79f644
                               (GoaOAuth2Based *proxy,
Packit 79f644
                                GCancellable *cancellable,
Packit 79f644
                                GAsyncReadyCallback callback,
Packit 79f644
                                gpointer user_data);
Packit 79f644

Asynchronously invokes the GetAccessToken() D-Bus method on proxy

Packit 79f644
.
Packit 79f644
When the operation is finished, callback
Packit 79f644
 will be invoked in the thread-default main loop of the thread you are calling this method from.
Packit 79f644
You can then call goa_oauth2_based_call_get_access_token_finish() to get the result of the operation.

Packit 79f644

See goa_oauth2_based_call_get_access_token_sync() for the synchronous, blocking version of this method.

Packit 79f644
Packit 79f644

Parameters

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

proxy

Packit 79f644

A GoaOAuth2BasedProxy.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

cancellable

Packit 79f644

A GCancellable or NULL.

Packit 79f644
[nullable]
Packit 79f644
Packit 79f644
Packit 79f644

callback

Packit 79f644

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

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

user_data

Packit 79f644

User data to pass to callback

Packit 79f644
.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

goa_oauth2_based_call_get_access_token_finish ()

Packit 79f644
gboolean
Packit 79f644
goa_oauth2_based_call_get_access_token_finish
Packit 79f644
                               (GoaOAuth2Based *proxy,
Packit 79f644
                                gchar **out_access_token,
Packit 79f644
                                gint *out_expires_in,
Packit 79f644
                                GAsyncResult *res,
Packit 79f644
                                GError **error);
Packit 79f644

Finishes an operation started with goa_oauth2_based_call_get_access_token().

Packit 79f644
Packit 79f644

Parameters

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

proxy

Packit 79f644

A GoaOAuth2BasedProxy.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

out_access_token

Packit 79f644

Return location for return parameter or NULL to ignore.

Packit 79f644
[out]
Packit 79f644
Packit 79f644
Packit 79f644

out_expires_in

Packit 79f644

Return location for return parameter or NULL to ignore.

Packit 79f644
[out]
Packit 79f644
Packit 79f644
Packit 79f644

res

Packit 79f644

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

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

error

Packit 79f644

Return location for error or NULL.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Returns

Packit 79f644

TRUE if the call succeded, FALSE if error

Packit 79f644
is set. 

Packit 79f644

[skip]

Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

goa_oauth2_based_call_get_access_token_sync ()

Packit 79f644
gboolean
Packit 79f644
goa_oauth2_based_call_get_access_token_sync
Packit 79f644
                               (GoaOAuth2Based *proxy,
Packit 79f644
                                gchar **out_access_token,
Packit 79f644
                                gint *out_expires_in,
Packit 79f644
                                GCancellable *cancellable,
Packit 79f644
                                GError **error);
Packit 79f644

Synchronously invokes the GetAccessToken() D-Bus method on proxy

Packit 79f644
. The calling thread is blocked until a reply is received.

Packit 79f644

See goa_oauth2_based_call_get_access_token() for the asynchronous version of this method.

Packit 79f644
Packit 79f644

Parameters

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

proxy

Packit 79f644

A GoaOAuth2BasedProxy.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

out_access_token

Packit 79f644

Return location for return parameter or NULL to ignore.

Packit 79f644
[out]
Packit 79f644
Packit 79f644
Packit 79f644

out_expires_in

Packit 79f644

Return location for return parameter or NULL to ignore.

Packit 79f644
[out]
Packit 79f644
Packit 79f644
Packit 79f644

cancellable

Packit 79f644

A GCancellable or NULL.

Packit 79f644
[nullable]
Packit 79f644
Packit 79f644
Packit 79f644

error

Packit 79f644

Return location for error or NULL.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Returns

Packit 79f644

TRUE if the call succeded, FALSE if error

Packit 79f644
is set. 

Packit 79f644

[skip]

Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

goa_oauth2_based_complete_get_access_token ()

Packit 79f644
void
Packit 79f644
goa_oauth2_based_complete_get_access_token
Packit 79f644
                               (GoaOAuth2Based *object,
Packit 79f644
                                GDBusMethodInvocation *invocation,
Packit 79f644
                                const gchar *access_token,
Packit 79f644
                                gint expires_in);
Packit 79f644

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.

Packit 79f644

This method will free invocation

Packit 79f644
, you cannot use it afterwards.

Packit 79f644
Packit 79f644

Parameters

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

object

Packit 79f644

A GoaOAuth2Based.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

invocation

Packit 79f644

A GDBusMethodInvocation.

Packit 79f644
[transfer full]
Packit 79f644
Packit 79f644
Packit 79f644

access_token

Packit 79f644

Parameter to return.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

expires_in

Packit 79f644

Parameter to return.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

goa_oauth2_based_proxy_new ()

Packit 79f644
void
Packit 79f644
goa_oauth2_based_proxy_new (GDBusConnection *connection,
Packit 79f644
                            GDBusProxyFlags flags,
Packit 79f644
                            const gchar *name,
Packit 79f644
                            const gchar *object_path,
Packit 79f644
                            GCancellable *cancellable,
Packit 79f644
                            GAsyncReadyCallback callback,
Packit 79f644
                            gpointer user_data);
Packit 79f644

Asynchronously creates a proxy for the D-Bus interface org.gnome.OnlineAccounts.OAuth2Based. See g_dbus_proxy_new() for more details.

Packit 79f644

When the operation is finished, callback

Packit 79f644
 will be invoked in the thread-default main loop of the thread you are calling this method from.
Packit 79f644
You can then call goa_oauth2_based_proxy_new_finish() to get the result of the operation.

Packit 79f644

See goa_oauth2_based_proxy_new_sync() for the synchronous, blocking version of this constructor.

Packit 79f644
Packit 79f644

Parameters

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

connection

Packit 79f644

A GDBusConnection.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

flags

Packit 79f644

Flags from the GDBusProxyFlags enumeration.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

name

Packit 79f644

A bus name (well-known or unique) or NULL if connection

Packit 79f644
is not a message bus connection. 

Packit 79f644
[nullable]
Packit 79f644
Packit 79f644
Packit 79f644

object_path

Packit 79f644

An object path.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

cancellable

Packit 79f644

A GCancellable or NULL.

Packit 79f644
[nullable]
Packit 79f644
Packit 79f644
Packit 79f644

callback

Packit 79f644

A GAsyncReadyCallback to call when the request is satisfied.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

user_data

Packit 79f644

User data to pass to callback

Packit 79f644
.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

goa_oauth2_based_proxy_new_finish ()

Packit 79f644
GoaOAuth2Based *
Packit 79f644
goa_oauth2_based_proxy_new_finish (GAsyncResult *res,
Packit 79f644
                                   GError **error);
Packit 79f644

Finishes an operation started with goa_oauth2_based_proxy_new().

Packit 79f644
Packit 79f644

Parameters

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

res

Packit 79f644

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

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

error

Packit 79f644

Return location for error or NULL

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Returns

Packit 79f644

The constructed proxy object or NULL if error

Packit 79f644
is set. 

Packit 79f644

[transfer full][type GoaOAuth2BasedProxy]

Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

goa_oauth2_based_proxy_new_sync ()

Packit 79f644
GoaOAuth2Based *
Packit 79f644
goa_oauth2_based_proxy_new_sync (GDBusConnection *connection,
Packit 79f644
                                 GDBusProxyFlags flags,
Packit 79f644
                                 const gchar *name,
Packit 79f644
                                 const gchar *object_path,
Packit 79f644
                                 GCancellable *cancellable,
Packit 79f644
                                 GError **error);
Packit 79f644

Synchronously creates a proxy for the D-Bus interface org.gnome.OnlineAccounts.OAuth2Based. See g_dbus_proxy_new_sync() for more details.

Packit 79f644

The calling thread is blocked until a reply is received.

Packit 79f644

See goa_oauth2_based_proxy_new() for the asynchronous version of this constructor.

Packit 79f644
Packit 79f644

Parameters

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

connection

Packit 79f644

A GDBusConnection.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

flags

Packit 79f644

Flags from the GDBusProxyFlags enumeration.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

name

Packit 79f644

A bus name (well-known or unique) or NULL if connection

Packit 79f644
is not a message bus connection. 

Packit 79f644
[nullable]
Packit 79f644
Packit 79f644
Packit 79f644

object_path

Packit 79f644

An object path.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

cancellable

Packit 79f644

A GCancellable or NULL.

Packit 79f644
[nullable]
Packit 79f644
Packit 79f644
Packit 79f644

error

Packit 79f644

Return location for error or NULL

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Returns

Packit 79f644

The constructed proxy object or NULL if error

Packit 79f644
is set. 

Packit 79f644

[transfer full][type GoaOAuth2BasedProxy]

Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

goa_oauth2_based_proxy_new_for_bus ()

Packit 79f644
void
Packit 79f644
goa_oauth2_based_proxy_new_for_bus (GBusType bus_type,
Packit 79f644
                                    GDBusProxyFlags flags,
Packit 79f644
                                    const gchar *name,
Packit 79f644
                                    const gchar *object_path,
Packit 79f644
                                    GCancellable *cancellable,
Packit 79f644
                                    GAsyncReadyCallback callback,
Packit 79f644
                                    gpointer user_data);
Packit 79f644

Like goa_oauth2_based_proxy_new() but takes a GBusType instead of a GDBusConnection.

Packit 79f644

When the operation is finished, callback

Packit 79f644
 will be invoked in the thread-default main loop of the thread you are calling this method from.
Packit 79f644
You can then call goa_oauth2_based_proxy_new_for_bus_finish() to get the result of the operation.

Packit 79f644

See goa_oauth2_based_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor.

Packit 79f644
Packit 79f644

Parameters

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

bus_type

Packit 79f644

A GBusType.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

flags

Packit 79f644

Flags from the GDBusProxyFlags enumeration.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

name

Packit 79f644

A bus name (well-known or unique).

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

object_path

Packit 79f644

An object path.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

cancellable

Packit 79f644

A GCancellable or NULL.

Packit 79f644
[nullable]
Packit 79f644
Packit 79f644
Packit 79f644

callback

Packit 79f644

A GAsyncReadyCallback to call when the request is satisfied.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

user_data

Packit 79f644

User data to pass to callback

Packit 79f644
.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

goa_oauth2_based_proxy_new_for_bus_finish ()

Packit 79f644
GoaOAuth2Based *
Packit 79f644
goa_oauth2_based_proxy_new_for_bus_finish
Packit 79f644
                               (GAsyncResult *res,
Packit 79f644
                                GError **error);
Packit 79f644

Finishes an operation started with goa_oauth2_based_proxy_new_for_bus().

Packit 79f644
Packit 79f644

Parameters

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

res

Packit 79f644

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

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

error

Packit 79f644

Return location for error or NULL

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Returns

Packit 79f644

The constructed proxy object or NULL if error

Packit 79f644
is set. 

Packit 79f644

[transfer full][type GoaOAuth2BasedProxy]

Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

goa_oauth2_based_proxy_new_for_bus_sync ()

Packit 79f644
GoaOAuth2Based *
Packit 79f644
goa_oauth2_based_proxy_new_for_bus_sync
Packit 79f644
                               (GBusType bus_type,
Packit 79f644
                                GDBusProxyFlags flags,
Packit 79f644
                                const gchar *name,
Packit 79f644
                                const gchar *object_path,
Packit 79f644
                                GCancellable *cancellable,
Packit 79f644
                                GError **error);
Packit 79f644

Like goa_oauth2_based_proxy_new_sync() but takes a GBusType instead of a GDBusConnection.

Packit 79f644

The calling thread is blocked until a reply is received.

Packit 79f644

See goa_oauth2_based_proxy_new_for_bus() for the asynchronous version of this constructor.

Packit 79f644
Packit 79f644

Parameters

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

bus_type

Packit 79f644

A GBusType.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

flags

Packit 79f644

Flags from the GDBusProxyFlags enumeration.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

name

Packit 79f644

A bus name (well-known or unique).

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

object_path

Packit 79f644

An object path.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

cancellable

Packit 79f644

A GCancellable or NULL.

Packit 79f644
[nullable]
Packit 79f644
Packit 79f644
Packit 79f644

error

Packit 79f644

Return location for error or NULL

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Returns

Packit 79f644

The constructed proxy object or NULL if error

Packit 79f644
is set. 

Packit 79f644

[transfer full][type GoaOAuth2BasedProxy]

Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

goa_oauth2_based_skeleton_new ()

Packit 79f644
GoaOAuth2Based *
Packit 79f644
goa_oauth2_based_skeleton_new (void);
Packit 79f644

Creates a skeleton object for the D-Bus interface org.gnome.OnlineAccounts.OAuth2Based.

Packit 79f644
Packit 79f644

Returns

Packit 79f644

The skeleton object.

Packit 79f644

[transfer full][type GoaOAuth2BasedSkeleton]

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Types and Values

Packit 79f644
Packit 79f644

GoaOAuth2Based

Packit 79f644
typedef struct _GoaOAuth2Based GoaOAuth2Based;
Packit 79f644

Abstract interface type for the D-Bus interface org.gnome.OnlineAccounts.OAuth2Based.

Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

struct GoaOAuth2BasedIface

Packit 79f644
struct GoaOAuth2BasedIface {
Packit 79f644
  GTypeInterface parent_iface;
Packit 79f644
Packit 79f644
Packit 79f644
  gboolean (*handle_get_access_token) (
Packit 79f644
    GoaOAuth2Based *object,
Packit 79f644
    GDBusMethodInvocation *invocation);
Packit 79f644
Packit 79f644
  const gchar * (*get_client_id) (GoaOAuth2Based *object);
Packit 79f644
Packit 79f644
  const gchar * (*get_client_secret) (GoaOAuth2Based *object);
Packit 79f644
};
Packit 79f644
Packit 79f644

Virtual table for the D-Bus interface org.gnome.OnlineAccounts.OAuth2Based.

Packit 79f644
Packit 79f644

Members

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

GTypeInterface parent_iface;

Packit 79f644

The parent interface.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

handle_get_access_token ()

Packit 79f644

Handler for the “handle-get-access-token” signal.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

get_client_id ()

Packit 79f644

Getter for the “client-id” property.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

get_client_secret ()

Packit 79f644

Getter for the “client-secret” property.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

struct GoaOAuth2BasedProxy

Packit 79f644
struct GoaOAuth2BasedProxy;
Packit 79f644

The GoaOAuth2BasedProxy structure contains only private data and should only be accessed using the provided API.

Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

struct GoaOAuth2BasedProxyClass

Packit 79f644
struct GoaOAuth2BasedProxyClass {
Packit 79f644
  GDBusProxyClass parent_class;
Packit 79f644
};
Packit 79f644
Packit 79f644

Class structure for GoaOAuth2BasedProxy.

Packit 79f644
Packit 79f644

Members

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

struct GoaOAuth2BasedSkeleton

Packit 79f644
struct GoaOAuth2BasedSkeleton;
Packit 79f644

The GoaOAuth2BasedSkeleton structure contains only private data and should only be accessed using the provided API.

Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

struct GoaOAuth2BasedSkeletonClass

Packit 79f644
struct GoaOAuth2BasedSkeletonClass {
Packit 79f644
  GDBusInterfaceSkeletonClass parent_class;
Packit 79f644
};
Packit 79f644
Packit 79f644

Class structure for GoaOAuth2BasedSkeleton.

Packit 79f644
Packit 79f644

Members

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Property Details

Packit 79f644
Packit 79f644

The “client-id” property

Packit 79f644
  “client-id”                gchar *
Packit 79f644

Represents the D-Bus property "ClientId".

Packit 79f644

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.

Packit 79f644

Flags: Read / Write

Packit 79f644

Default value: NULL

Packit 79f644
Packit 79f644

Packit 79f644
Packit 79f644

The “client-secret” property

Packit 79f644
  “client-secret”            gchar *
Packit 79f644

Represents the D-Bus property "ClientSecret".

Packit 79f644

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.

Packit 79f644

Flags: Read / Write

Packit 79f644

Default value: NULL

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Signal Details

Packit 79f644
Packit 79f644

The “handle-get-access-token” signal

Packit 79f644
gboolean
Packit 79f644
user_function (GoaOAuth2Based        *object,
Packit 79f644
               GDBusMethodInvocation *invocation,
Packit 79f644
               gpointer               user_data)
Packit 79f644

Signal emitted when a remote caller is invoking the GetAccessToken() D-Bus method.

Packit 79f644

If a signal handler returns TRUE, it means the signal handler will handle the invocation (e.g. take a reference to invocation

Packit 79f644
 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.

Packit 79f644
Packit 79f644

Parameters

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

object

Packit 79f644

A GoaOAuth2Based.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

invocation

Packit 79f644

A GDBusMethodInvocation.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644

user_data

Packit 79f644

user data set when the signal handler was connected.

Packit 79f644
 
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Returns

Packit 79f644

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

Packit 79f644
Packit 79f644

Flags: Run Last

Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644
Packit 79f644

Generated by GTK-Doc V1.28
Packit 79f644
</body>
Packit 79f644
</html>