|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
<html>
|
|
Packit |
4b6dd7 |
<head>
|
|
Packit |
4b6dd7 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
4b6dd7 |
<title>GDataClientLoginAuthorizer: 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="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain">
|
|
Packit |
4b6dd7 |
<link rel="next" href="GDataGoaAuthorizer.html" title="GDataGoaAuthorizer">
|
|
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 |
Signals
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataClientLoginAuthorizer
|
|
Packit |
4b6dd7 |
GDataClientLoginAuthorizer — GData ClientLogin 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 |
GDataClientLoginAuthorizer *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_new ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataClientLoginAuthorizer *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_new_for_authorization_domains ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gboolean
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_authenticate ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
void
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_authenticate_async ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gboolean
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_authenticate_finish ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_get_client_id ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_get_username ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_get_password ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
SoupURI *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_get_proxy_uri ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
void
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_set_proxy_uri ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GProxyResolver *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_get_proxy_resolver ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
void
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_set_proxy_resolver ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
guint
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_get_timeout ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
void
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_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 |
client-id
|
|
Packit |
4b6dd7 |
Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gchar *
|
|
Packit |
4b6dd7 |
password
|
|
Packit |
4b6dd7 |
Read
|
|
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 |
gchar *
|
|
Packit |
4b6dd7 |
username
|
|
Packit |
4b6dd7 |
Read
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Signals
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gchar*
|
|
Packit |
4b6dd7 |
captcha-challenge
|
|
Packit |
4b6dd7 |
Run Last
|
|
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 |
GDataClientLoginAuthorizer
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataClientLoginAuthorizerClass
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
enum
|
|
Packit |
4b6dd7 |
GDataClientLoginAuthorizerError
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Object Hierarchy
|
|
Packit |
4b6dd7 |
GObject
|
|
Packit |
4b6dd7 |
╰── GDataClientLoginAuthorizer
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Implemented Interfaces
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataClientLoginAuthorizer implements
|
|
Packit |
4b6dd7 |
GDataAuthorizer.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Includes
|
|
Packit |
4b6dd7 |
#include <gdata/gdata-client-login-authorizer.h>
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Description
|
|
Packit |
4b6dd7 |
GDataClientLoginAuthorizer provides an implementation of the GDataAuthorizer interface for authentication and authorization using the deprecated
|
|
Packit |
4b6dd7 |
ClientLogin process.
|
|
Packit |
4b6dd7 |
As noted, the ClientLogin process is being deprecated in favour of OAuth 2.0. This API is not (yet) deprecated, however. One of the main reasons
|
|
Packit |
4b6dd7 |
for ClientLogin being deprecated is that it cannot support two-factor authentication as now available to Google Accounts. Any account which has
|
|
Packit |
4b6dd7 |
two-factor authentication enabled has to use a service-specific one-time password instead if a client is authenticating with
|
|
Packit |
4b6dd7 |
GDataClientLoginAuthorizer. More documentation about this is
|
|
Packit |
4b6dd7 |
available online.
|
|
Packit |
4b6dd7 |
Note that newer services cannot be authenticated against using ClientLogin,
|
|
Packit |
4b6dd7 |
and a GDataOAuth2Authorizer must be used instead.
|
|
Packit |
4b6dd7 |
The ClientLogin process is a simple one whereby the user's Google Account username and password are sent over an HTTPS connection to the Google
|
|
Packit |
4b6dd7 |
Account servers (when gdata_client_login_authorizer_authenticate() is called), which return an authorization token. This token is then attached to
|
|
Packit |
4b6dd7 |
all future requests to the online service. A slight complication is that the Google Accounts service may return a CAPTCHA challenge instead of
|
|
Packit |
4b6dd7 |
immediately returning an authorization token. In this case, the “captcha-challenge” signal will be emitted, and the
|
|
Packit |
4b6dd7 |
user's response to the CAPTCHA should be returned by the handler.
|
|
Packit |
4b6dd7 |
ClientLogin does not natively support authorization against multiple authorization domains concurrently with a single authorization token, so it
|
|
Packit |
4b6dd7 |
has to be simulated by maintaining multiple authorization tokens if multiple authorization domains are used. This means that proportionally more
|
|
Packit |
4b6dd7 |
network requests are made when gdata_client_login_authorizer_authenticate() is called, which will be proportionally slower. Handling of the
|
|
Packit |
4b6dd7 |
multiple authorization tokens is otherwise transparent to the client.
|
|
Packit |
4b6dd7 |
Each authorization token is long lived, so reauthorization is rarely necessary with GDataClientLoginAuthorizer. Consequently, refreshing
|
|
Packit |
4b6dd7 |
authorization using gdata_authorizer_refresh_authorization() is not supported by GDataClientLoginAuthorizer, and will immediately return FALSE
|
|
Packit |
4b6dd7 |
with no error set.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Example 6. Authenticating Asynchronously Using ClientLogin
|
|
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 |
GDataSomeService *service;
|
|
Packit |
4b6dd7 |
GDataClientLoginAuthorizer *authorizer;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
authorizer = gdata_client_login_authorizer_new ("companyName-applicationName-versionID", GDATA_TYPE_SOME_SERVICE);
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_authenticate_async (authorizer, username, password, cancellable,
|
|
Packit |
4b6dd7 |
(GAsyncReadyCallback) authenticate_cb, user_data);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
service = gdata_some_service_new (GDATA_AUTHORIZER (authorizer));
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
static void
|
|
Packit |
4b6dd7 |
authenticate_cb (GDataClientLoginAuthorizer *authorizer, GAsyncResult *async_result, gpointer user_data)
|
|
Packit |
4b6dd7 |
{
|
|
Packit |
4b6dd7 |
GError *error = NULL;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
if (gdata_client_login_authorizer_authenticate_finish (authorizer, async_result, &error) == FALSE) {
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
if (!g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) {
|
|
Packit |
4b6dd7 |
g_error ("Authentication failed: %s", error->message);
|
|
Packit |
4b6dd7 |
}
|
|
Packit |
4b6dd7 |
g_error_free (error);
|
|
Packit |
4b6dd7 |
return;
|
|
Packit |
4b6dd7 |
}
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
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_client_login_authorizer_new ()
|
|
Packit |
4b6dd7 |
GDataClientLoginAuthorizer *
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_new (const gchar *client_id,
|
|
Packit |
4b6dd7 |
GType service_type);
|
|
Packit |
4b6dd7 |
Creates a new GDataClientLoginAuthorizer. The client_id
|
|
Packit |
4b6dd7 |
must be unique for your application, and as registered with Google.
|
|
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 logged in to using the provided username and password when gdata_client_login_authorizer_authenticate() is called. Note that the same
|
|
Packit |
4b6dd7 |
username and password will be used for all domains.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
client_id
|
|
Packit |
4b6dd7 |
your application's client ID
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
service_type
|
|
Packit |
4b6dd7 |
the GType of a GDataService subclass which the GDataClientLoginAuthorizer will be used with
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
a new GDataClientLoginAuthorizer, or NULL; 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_client_login_authorizer_new_for_authorization_domains ()
|
|
Packit |
4b6dd7 |
GDataClientLoginAuthorizer *
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_new_for_authorization_domains
|
|
Packit |
4b6dd7 |
(const gchar *client_id,
|
|
Packit |
4b6dd7 |
GList *authorization_domains);
|
|
Packit |
4b6dd7 |
Creates a new GDataClientLoginAuthorizer. The client_id
|
|
Packit |
4b6dd7 |
must be unique for your application, and as registered with Google. This function is
|
|
Packit |
4b6dd7 |
intended to be used only when the default authorization domain list for a single GDataService, as used by gdata_client_login_authorizer_new(),
|
|
Packit |
4b6dd7 |
isn't suitable. For example, this could be because the GDataClientLoginAuthorizer will be used with multiple GDataService subclasses, or because
|
|
Packit |
4b6dd7 |
the client requires a specific set of authorization domains.
|
|
Packit |
4b6dd7 |
The specified GDataAuthorizationDomains are the ones the user will be logged in to using the provided username and password when
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_authenticate() is called. Note that the same username and password will be used for all domains.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
client_id
|
|
Packit |
4b6dd7 |
your application's client ID
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
authorization_domains
|
|
Packit |
4b6dd7 |
a non-empty list of GDataAuthorizationDomains to be
|
|
Packit |
4b6dd7 |
authorized against by the GDataClientLoginAuthorizer.
|
|
Packit |
4b6dd7 |
[element-type GDataAuthorizationDomain][transfer none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
a new GDataClientLoginAuthorizer, or NULL; 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_client_login_authorizer_authenticate ()
|
|
Packit |
4b6dd7 |
gboolean
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_authenticate
|
|
Packit |
4b6dd7 |
(GDataClientLoginAuthorizer *self,
|
|
Packit |
4b6dd7 |
const gchar *username,
|
|
Packit |
4b6dd7 |
const gchar *password,
|
|
Packit |
4b6dd7 |
GCancellable *cancellable,
|
|
Packit |
4b6dd7 |
GError **error);
|
|
Packit |
4b6dd7 |
Authenticates the GDataClientLoginAuthorizer with the Google Accounts service using username
|
|
Packit |
4b6dd7 |
and password
|
|
Packit |
4b6dd7 |
and authorizes it against all the
|
|
Packit |
4b6dd7 |
service types passed to gdata_client_login_authorizer_new(); i.e. logs into the service with the given user account. username
|
|
Packit |
4b6dd7 |
should be a full
|
|
Packit |
4b6dd7 |
e-mail address (e.g. john.smith@gmail.com). If a full e-mail address is not given, username
|
|
Packit |
4b6dd7 |
will have
|
|
Packit |
4b6dd7 |
@gmail.com appended to create an e-mail address
|
|
Packit |
4b6dd7 |
If cancellable
|
|
Packit |
4b6dd7 |
is not NULL, then the operation can be cancelled by triggering the cancellable
|
|
Packit |
4b6dd7 |
object from another thread.
|
|
Packit |
4b6dd7 |
If the operation was cancelled, the error G_IO_ERROR_CANCELLED will be returned.
|
|
Packit |
4b6dd7 |
If the operation errors or is cancelled part-way through, gdata_authorizer_is_authorized_for_domain() is guaranteed to return FALSE
|
|
Packit |
4b6dd7 |
for all GDataAuthorizationDomains, even if authentication has succeeded for some of them already.
|
|
Packit |
4b6dd7 |
A GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_BAD_AUTHENTICATION will be returned if authentication failed due to an incorrect username or password.
|
|
Packit |
4b6dd7 |
Other GDataClientLoginAuthorizerError errors can be returned for other conditions.
|
|
Packit |
4b6dd7 |
If the service requires a CAPTCHA to be completed, the “captcha-challenge” signal will be emitted.
|
|
Packit |
4b6dd7 |
The return value from a signal handler for the signal should be a newly allocated string containing the text from the image. If the text is NULL
|
|
Packit |
4b6dd7 |
or empty, authentication will fail with a GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_CAPTCHA_REQUIRED error. Otherwise, authentication will be
|
|
Packit |
4b6dd7 |
automatically and transparently restarted with the new CAPTCHA details.
|
|
Packit |
4b6dd7 |
A GDATA_SERVICE_ERROR_PROTOCOL_ERROR will be returned if the server's responses were invalid.
|
|
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 GDataClientLoginAuthorizer
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
username
|
|
Packit |
4b6dd7 |
the user's username
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
password
|
|
Packit |
4b6dd7 |
the user's password
|
|
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 authentication and authorization was successful against all the services, FALSE otherwise
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_authenticate_async ()
|
|
Packit |
4b6dd7 |
void
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_authenticate_async
|
|
Packit |
4b6dd7 |
(GDataClientLoginAuthorizer *self,
|
|
Packit |
4b6dd7 |
const gchar *username,
|
|
Packit |
4b6dd7 |
const gchar *password,
|
|
Packit |
4b6dd7 |
GCancellable *cancellable,
|
|
Packit |
4b6dd7 |
GAsyncReadyCallback callback,
|
|
Packit |
4b6dd7 |
gpointer user_data);
|
|
Packit |
4b6dd7 |
Authenticates the GDataClientLoginAuthorizer with the Google accounts service using the given username
|
|
Packit |
4b6dd7 |
and password
|
|
Packit |
4b6dd7 |
. self
|
|
Packit |
4b6dd7 |
, username
|
|
Packit |
4b6dd7 |
and
|
|
Packit |
4b6dd7 |
password
|
|
Packit |
4b6dd7 |
are all reffed/copied when this function is called, so can safely be freed after this function returns.
|
|
Packit |
4b6dd7 |
For more details, see gdata_client_login_authorizer_authenticate(), which is the synchronous version of this function.
|
|
Packit |
4b6dd7 |
When the operation is finished, callback
|
|
Packit |
4b6dd7 |
will be called. You can then call gdata_client_login_authorizer_authenticate_finish()
|
|
Packit |
4b6dd7 |
to get the 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 GDataClientLoginAuthorizer
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
username
|
|
Packit |
4b6dd7 |
the user's username
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
password
|
|
Packit |
4b6dd7 |
the user's password
|
|
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 authentication 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_client_login_authorizer_authenticate_finish ()
|
|
Packit |
4b6dd7 |
gboolean
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_authenticate_finish
|
|
Packit |
4b6dd7 |
(GDataClientLoginAuthorizer *self,
|
|
Packit |
4b6dd7 |
GAsyncResult *async_result,
|
|
Packit |
4b6dd7 |
GError **error);
|
|
Packit |
4b6dd7 |
Finishes an asynchronous authentication operation started with gdata_client_login_authorizer_authenticate_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 GDataClientLoginAuthorizer
|
|
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 authentication was successful, FALSE otherwise
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_get_client_id ()
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_get_client_id
|
|
Packit |
4b6dd7 |
(GDataClientLoginAuthorizer *self);
|
|
Packit |
4b6dd7 |
Returns the authorizer's client ID, as specified on constructing the GDataClientLoginAuthorizer.
|
|
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 GDataClientLoginAuthorizer
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
the authorizer's client ID
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_get_username ()
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_get_username
|
|
Packit |
4b6dd7 |
(GDataClientLoginAuthorizer *self);
|
|
Packit |
4b6dd7 |
Returns the username of the currently authenticated user, or NULL if nobody is authenticated.
|
|
Packit |
4b6dd7 |
It is not safe to call this while an authentication operation is ongoing.
|
|
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 GDataClientLoginAuthorizer
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
the username of the currently authenticated user, or NULL
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_get_password ()
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_get_password
|
|
Packit |
4b6dd7 |
(GDataClientLoginAuthorizer *self);
|
|
Packit |
4b6dd7 |
Returns the password of the currently authenticated user, or NULL if nobody is authenticated.
|
|
Packit |
4b6dd7 |
It is not safe to call this while an authentication operation is ongoing.
|
|
Packit |
4b6dd7 |
If libgdata is compiled with libgcr support, the password will be stored in non-pageable memory. Since this function doesn't return
|
|
Packit |
4b6dd7 |
a copy of the password, the returned value is guaranteed to not hit disk. It's advised that any copies of the password made in client programs
|
|
Packit |
4b6dd7 |
also use non-pageable memory.
|
|
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 GDataClientLoginAuthorizer
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
the password of the currently authenticated user, or NULL
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_get_proxy_uri ()
|
|
Packit |
4b6dd7 |
SoupURI *
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_get_proxy_uri
|
|
Packit |
4b6dd7 |
(GDataClientLoginAuthorizer *self);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_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_client_login_authorizer_get_proxy_resolver() instead, which gives more flexibility over the proxy used.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Gets the proxy URI on the GDataClientLoginAuthorizer'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 GDataClientLoginAuthorizer
|
|
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]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_set_proxy_uri ()
|
|
Packit |
4b6dd7 |
void
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_set_proxy_uri
|
|
Packit |
4b6dd7 |
(GDataClientLoginAuthorizer *self,
|
|
Packit |
4b6dd7 |
SoupURI *proxy_uri);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_client_login_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_client_login_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 GDataClientLoginAuthorizer. 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 GDataClientLoginAuthorizer
|
|
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_client_login_authorizer_get_proxy_resolver ()
|
|
Packit |
4b6dd7 |
GProxyResolver *
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_get_proxy_resolver
|
|
Packit |
4b6dd7 |
(GDataClientLoginAuthorizer *self);
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_get_proxy_resolver is deprecated and should not be used in newly-written code.
|
|
Packit |
4b6dd7 |
Gets the GProxyResolver on the GDataClientLoginAuthorizer'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 GDataClientLoginAuthorizer
|
|
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_client_login_authorizer_set_proxy_resolver ()
|
|
Packit |
4b6dd7 |
void
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_set_proxy_resolver
|
|
Packit |
4b6dd7 |
(GDataClientLoginAuthorizer *self,
|
|
Packit |
4b6dd7 |
GProxyResolver *proxy_resolver);
|
|
Packit |
4b6dd7 |
Sets the GProxyResolver on the SoupSession used internally by the given GDataClientLoginAuthorizer.
|
|
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 GDataClientLoginAuthorizer
|
|
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_client_login_authorizer_get_timeout ()
|
|
Packit |
4b6dd7 |
guint
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_get_timeout
|
|
Packit |
4b6dd7 |
(GDataClientLoginAuthorizer *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 GDataClientLoginAuthorizer
|
|
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_client_login_authorizer_set_timeout ()
|
|
Packit |
4b6dd7 |
void
|
|
Packit |
4b6dd7 |
gdata_client_login_authorizer_set_timeout
|
|
Packit |
4b6dd7 |
(GDataClientLoginAuthorizer *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 GDataClientLoginAuthorizer
|
|
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 |
GDataClientLoginAuthorizer
|
|
Packit |
4b6dd7 |
typedef struct _GDataClientLoginAuthorizer GDataClientLoginAuthorizer;
|
|
Packit |
4b6dd7 |
All the fields in the GDataClientLoginAuthorizer structure are private and should never be accessed directly.
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataClientLoginAuthorizerClass
|
|
Packit |
4b6dd7 |
typedef struct {
|
|
Packit |
4b6dd7 |
} GDataClientLoginAuthorizerClass;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
All the fields in the GDataClientLoginAuthorizerClass structure are private and should never be accessed directly.
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
enum GDataClientLoginAuthorizerError
|
|
Packit |
4b6dd7 |
Error codes for authentication and authorization operations on GDataClientLoginAuthorizer. See the
|
|
Packit |
4b6dd7 |
online ClientLogin documentation for
|
|
Packit |
4b6dd7 |
more information.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Members
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_BAD_AUTHENTICATION
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The login request used a username or password that is not recognized.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_NOT_VERIFIED
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The account email address has not been verified. The user will need to access their Google
|
|
Packit |
4b6dd7 |
account directly to resolve the issue before logging in using a non-Google application.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_TERMS_NOT_AGREED
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The user has not agreed to terms. The user will need to access their Google account directly
|
|
Packit |
4b6dd7 |
to resolve the issue before logging in using a non-Google application.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_CAPTCHA_REQUIRED
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
A CAPTCHA is required. (A response with this error code will also contain an image URI and a
|
|
Packit |
4b6dd7 |
CAPTCHA token.)
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_ACCOUNT_DELETED
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The user account has been deleted.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_ACCOUNT_DISABLED
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The user account has been disabled.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_SERVICE_DISABLED
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The user's access to the specified service has been disabled. (The user account may still be
|
|
Packit |
4b6dd7 |
valid.)
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_ACCOUNT_MIGRATED
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The user's account login details have been migrated to a new system. (This is used for the
|
|
Packit |
4b6dd7 |
transition from the old YouTube login details to the new ones.)
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_INVALID_SECOND_FACTOR
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The user's account requires an application-specific password to be used.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Property Details
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “client-id” property
|
|
Packit |
4b6dd7 |
“client-id” gchar *
|
|
Packit |
4b6dd7 |
A client ID for your application (see the
|
|
Packit |
4b6dd7 |
reference documentation).
|
|
Packit |
4b6dd7 |
It is recommended that the ID is of the form company name-application name-
|
|
Packit |
4b6dd7 |
version ID.
|
|
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 “password” property
|
|
Packit |
4b6dd7 |
“password” gchar *
|
|
Packit |
4b6dd7 |
The user's account password for authentication.
|
|
Packit |
4b6dd7 |
This will only be set after authentication using gdata_client_login_authorizer_authenticate() is completed successfully. It will
|
|
Packit |
4b6dd7 |
then be set to the password passed to gdata_client_login_authorizer_authenticate(), and a “notify” signal will be emitted. If
|
|
Packit |
4b6dd7 |
authentication fails, it will be set to NULL.
|
|
Packit |
4b6dd7 |
If libgdata is compiled with libgcr support, the password will be stored in non-pageable memory. However, if it is retrieved
|
|
Packit |
4b6dd7 |
using g_object_get() (or related functions) it will be copied to non-pageable memory and could end up being written to disk. Accessing
|
|
Packit |
4b6dd7 |
the password using gdata_client_login_authorizer_get_password() will not perform any copies, and so maintains privacy.
|
|
Packit |
4b6dd7 |
Flags: Read
|
|
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 |
GDataClientLoginAuthorizer: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 |
The “username” property
|
|
Packit |
4b6dd7 |
“username” gchar *
|
|
Packit |
4b6dd7 |
The user's Google username for authentication. This will always be a full e-mail address.
|
|
Packit |
4b6dd7 |
This will only be set after authentication using gdata_client_login_authorizer_authenticate() is completed successfully. It will
|
|
Packit |
4b6dd7 |
then be set to the username passed to gdata_client_login_authorizer_authenticate(), and a “notify” signal will be emitted. If
|
|
Packit |
4b6dd7 |
authentication fails, it will be set to NULL.
|
|
Packit |
4b6dd7 |
Flags: Read
|
|
Packit |
4b6dd7 |
Default value: NULL
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Signal Details
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “captcha-challenge” signal
|
|
Packit |
4b6dd7 |
gchar*
|
|
Packit |
4b6dd7 |
user_function (GDataClientLoginAuthorizer *authorizer,
|
|
Packit |
4b6dd7 |
gchar *uri,
|
|
Packit |
4b6dd7 |
gpointer user_data)
|
|
Packit |
4b6dd7 |
The “captcha-challenge” signal is emitted during the authentication process if the authorizer requires a CAPTCHA
|
|
Packit |
4b6dd7 |
to be completed. The URI of a CAPTCHA image is given, and the program should display this to the user, and return their response (the text
|
|
Packit |
4b6dd7 |
displayed in the image). There is no timeout imposed by the library for the response.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
authorizer
|
|
Packit |
4b6dd7 |
the GDataClientLoginAuthorizer which received the challenge
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
uri
|
|
Packit |
4b6dd7 |
the URI of the CAPTCHA image to be used
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
user_data
|
|
Packit |
4b6dd7 |
user data set when the signal handler was connected.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
a newly allocated string containing the text in the CAPTCHA image
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Flags: Run Last
|
|
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>
|