Blame docs/reference/html/GDataOAuth1Authorizer.html

Packit 4b6dd7
Packit 4b6dd7
<html>
Packit 4b6dd7
<head>
Packit 4b6dd7
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 4b6dd7
<title>GDataOAuth1Authorizer: GData Reference Manual</title>
Packit 4b6dd7
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit 4b6dd7
<link rel="home" href="index.html" title="GData Reference Manual">
Packit 4b6dd7
<link rel="up" href="ch05.html" title="Authentication/Authorization API">
Packit 4b6dd7
<link rel="prev" href="GDataGoaAuthorizer.html" title="GDataGoaAuthorizer">
Packit 4b6dd7
<link rel="next" href="GDataOAuth2Authorizer.html" title="GDataOAuth2Authorizer">
Packit 4b6dd7
<meta name="generator" content="GTK-Doc V1.26.1 (XML mode)">
Packit 4b6dd7
<link rel="stylesheet" href="style.css" type="text/css">
Packit 4b6dd7
</head>
Packit 4b6dd7
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Top  | 
Packit 4b6dd7
                  Description  | 
Packit 4b6dd7
                  Object Hierarchy  | 
Packit 4b6dd7
                  Implemented Interfaces  | 
Packit 4b6dd7
                  Properties
Packit 4b6dd7
Packit 4b6dd7
Home
Packit 4b6dd7
Up
Packit 4b6dd7
Prev
Packit 4b6dd7
Next
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDataOAuth1Authorizer

Packit 4b6dd7

GDataOAuth1Authorizer — GData OAuth 1.0 authorization interface

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Stability Level

Packit 4b6dd7
Packit 4b6dd7
develop applications to these interfaces, release them, and have confidence that
Packit 4b6dd7
they will run on all minor releases of the product (after the one in which the
Packit 4b6dd7
interface was introduced, and within the same major release). Even at a major
Packit 4b6dd7
release, incompatible changes are expected to be rare, and to have strong
Packit 4b6dd7
justifications.
Packit 4b6dd7
">Stable, unless otherwise indicated
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Functions

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataOAuth1Authorizer *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_oauth1_authorizer_new ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataOAuth1Authorizer *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_oauth1_authorizer_new_for_authorization_domains ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gchar *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_oauth1_authorizer_request_authentication_uri ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_oauth1_authorizer_request_authentication_uri_async ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gchar *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_oauth1_authorizer_request_authentication_uri_finish ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_oauth1_authorizer_request_authorization ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_oauth1_authorizer_request_authorization_async ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_oauth1_authorizer_request_authorization_finish ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
const gchar *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_oauth1_authorizer_get_application_name ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
const gchar *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_oauth1_authorizer_get_locale ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_oauth1_authorizer_set_locale ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
SoupURI *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_oauth1_authorizer_get_proxy_uri ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_oauth1_authorizer_set_proxy_uri ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GProxyResolver *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_oauth1_authorizer_get_proxy_resolver ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_oauth1_authorizer_set_proxy_resolver ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
guint
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_oauth1_authorizer_get_timeout ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_oauth1_authorizer_set_timeout ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Properties

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gchar *
Packit 4b6dd7
application-name
Packit 4b6dd7
Read / Write / Construct Only
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gchar *
Packit 4b6dd7
locale
Packit 4b6dd7
Read / Write
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GProxyResolver *
Packit 4b6dd7
proxy-resolver
Packit 4b6dd7
Read / Write
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
SoupURI *
Packit 4b6dd7
proxy-uri
Packit 4b6dd7
Read / Write
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
guint
Packit 4b6dd7
timeout
Packit 4b6dd7
Read / Write
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Types and Values

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
GDataOAuth1Authorizer
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
GDataOAuth1AuthorizerClass
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Object Hierarchy

Packit 4b6dd7
    GObject
Packit 4b6dd7
    ╰── GDataOAuth1Authorizer
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Implemented Interfaces

Packit 4b6dd7

Packit 4b6dd7
GDataOAuth1Authorizer implements
Packit 4b6dd7
 GDataAuthorizer.

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Includes

Packit 4b6dd7
#include <gdata/gdata-oauth1-authorizer.h>
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Description

Packit 4b6dd7

GDataOAuth1Authorizer provides an implementation of the GDataAuthorizer interface for authentication and authorization using the

Packit 4b6dd7
OAuth 1.0 process,
Packit 4b6dd7

which was preferred by Google until OAuth 2.0 was released — it is now

Packit 4b6dd7
preferred to use GDataOAuth2Authorizer.

Packit 4b6dd7

OAuth 1.0 replaces the deprecated ClientLogin process. One of the main reasons for this is to allow two-factor authentication to be supported, by

Packit 4b6dd7
moving the authentication interface to a web page under Google's control.

Packit 4b6dd7

The OAuth 1.0 process as implemented by Google follows the OAuth 1.0 protocol as

Packit 4b6dd7
specified by IETF in RFC 5849, with a few additions to support scopes (implemented in libgdata by GDataAuthorizationDomains),
Packit 4b6dd7
locales and custom domains. Briefly, the process is initiated by requesting an authenticated request token from the Google accounts service
Packit 4b6dd7
(using gdata_oauth1_authorizer_request_authentication_uri()), going to the authentication URI for the request token, authenticating and authorizing
Packit 4b6dd7
access to the desired scopes, then providing the verifier returned by Google to the Google accounts service again (using
Packit 4b6dd7
gdata_oauth1_authorizer_request_authorization()) to authorize the token. This results in an access token which is attached to all future requests
Packit 4b6dd7
to the online service.

Packit 4b6dd7

While Google supports unregistered and registered modes for OAuth 1.0 authorization, it only supports unregistered mode for installed applications.

Packit 4b6dd7
Consequently, libgdata also only supports unregistered mode. For this purpose, the application name to be presented to the user on the
Packit 4b6dd7
authentication page at the URI returned by gdata_oauth1_authorizer_request_authentication_uri() can be specified when constructing the
Packit 4b6dd7
GDataOAuth1Authorizer.

Packit 4b6dd7

As described, each authentication/authorization operation is in two parts: gdata_oauth1_authorizer_request_authentication_uri() and

Packit 4b6dd7
gdata_oauth1_authorizer_request_authorization(). GDataOAuth1Authorizer stores no state about ongoing authentication operations (i.e. ones which
Packit 4b6dd7
have successfully called gdata_oauth1_authorizer_request_authentication_uri(), but are yet to successfully call
Packit 4b6dd7
gdata_oauth1_authorizer_request_authorization()). Consequently, operations can be abandoned before calling
Packit 4b6dd7
gdata_oauth1_authorizer_request_authorization() without problems. The only state necessary between the calls is the request token and request token
Packit 4b6dd7
secret, as returned by gdata_oauth1_authorizer_request_authentication_uri() and taken as parameters to
Packit 4b6dd7
gdata_oauth1_authorizer_request_authorization().

Packit 4b6dd7

GDataOAuth1Authorizer natively supports authorization against multiple services in a single authorization request (unlike

Packit 4b6dd7
GDataClientLoginAuthorizer).

Packit 4b6dd7

Each access token is long lived, so reauthorization is rarely necessary with GDataOAuth1Authorizer. Consequently, refreshing authorization using

Packit 4b6dd7
gdata_authorizer_refresh_authorization() is not supported by GDataOAuth1Authorizer, and will immediately return FALSE with no error set.

Packit 4b6dd7
Packit 4b6dd7

Example 8. Authenticating Asynchronously Using OAuth 1.0

Packit 4b6dd7
Packit 4b6dd7
  
Packit 4b6dd7
    
Packit 4b6dd7
      
Packit 4b6dd7
        
1
Packit 4b6dd7
2
Packit 4b6dd7
3
Packit 4b6dd7
4
Packit 4b6dd7
5
Packit 4b6dd7
6
Packit 4b6dd7
7
Packit 4b6dd7
8
Packit 4b6dd7
9
Packit 4b6dd7
10
Packit 4b6dd7
11
Packit 4b6dd7
12
Packit 4b6dd7
13
Packit 4b6dd7
14
Packit 4b6dd7
15
Packit 4b6dd7
16
Packit 4b6dd7
17
Packit 4b6dd7
18
Packit 4b6dd7
19
Packit 4b6dd7
20
Packit 4b6dd7
21
Packit 4b6dd7
22
Packit 4b6dd7
23
Packit 4b6dd7
24
Packit 4b6dd7
25
Packit 4b6dd7
26
Packit 4b6dd7
27
Packit 4b6dd7
28
Packit 4b6dd7
29
Packit 4b6dd7
30
Packit 4b6dd7
31
Packit 4b6dd7
32
Packit 4b6dd7
33
Packit 4b6dd7
34
Packit 4b6dd7
35
Packit 4b6dd7
36
Packit 4b6dd7
37
Packit 4b6dd7
38
Packit 4b6dd7
39
Packit 4b6dd7
40
Packit 4b6dd7
41
Packit 4b6dd7
42
Packit 4b6dd7
43
Packit 4b6dd7
44
Packit 4b6dd7
45
Packit 4b6dd7
46
Packit 4b6dd7
47
Packit 4b6dd7
48
Packit 4b6dd7
49
Packit 4b6dd7
50
Packit 4b6dd7
51
Packit 4b6dd7
52
Packit 4b6dd7
53
Packit 4b6dd7
54
Packit 4b6dd7
55
Packit 4b6dd7
56
Packit 4b6dd7
57
Packit 4b6dd7
58
Packit 4b6dd7
59
Packit 4b6dd7
60
Packit 4b6dd7
61
Packit 4b6dd7
62
Packit 4b6dd7
63
Packit 4b6dd7
64
Packit 4b6dd7
65
Packit 4b6dd7
66
Packit 4b6dd7
67
Packit 4b6dd7
68
Packit 4b6dd7
69
Packit 4b6dd7
70
Packit 4b6dd7
71
Packit 4b6dd7
        
GDataSomeService *service;
Packit 4b6dd7
GDataOAuth1Authorizer *authorizer;
Packit 4b6dd7
Packit 4b6dd7
/* Create an authorizer and authenticate and authorize the service we're using, asynchronously. */
Packit 4b6dd7
authorizer = gdata_oauth1_authorizer_new (_("My libgdata application"), GDATA_TYPE_SOME_SERVICE);
Packit 4b6dd7
gdata_oauth1_authorizer_request_authentication_uri_async (authorizer, cancellable,
Packit 4b6dd7
                                                          (GAsyncReadyCallback) request_authentication_uri_cb, user_data);
Packit 4b6dd7
Packit 4b6dd7
/* Create a service object and link it with the authorizer */
Packit 4b6dd7
service = gdata_some_service_new (GDATA_AUTHORIZER (authorizer));
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
request_authentication_uri_cb (GDataOAuth1Authorizer *authorizer, GAsyncResult *async_result, gpointer user_data)
Packit 4b6dd7
{
Packit 4b6dd7
    gchar *authentication_uri, *token, *token_secret, *verifier;
Packit 4b6dd7
    GError *error = NULL;
Packit 4b6dd7
Packit 4b6dd7
    authentication_uri = gdata_oauth1_authorizer_request_authentication_uri_finish (authorizer, async_result, &token, &token_secret,
Packit 4b6dd7
                                                                                    &error);
Packit 4b6dd7
Packit 4b6dd7
    if (error != NULL) {
Packit 4b6dd7
        /* Notify the user of all errors except cancellation errors */
Packit 4b6dd7
        if (!g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) {
Packit 4b6dd7
            g_error ("Requesting a token failed: %s", error->message);
Packit 4b6dd7
        }
Packit 4b6dd7
Packit 4b6dd7
        g_error_free (error);
Packit 4b6dd7
        goto finish;
Packit 4b6dd7
    }
Packit 4b6dd7
Packit 4b6dd7
    /* (Present the page at the authentication URI to the user, either in an embedded or stand-alone web browser, and
Packit 4b6dd7
     * ask them to grant access to the application and return the verifier Google gives them.) */
Packit 4b6dd7
    verifier = ask_user_for_verifier (authentication_uri);
Packit 4b6dd7
Packit 4b6dd7
    gdata_oauth1_authorizer_request_authorization_async (authorizer, token, token_secret, verifier, cancellable,
Packit 4b6dd7
                                                         (GAsyncReadyCallback) request_authorization_cb, user_data);
Packit 4b6dd7
Packit 4b6dd7
finish:
Packit 4b6dd7
    g_free (verifier);
Packit 4b6dd7
    g_free (authentication_uri);
Packit 4b6dd7
    g_free (token);
Packit 4b6dd7
Packit 4b6dd7
    /* Zero out the secret before freeing. */
Packit 4b6dd7
    if (token_secret != NULL) {
Packit 4b6dd7
        memset (token_secret, 0, strlen (token_secret));
Packit 4b6dd7
    }
Packit 4b6dd7
Packit 4b6dd7
    g_free (token_secret);
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
request_authorization_cb (GDataOAuth1Authorizer *authorizer, GAsyncResult *async_result, gpointer user_data)
Packit 4b6dd7
{
Packit 4b6dd7
    GError *error = NULL;
Packit 4b6dd7
Packit 4b6dd7
    if (gdata_oauth1_authorizer_request_authorization_finish (authorizer, async_result, &error) == FALSE) {
Packit 4b6dd7
        /* Notify the user of all errors except cancellation errors */
Packit 4b6dd7
        if (!g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) {
Packit 4b6dd7
            g_error ("Authorization failed: %s", error->message);
Packit 4b6dd7
        }
Packit 4b6dd7
Packit 4b6dd7
        g_error_free (error);
Packit 4b6dd7
        return;
Packit 4b6dd7
    }
Packit 4b6dd7
Packit 4b6dd7
    /* (The client is now authenticated and authorized against the service.
Packit 4b6dd7
     * It can now proceed to execute queries on the service object which require the user to be authenticated.) */
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
g_object_unref (service);
Packit 4b6dd7
g_object_unref (authorizer);
Packit 4b6dd7
      
Packit 4b6dd7
    
Packit 4b6dd7
  
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Functions

Packit 4b6dd7
Packit 4b6dd7

gdata_oauth1_authorizer_new ()

Packit 4b6dd7
GDataOAuth1Authorizer *
Packit 4b6dd7
gdata_oauth1_authorizer_new (const gchar *application_name,
Packit 4b6dd7
                             GType service_type);
Packit 4b6dd7

Creates a new GDataOAuth1Authorizer.

Packit 4b6dd7

The GDataAuthorizationDomains for the given service_type

Packit 4b6dd7
 (i.e. as returned by gdata_service_get_authorization_domains()) are the ones the
Packit 4b6dd7
user will be requested to authorize access to on the page at the URI returned by gdata_oauth1_authorizer_request_authentication_uri().

Packit 4b6dd7

The given application_name

Packit 4b6dd7
 will set the value of “application-name” and will be displayed to the user on authentication pages
Packit 4b6dd7
returned by Google. If NULL is provided, the value of g_get_application_name() will be used as a fallback.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

application_name

Packit 4b6dd7

a human-readable, translated application name to use on authentication pages, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

service_type

Packit 4b6dd7

the GType of a GDataService subclass which the GDataOAuth1Authorizer will be used with

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

a new GDataOAuth1Authorizer; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_oauth1_authorizer_new_for_authorization_domains ()

Packit 4b6dd7
GDataOAuth1Authorizer *
Packit 4b6dd7
gdata_oauth1_authorizer_new_for_authorization_domains
Packit 4b6dd7
                               (const gchar *application_name,
Packit 4b6dd7
                                GList *authorization_domains);
Packit 4b6dd7

Creates a new GDataOAuth1Authorizer. This function is intended to be used only when the default authorization domain list for a single

Packit 4b6dd7
GDataService, as used by gdata_oauth1_authorizer_new(), isn't suitable. For example, this could be because the GDataOAuth1Authorizer will be used
Packit 4b6dd7
with multiple GDataService subclasses, or because the client requires a specific set of authorization domains.

Packit 4b6dd7

The specified GDataAuthorizationDomains are the ones the user will be requested to authorize access to on the page at the URI returned by

Packit 4b6dd7
gdata_oauth1_authorizer_request_authentication_uri().

Packit 4b6dd7

The given application_name

Packit 4b6dd7
 will set the value of “application-name” and will be displayed to the user on authentication pages
Packit 4b6dd7
returned by Google. If NULL is provided, the value of g_get_application_name() will be used as a fallback.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

application_name

Packit 4b6dd7

a human-readable, translated application name to use on authentication pages, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

authorization_domains

Packit 4b6dd7

a non-empty list of GDataAuthorizationDomains to be

Packit 4b6dd7
authorized against by the GDataOAuth1Authorizer. 

Packit 4b6dd7
[element-type GDataAuthorizationDomain][transfer none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

a new GDataOAuth1Authorizer; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_oauth1_authorizer_request_authentication_uri ()

Packit 4b6dd7
gchar *
Packit 4b6dd7
gdata_oauth1_authorizer_request_authentication_uri
Packit 4b6dd7
                               (GDataOAuth1Authorizer *self,
Packit 4b6dd7
                                gchar **token,
Packit 4b6dd7
                                gchar **token_secret,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GError **error);
Packit 4b6dd7

Requests a fresh unauthenticated token from the Google accounts service and builds and returns the URI of an authentication page for that token.

Packit 4b6dd7
This should then be presented to the user (e.g. in an embedded or stand alone web browser). The authentication page will ask the user to log in
Packit 4b6dd7
using their Google account, then ask them to grant access to the GDataAuthorizationDomains passed to the constructor of the
Packit 4b6dd7
GDataOAuth1Authorizer. If the user grants access, they will be given a verifier, which can then be passed to
Packit 4b6dd7
gdata_oauth1_authorizer_request_authorization() (along with the token
Packit 4b6dd7
 and token_secret
Packit 4b6dd7
 values returned by this method) to authorize the token.

Packit 4b6dd7

This method can fail if the server returns an error, but this is unlikely. If it does happen, a GDATA_SERVICE_ERROR_PROTOCOL_ERROR will be

Packit 4b6dd7
raised, token
Packit 4b6dd7
 and token_secret
Packit 4b6dd7
 will be set to NULL and NULL will be returned.

Packit 4b6dd7

This method implements Section 2.1 and

Packit 4b6dd7
Section 2.2 of the
Packit 4b6dd7
OAuth 1.0 protocol.
Packit 4b6dd7

When freeing token_secret

Packit 4b6dd7
, it's advisable to set it to all zeros first, to reduce the chance of the sensitive token being recoverable from the
Packit 4b6dd7
free memory pool and (accidentally) leaked by a different part of the process. This can be achieved with the following code:

Packit 4b6dd7
Packit 4b6dd7
  
Packit 4b6dd7
    
Packit 4b6dd7
      
Packit 4b6dd7
        
1
Packit 4b6dd7
2
Packit 4b6dd7
3
Packit 4b6dd7
4
Packit 4b6dd7
        
if (token_secret != NULL) {
Packit 4b6dd7
    memset (token_secret, 0, strlen (token_secret));
Packit 4b6dd7
    g_free (token_secret);
Packit 4b6dd7
}
Packit 4b6dd7
      
Packit 4b6dd7
    
Packit 4b6dd7
  
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataOAuth1Authorizer

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

token

Packit 4b6dd7

return location for the temporary credentials token returned by the authentication service; free with g_free().

Packit 4b6dd7
[out callee-allocates]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

token_secret

Packit 4b6dd7

return location for the temporary credentials token secret returned by the authentication service; free with

Packit 4b6dd7
g_free(). 

Packit 4b6dd7
[out callee-allocates]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the URI of an authentication page for the user to use; free with g_free().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_oauth1_authorizer_request_authentication_uri_async ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_oauth1_authorizer_request_authentication_uri_async
Packit 4b6dd7
                               (GDataOAuth1Authorizer *self,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GAsyncReadyCallback callback,
Packit 4b6dd7
                                gpointer user_data);
Packit 4b6dd7

Requests a fresh unauthenticated token from the Google accounts service and builds and returns the URI of an authentication page for that token.

Packit 4b6dd7
self
Packit 4b6dd7
 is reffed when this method is called, so can safely be unreffed after this method returns.

Packit 4b6dd7

For more details, see gdata_oauth1_authorizer_request_authentication_uri(), which is the synchronous version of this method.

Packit 4b6dd7

When the operation is finished, callback

Packit 4b6dd7
 will be called. You can then call gdata_oauth1_authorizer_request_authentication_uri_finish() to get the
Packit 4b6dd7
results of the operation.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataOAuth1Authorizer

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

callback

Packit 4b6dd7

a GAsyncReadyCallback to call when building the URI is finished

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

user_data

Packit 4b6dd7

data to pass to the callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_oauth1_authorizer_request_authentication_uri_finish ()

Packit 4b6dd7
gchar *
Packit 4b6dd7
gdata_oauth1_authorizer_request_authentication_uri_finish
Packit 4b6dd7
                               (GDataOAuth1Authorizer *self,
Packit 4b6dd7
                                GAsyncResult *async_result,
Packit 4b6dd7
                                gchar **token,
Packit 4b6dd7
                                gchar **token_secret,
Packit 4b6dd7
                                GError **error);
Packit 4b6dd7

Finishes an asynchronous authentication URI building operation started with gdata_oauth1_authorizer_request_authentication_uri_async().

Packit 4b6dd7

This method can fail if the server has returned an error, but this is unlikely. If it does happen, a GDATA_SERVICE_ERROR_PROTOCOL_ERROR will be

Packit 4b6dd7
raised, token
Packit 4b6dd7
 and token_secret
Packit 4b6dd7
 will be set to NULL and NULL will be returned.

Packit 4b6dd7

When freeing token_secret

Packit 4b6dd7
, it's advisable to set it to all zeros first, to reduce the chance of the sensitive token being recoverable from the
Packit 4b6dd7
free memory pool and (accidentally) leaked by a different part of the process. This can be achieved with the following code:

Packit 4b6dd7
Packit 4b6dd7
  
Packit 4b6dd7
    
Packit 4b6dd7
      
Packit 4b6dd7
        
1
Packit 4b6dd7
2
Packit 4b6dd7
3
Packit 4b6dd7
4
Packit 4b6dd7
        
if (token_secret != NULL) {
Packit 4b6dd7
    memset (token_secret, 0, strlen (token_secret));
Packit 4b6dd7
    g_free (token_secret);
Packit 4b6dd7
}
Packit 4b6dd7
      
Packit 4b6dd7
    
Packit 4b6dd7
  
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataOAuth1Authorizer

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

async_result

Packit 4b6dd7

a GAsyncResult

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

token

Packit 4b6dd7

return location for the temporary credentials token returned by the authentication service; free with g_free().

Packit 4b6dd7
[out callee-allocates]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

token_secret

Packit 4b6dd7

return location for the temporary credentials token secret returned by the authentication service; free with

Packit 4b6dd7
g_free(). 

Packit 4b6dd7
[out callee-allocates]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the URI of an authentication page for the user to use; free with g_free().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_oauth1_authorizer_request_authorization ()

Packit 4b6dd7
gboolean
Packit 4b6dd7
gdata_oauth1_authorizer_request_authorization
Packit 4b6dd7
                               (GDataOAuth1Authorizer *self,
Packit 4b6dd7
                                const gchar *token,
Packit 4b6dd7
                                const gchar *token_secret,
Packit 4b6dd7
                                const gchar *verifier,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GError **error);
Packit 4b6dd7

Requests authorization of the given request token

Packit 4b6dd7
 from the Google accounts service using the given verifier
Packit 4b6dd7
 as entered by the user from the
Packit 4b6dd7
authentication page at the URI returned by gdata_oauth1_authorizer_request_authentication_uri(). token
Packit 4b6dd7
 and token_secret
Packit 4b6dd7
 must be the same values
Packit 4b6dd7
as were returned by gdata_oauth1_authorizer_request_authentication_uri() if it was successful.

Packit 4b6dd7

If the verifier is valid (i.e. the user granted access to the application and the Google accounts service has no reason to distrust the client),

Packit 4b6dd7
TRUE will be returned and any operations performed from that point onwards on GDataServices using this GDataAuthorizer will be
Packit 4b6dd7
authorized.

Packit 4b6dd7

If the user denies access to the application or the Google accounts service distrusts it, a bogus verifier could be returned. In this case, FALSE

Packit 4b6dd7
will be returned and a GDATA_SERVICE_ERROR_FORBIDDEN error will be raised.

Packit 4b6dd7

Note that if the user denies access to the application, it may be the case that they have no verifier to enter. In this case, the client can simply

Packit 4b6dd7
not call this method. The GDataOAuth1Authorizer stores no state for authentication operations which have succeeded in calling
Packit 4b6dd7
gdata_oauth1_authorizer_request_authentication_uri() but not yet successfully called gdata_oauth1_authorizer_request_authorization().

Packit 4b6dd7

This method implements Section 2.3 of the

Packit 4b6dd7
OAuth 1.0 protocol.
Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataOAuth1Authorizer

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

token

Packit 4b6dd7

the request token returned by gdata_oauth1_authorizer_request_authentication_uri()

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

token_secret

Packit 4b6dd7

the request token secret returned by gdata_oauth1_authorizer_request_authentication_uri()

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

verifier

Packit 4b6dd7

the verifier entered by the user from the authentication page

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

TRUE if authorization was successful, FALSE otherwise

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_oauth1_authorizer_request_authorization_async ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_oauth1_authorizer_request_authorization_async
Packit 4b6dd7
                               (GDataOAuth1Authorizer *self,
Packit 4b6dd7
                                const gchar *token,
Packit 4b6dd7
                                const gchar *token_secret,
Packit 4b6dd7
                                const gchar *verifier,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GAsyncReadyCallback callback,
Packit 4b6dd7
                                gpointer user_data);
Packit 4b6dd7

Requests authorization of the given request token

Packit 4b6dd7
 from the Google accounts service using the given verifier
Packit 4b6dd7
 as entered by the user.
Packit 4b6dd7
self
Packit 4b6dd7
, token
Packit 4b6dd7
, token_secret
Packit 4b6dd7
 and verifier
Packit 4b6dd7
 are reffed/copied when this method is called, so can safely be freed after this method returns.

Packit 4b6dd7

For more details, see gdata_oauth1_authorizer_request_authorization(), which is the synchronous version of this method.

Packit 4b6dd7

When the operation is finished, callback

Packit 4b6dd7
 will be called. You can then call gdata_oauth1_authorizer_request_authorization_finish() to get the
Packit 4b6dd7
results of the operation.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataOAuth1Authorizer

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

token

Packit 4b6dd7

the request token returned by gdata_oauth1_authorizer_request_authentication_uri()

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

token_secret

Packit 4b6dd7

the request token secret returned by gdata_oauth1_authorizer_request_authentication_uri()

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

verifier

Packit 4b6dd7

the verifier entered by the user from the authentication page

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

an optional GCancellable, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

callback

Packit 4b6dd7

a GAsyncReadyCallback to call when authorization is finished

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

user_data

Packit 4b6dd7

data to pass to the callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_oauth1_authorizer_request_authorization_finish ()

Packit 4b6dd7
gboolean
Packit 4b6dd7
gdata_oauth1_authorizer_request_authorization_finish
Packit 4b6dd7
                               (GDataOAuth1Authorizer *self,
Packit 4b6dd7
                                GAsyncResult *async_result,
Packit 4b6dd7
                                GError **error);
Packit 4b6dd7

Finishes an asynchronous authorization operation started with gdata_oauth1_authorizer_request_authorization_async().

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataOAuth1Authorizer

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

async_result

Packit 4b6dd7

a GAsyncResult

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

TRUE if authorization was successful, FALSE otherwise

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_oauth1_authorizer_get_application_name ()

Packit 4b6dd7
const gchar *
Packit 4b6dd7
gdata_oauth1_authorizer_get_application_name
Packit 4b6dd7
                               (GDataOAuth1Authorizer *self);
Packit 4b6dd7

Returns the application name being used on the authentication page at the URI returned by gdata_oauth1_authorizer_request_authentication_uri();

Packit 4b6dd7
i.e. the value of “application-name”.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataOAuth1Authorizer

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the application name, or NULL if one isn't set.

Packit 4b6dd7

[allow-none]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_oauth1_authorizer_get_locale ()

Packit 4b6dd7
const gchar *
Packit 4b6dd7
gdata_oauth1_authorizer_get_locale (GDataOAuth1Authorizer *self);
Packit 4b6dd7

Returns the locale currently being used for network requests, or NULL if the locale is the default.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataOAuth1Authorizer

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the current locale.

Packit 4b6dd7

[allow-none]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_oauth1_authorizer_set_locale ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_oauth1_authorizer_set_locale (GDataOAuth1Authorizer *self,
Packit 4b6dd7
                                    const gchar *locale);
Packit 4b6dd7

Set the locale used for network requests to locale

Packit 4b6dd7
, given in standard Unix locale format. See “locale” for more details.

Packit 4b6dd7

Note that while it's possible to change the locale after sending network requests (i.e. calling

Packit 4b6dd7
gdata_oauth1_authorizer_request_authentication_uri() for the first time), it is unsupported, as the server-side software may behave unexpectedly.
Packit 4b6dd7
The only supported use of this method is after creation of the authorizer, but before any network requests are made.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataOAuth1Authorizer

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

locale

Packit 4b6dd7

the new locale in Unix locale format, or NULL for the default locale.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_oauth1_authorizer_get_proxy_uri ()

Packit 4b6dd7
SoupURI *
Packit 4b6dd7
gdata_oauth1_authorizer_get_proxy_uri (GDataOAuth1Authorizer *self);
Packit 4b6dd7
Packit 4b6dd7

gdata_oauth1_authorizer_get_proxy_uri has been deprecated since version 0.15.0 and should not be used in newly-written code.

Packit 4b6dd7

Use gdata_oauth1_authorizer_get_proxy_resolver() instead, which gives more flexibility over the proxy used.

Packit 4b6dd7
Packit 4b6dd7

Gets the proxy URI on the GDataOAuth1Authorizer's SoupSession.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataOAuth1Authorizer

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the proxy URI, or NULL; free with soup_uri_free().

Packit 4b6dd7

[transfer full][allow-none]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_oauth1_authorizer_set_proxy_uri ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_oauth1_authorizer_set_proxy_uri (GDataOAuth1Authorizer *self,
Packit 4b6dd7
                                       SoupURI *proxy_uri);
Packit 4b6dd7
Packit 4b6dd7

gdata_oauth1_authorizer_set_proxy_uri has been deprecated since version 0.15.0 and should not be used in newly-written code.

Packit 4b6dd7

Use gdata_oauth1_authorizer_set_proxy_resolver() instead, which gives more flexibility over the proxy used.

Packit 4b6dd7
Packit 4b6dd7

Sets the proxy URI on the SoupSession used internally by the GDataOAuth1Authorizer. This forces all requests through the given proxy.

Packit 4b6dd7

If proxy_uri

Packit 4b6dd7
 is NULL, no proxy will be used.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataOAuth1Authorizer

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

proxy_uri

Packit 4b6dd7

the proxy URI, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_oauth1_authorizer_get_proxy_resolver ()

Packit 4b6dd7
GProxyResolver *
Packit 4b6dd7
gdata_oauth1_authorizer_get_proxy_resolver
Packit 4b6dd7
                               (GDataOAuth1Authorizer *self);
Packit 4b6dd7

gdata_oauth1_authorizer_get_proxy_resolver is deprecated and should not be used in newly-written code.

Packit 4b6dd7

Gets the GProxyResolver on the GDataOAuth1Authorizer's SoupSession.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataOAuth1Authorizer

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

a GProxyResolver, or NULL.

Packit 4b6dd7

[transfer none][allow-none]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.15.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_oauth1_authorizer_set_proxy_resolver ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_oauth1_authorizer_set_proxy_resolver
Packit 4b6dd7
                               (GDataOAuth1Authorizer *self,
Packit 4b6dd7
                                GProxyResolver *proxy_resolver);
Packit 4b6dd7

Sets the GProxyResolver on the SoupSession used internally by the given GDataOAuth1Authorizer.

Packit 4b6dd7

Setting this will clear the “proxy-uri” property.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataOAuth1Authorizer

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

proxy_resolver

Packit 4b6dd7

a GProxyResolver, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.15.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_oauth1_authorizer_get_timeout ()

Packit 4b6dd7
guint
Packit 4b6dd7
gdata_oauth1_authorizer_get_timeout (GDataOAuth1Authorizer *self);
Packit 4b6dd7

Gets the “timeout” property; the network timeout, in seconds.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataOAuth1Authorizer

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the timeout, or 0

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_oauth1_authorizer_set_timeout ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_oauth1_authorizer_set_timeout (GDataOAuth1Authorizer *self,
Packit 4b6dd7
                                     guint timeout);
Packit 4b6dd7

Sets the “timeout” property; the network timeout, in seconds.

Packit 4b6dd7

If timeout

Packit 4b6dd7
 is 0, network operations will never time out.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataOAuth1Authorizer

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

timeout

Packit 4b6dd7

the timeout, or 0

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Types and Values

Packit 4b6dd7
Packit 4b6dd7

GDataOAuth1Authorizer

Packit 4b6dd7
typedef struct _GDataOAuth1Authorizer GDataOAuth1Authorizer;
Packit 4b6dd7

All the fields in the GDataOAuth1Authorizer structure are private and should never be accessed directly.

Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

GDataOAuth1AuthorizerClass

Packit 4b6dd7
typedef struct {
Packit 4b6dd7
} GDataOAuth1AuthorizerClass;
Packit 4b6dd7
Packit 4b6dd7

All the fields in the GDataOAuth1AuthorizerClass structure are private and should never be accessed directly.

Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Property Details

Packit 4b6dd7
Packit 4b6dd7

The “application-name” property

Packit 4b6dd7
  “application-name”         gchar *
Packit 4b6dd7

The human-readable, translated application name for the client, to be presented to the user on the authentication page at the URI

Packit 4b6dd7
returned by gdata_oauth1_authorizer_request_authentication_uri().

Packit 4b6dd7

If NULL is provided in the constructor to GDataOAuth1Authorizer, the value returned by g_get_application_name() will be used as a

Packit 4b6dd7
fallback. Note that this may also be NULL: in this case, the authentication page will use the application name “anonymous”.

Packit 4b6dd7

Flags: Read / Write / Construct Only

Packit 4b6dd7

Default value: NULL

Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “locale” property

Packit 4b6dd7
  “locale”                   gchar *
Packit 4b6dd7

The locale to use for network requests, in Unix locale format. (e.g. "en_GB", "cs", "de_DE".) Use NULL for the default "C" locale

Packit 4b6dd7
(typically "en_US").

Packit 4b6dd7

This locale will be used by the server-side software to localise the authentication and authorization pages at the URI returned by

Packit 4b6dd7
gdata_oauth1_authorizer_request_authentication_uri().

Packit 4b6dd7

The server-side behaviour is undefined if it doesn't support a given locale.

Packit 4b6dd7

Flags: Read / Write

Packit 4b6dd7

Default value: NULL

Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “proxy-resolver” property

Packit 4b6dd7
  “proxy-resolver”           GProxyResolver *
Packit 4b6dd7

The GProxyResolver used to determine a proxy URI. Setting this will clear the “proxy-uri” property.

Packit 4b6dd7

Flags: Read / Write

Packit 4b6dd7

Since: 0.15.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “proxy-uri” property

Packit 4b6dd7
  “proxy-uri”                SoupURI *
Packit 4b6dd7

The proxy URI used internally for all network requests.

Packit 4b6dd7
Packit 4b6dd7

GDataOAuth1Authorizer:proxy-uri has been deprecated since version 0.15.0 and should not be used in newly-written code.

Packit 4b6dd7

Use “proxy-resolver” instead, which gives more flexibility over the proxy used.

Packit 4b6dd7
Packit 4b6dd7

Flags: Read / Write

Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “timeout” property

Packit 4b6dd7
  “timeout”                  guint
Packit 4b6dd7

A timeout, in seconds, for network operations. If the timeout is exceeded, the operation will be cancelled and

Packit 4b6dd7
GDATA_SERVICE_ERROR_NETWORK_ERROR will be returned.

Packit 4b6dd7

If the timeout is 0, operations will never time out.

Packit 4b6dd7

Flags: Read / Write

Packit 4b6dd7

Default value: 0

Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Generated by GTK-Doc V1.26.1
Packit 4b6dd7
</body>
Packit 4b6dd7
</html>