|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
<html>
|
|
Packit |
4b6dd7 |
<head>
|
|
Packit |
4b6dd7 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
4b6dd7 |
<title>GDataAuthorizer: 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="ch05.html" title="Authentication/Authorization API">
|
|
Packit |
4b6dd7 |
<link rel="next" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain">
|
|
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 |
Prerequisites |
|
|
Packit |
4b6dd7 |
Known Implementations
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAuthorizer
|
|
Packit |
4b6dd7 |
GDataAuthorizer — GData 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 |
void
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_authorizer_process_request ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gboolean
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_authorizer_is_authorized_for_domain ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gboolean
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_authorizer_refresh_authorization ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
void
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_authorizer_refresh_authorization_async ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gboolean
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_authorizer_refresh_authorization_finish ()
|
|
Packit |
4b6dd7 |
|
|
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 |
GDataAuthorizer
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAuthorizerInterface
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Object Hierarchy
|
|
Packit |
4b6dd7 |
GInterface
|
|
Packit |
4b6dd7 |
╰── GDataAuthorizer
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Prerequisites
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAuthorizer requires
|
|
Packit |
4b6dd7 |
GObject.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Known Implementations
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAuthorizer is implemented by
|
|
Packit |
4b6dd7 |
GDataClientLoginAuthorizer, GDataGoaAuthorizer, GDataOAuth1Authorizer and GDataOAuth2Authorizer.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Includes
|
|
Packit |
4b6dd7 |
#include <gdata/gdata-authorizer.h>
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Description
|
|
Packit |
4b6dd7 |
The GDataAuthorizer interface provides a uniform way to implement authentication and authorization processes for use by GDataServices.
|
|
Packit |
4b6dd7 |
Client code will construct a new GDataAuthorizer instance of their choosing, such as GDataClientLoginAuthorizer or GDataOAuth2Authorizer, for
|
|
Packit |
4b6dd7 |
the GDataServices which will be used by the client, then authenticates and authorizes with the GDataAuthorizer instead of the
|
|
Packit |
4b6dd7 |
GDataService. The GDataService then uses the GDataAuthorizer to authorize individual network requests using whatever authorization token was
|
|
Packit |
4b6dd7 |
returned to the GDataAuthorizer by the Google Accounts service.
|
|
Packit |
4b6dd7 |
All GDataAuthorizer implementations are expected to operate against a set of GDataAuthorizationDomains which are provided to the
|
|
Packit |
4b6dd7 |
authorizer at construction time. These domains specify which data domains the client expects to access using the GDataServices they
|
|
Packit |
4b6dd7 |
have using the GDataAuthorizer instance. Following the principle of least privilege, the set of domains should be the minimum such set of domains
|
|
Packit |
4b6dd7 |
which still allows the client to operate normally. Note that implementations of GDataAuthorizationDomain may display the list of requested
|
|
Packit |
4b6dd7 |
authorization domains to the user for verification before authorization is granted.
|
|
Packit |
4b6dd7 |
GDataAuthorizer implementations are provided for some of the standard authorization processes supported by Google for installed applications, as
|
|
Packit |
4b6dd7 |
listed in their online documentation:
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataClientLoginAuthorizer for
|
|
Packit |
4b6dd7 |
ClientLogin (deprecated)
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataOAuth1Authorizer for
|
|
Packit |
4b6dd7 |
OAuth 1.0 (deprecated)
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataOAuth2Authorizer for
|
|
Packit |
4b6dd7 |
OAuth 2.0 (preferred)
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
It is quite possible for clients to write their own GDataAuthorizer implementation. For example, if a client already uses OAuth 2.0 and handles
|
|
Packit |
4b6dd7 |
authentication itself, it may want to use its own GDataAuthorizer implementation which simply exposes the client's existing access token to
|
|
Packit |
4b6dd7 |
libgdata and does nothing more.
|
|
Packit |
4b6dd7 |
It must be noted that all GDataAuthorizer implementations must be thread safe, as methods such as gdata_authorizer_refresh_authorization() may be
|
|
Packit |
4b6dd7 |
called from any thread (such as the thread performing an asynchronous query operation) at any time.
|
|
Packit |
4b6dd7 |
Examples of code using GDataAuthorizer can be found in the documentation for the various implementations of the GDataAuthorizer interface.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Functions
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_authorizer_process_request ()
|
|
Packit |
4b6dd7 |
void
|
|
Packit |
4b6dd7 |
gdata_authorizer_process_request (GDataAuthorizer *self,
|
|
Packit |
4b6dd7 |
GDataAuthorizationDomain *domain,
|
|
Packit |
4b6dd7 |
SoupMessage *message);
|
|
Packit |
4b6dd7 |
Processes message
|
|
Packit |
4b6dd7 |
, adding all the necessary extra headers and parameters to ensure that it's correctly authenticated and authorized under the
|
|
Packit |
4b6dd7 |
given domain
|
|
Packit |
4b6dd7 |
for the online service. Basically, if a query is not processed by calling this method on it, it will be sent to the online service as
|
|
Packit |
4b6dd7 |
if it's a query from a non-logged-in user. Similarly, if the GDataAuthorizer isn't authenticated or authorized (for domain
|
|
Packit |
4b6dd7 |
), no changes will
|
|
Packit |
4b6dd7 |
be made to the message
|
|
Packit |
4b6dd7 |
.
|
|
Packit |
4b6dd7 |
domain
|
|
Packit |
4b6dd7 |
may be NULL if the request doesn't require authorization.
|
|
Packit |
4b6dd7 |
This modifies message
|
|
Packit |
4b6dd7 |
in place.
|
|
Packit |
4b6dd7 |
This method is thread safe.
|
|
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 GDataAuthorizer
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
domain
|
|
Packit |
4b6dd7 |
the GDataAuthorizationDomain the query falls under, or NULL.
|
|
Packit |
4b6dd7 |
[allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
message
|
|
Packit |
4b6dd7 |
the query to process
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_authorizer_is_authorized_for_domain ()
|
|
Packit |
4b6dd7 |
gboolean
|
|
Packit |
4b6dd7 |
gdata_authorizer_is_authorized_for_domain
|
|
Packit |
4b6dd7 |
(GDataAuthorizer *self,
|
|
Packit |
4b6dd7 |
GDataAuthorizationDomain *domain);
|
|
Packit |
4b6dd7 |
Returns whether the GDataAuthorizer instance believes it's currently authorized to access the given domain
|
|
Packit |
4b6dd7 |
. Note that this will not perform any
|
|
Packit |
4b6dd7 |
network requests, and will just look up the result in the GDataAuthorizer's local cache of authorizations. This means that the result may be out
|
|
Packit |
4b6dd7 |
of date, as the server may have since invalidated the authorization. If the GDataAuthorizer class supports timeouts and TTLs on authorizations,
|
|
Packit |
4b6dd7 |
they will not be taken into account; this method effectively returns whether the last successful authorization operation performed on the
|
|
Packit |
4b6dd7 |
GDataAuthorizer included domain
|
|
Packit |
4b6dd7 |
in the list of requested authorization domains.
|
|
Packit |
4b6dd7 |
Note that NULL may be passed as the GDataAuthorizer, in which case FALSE will always be returned, regardless of the domain
|
|
Packit |
4b6dd7 |
. This is for
|
|
Packit |
4b6dd7 |
convenience of checking whether a domain is authorized by the GDataAuthorizer returned by gdata_service_get_authorizer(), which may be NULL.
|
|
Packit |
4b6dd7 |
For example:
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
1
|
|
Packit |
4b6dd7 |
2
|
|
Packit |
4b6dd7 |
3
|
|
Packit |
4b6dd7 |
if (gdata_authorizer_is_authorized_for_domain (gdata_service_get_authorizer (my_service), my_domain) == TRUE) {
|
|
Packit |
4b6dd7 |
/<!-- -->* Code to execute only if we're authorized for the given domain *<!-- -->/
|
|
Packit |
4b6dd7 |
}
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
This method is thread safe.
|
|
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 GDataAuthorizer, or NULL.
|
|
Packit |
4b6dd7 |
[allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
domain
|
|
Packit |
4b6dd7 |
the GDataAuthorizationDomain to check against
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
TRUE if the GDataAuthorizer has been authorized to access domain
|
|
Packit |
4b6dd7 |
, FALSE otherwise
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_authorizer_refresh_authorization ()
|
|
Packit |
4b6dd7 |
gboolean
|
|
Packit |
4b6dd7 |
gdata_authorizer_refresh_authorization
|
|
Packit |
4b6dd7 |
(GDataAuthorizer *self,
|
|
Packit |
4b6dd7 |
GCancellable *cancellable,
|
|
Packit |
4b6dd7 |
GError **error);
|
|
Packit |
4b6dd7 |
Forces the GDataAuthorizer to refresh any authorization tokens it holds with the online service. This should typically be called when a
|
|
Packit |
4b6dd7 |
GDataService query returns GDATA_SERVICE_ERROR_AUTHENTICATION_REQUIRED, and is already called transparently by methods such as
|
|
Packit |
4b6dd7 |
gdata_service_query() and gdata_service_insert_entry() (see their documentation for more details).
|
|
Packit |
4b6dd7 |
If re-authorization is successful, it's guaranteed that by the time this method returns, the properties containing the relevant authorization
|
|
Packit |
4b6dd7 |
tokens on the GDataAuthorizer instance will have been updated.
|
|
Packit |
4b6dd7 |
If FALSE is returned, error
|
|
Packit |
4b6dd7 |
will be set if (and only if) it's due to a refresh being attempted and failing. If a refresh is not attempted, FALSE
|
|
Packit |
4b6dd7 |
will be returned but error
|
|
Packit |
4b6dd7 |
will not be set.
|
|
Packit |
4b6dd7 |
If the GDataAuthorizer has not been previously authenticated or authorized (using the class' specific methods), no authorization will be
|
|
Packit |
4b6dd7 |
attempted, FALSE will be returned immediately and error
|
|
Packit |
4b6dd7 |
will not be set.
|
|
Packit |
4b6dd7 |
Some GDataAuthorizer implementations may not support refreshing authorization tokens at all; for example if doing so requires user interaction.
|
|
Packit |
4b6dd7 |
FALSE will be returned immediately in that case and error
|
|
Packit |
4b6dd7 |
will not be set.
|
|
Packit |
4b6dd7 |
This method is thread safe.
|
|
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 GDataAuthorizer
|
|
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 an authorization refresh was attempted and was successful, FALSE if a refresh wasn't attempted or was unsuccessful
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_authorizer_refresh_authorization_async ()
|
|
Packit |
4b6dd7 |
void
|
|
Packit |
4b6dd7 |
gdata_authorizer_refresh_authorization_async
|
|
Packit |
4b6dd7 |
(GDataAuthorizer *self,
|
|
Packit |
4b6dd7 |
GCancellable *cancellable,
|
|
Packit |
4b6dd7 |
GAsyncReadyCallback callback,
|
|
Packit |
4b6dd7 |
gpointer user_data);
|
|
Packit |
4b6dd7 |
Forces the GDataAuthorizer to refresh any authorization tokens it holds with the online service. self
|
|
Packit |
4b6dd7 |
and cancellable
|
|
Packit |
4b6dd7 |
are reffed when this
|
|
Packit |
4b6dd7 |
method is called, so can safely be freed after this method returns.
|
|
Packit |
4b6dd7 |
For more details, see gdata_authorizer_refresh_authorization(), which is the synchronous version of this method. If the GDataAuthorizer class
|
|
Packit |
4b6dd7 |
doesn't implement GDataAuthorizerInterface.refresh_authorization_async but does implement GDataAuthorizerInterface.refresh_authorization, the
|
|
Packit |
4b6dd7 |
latter will be called from a new thread to make it asynchronous.
|
|
Packit |
4b6dd7 |
When the authorization refresh operation is finished, callback
|
|
Packit |
4b6dd7 |
will be called. You can then call gdata_authorizer_refresh_authorization_finish()
|
|
Packit |
4b6dd7 |
to get the results of the operation.
|
|
Packit |
4b6dd7 |
This method is thread safe.
|
|
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 GDataAuthorizer
|
|
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 the authorization refresh operation is finished, or NULL.
|
|
Packit |
4b6dd7 |
[allow-none][scope async]
|
|
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_authorizer_refresh_authorization_finish ()
|
|
Packit |
4b6dd7 |
gboolean
|
|
Packit |
4b6dd7 |
gdata_authorizer_refresh_authorization_finish
|
|
Packit |
4b6dd7 |
(GDataAuthorizer *self,
|
|
Packit |
4b6dd7 |
GAsyncResult *async_result,
|
|
Packit |
4b6dd7 |
GError **error);
|
|
Packit |
4b6dd7 |
Finishes an asynchronous authorization refresh operation for the GDataAuthorizer, as started with gdata_authorizer_refresh_authorization_async().
|
|
Packit |
4b6dd7 |
This method is thread safe.
|
|
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 GDataAuthorizer
|
|
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 an authorization refresh was attempted and was successful, FALSE if a refresh wasn't attempted or was unsuccessful
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Types and Values
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAuthorizer
|
|
Packit |
4b6dd7 |
typedef struct _GDataAuthorizer GDataAuthorizer;
|
|
Packit |
4b6dd7 |
All the fields in the GDataAuthorizer structure are private and should never be accessed directly.
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAuthorizerInterface
|
|
Packit |
4b6dd7 |
typedef struct {
|
|
Packit |
4b6dd7 |
GTypeInterface parent;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
void (*process_request) (GDataAuthorizer *self, GDataAuthorizationDomain *domain, SoupMessage *message);
|
|
Packit |
4b6dd7 |
gboolean (*is_authorized_for_domain) (GDataAuthorizer *self, GDataAuthorizationDomain *domain);
|
|
Packit |
4b6dd7 |
gboolean (*refresh_authorization) (GDataAuthorizer *self, GCancellable *cancellable, GError **error);
|
|
Packit |
4b6dd7 |
void (*refresh_authorization_async) (GDataAuthorizer *self, GCancellable *cancellable,
|
|
Packit |
4b6dd7 |
GAsyncReadyCallback callback, gpointer user_data);
|
|
Packit |
4b6dd7 |
gboolean (*refresh_authorization_finish) (GDataAuthorizer *self, GAsyncResult *async_result, GError **error);
|
|
Packit |
4b6dd7 |
} GDataAuthorizerInterface;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The class structure for the GDataAuthorizer interface.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Members
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GTypeInterface parent;
|
|
Packit |
4b6dd7 |
the parent type
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
process_request ()
|
|
Packit |
4b6dd7 |
a function to append authorization headers to queries before they are submitted to the online service under the given
|
|
Packit |
4b6dd7 |
authorization domain (which may be NULL); this must be implemented and must be thread safe, and must also handle being called multiple times on
|
|
Packit |
4b6dd7 |
the same SoupMessage instance (so must be careful to replace headers rather than append them, for example)
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
is_authorized_for_domain ()
|
|
Packit |
4b6dd7 |
a function to check whether the authorizer is authorized against the given domain; this must be implemented and must
|
|
Packit |
4b6dd7 |
be thread safe
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
refresh_authorization ()
|
|
Packit |
4b6dd7 |
a function to force a refresh of any authorization tokens the authorizer holds, returning TRUE if a refresh
|
|
Packit |
4b6dd7 |
was attempted and was successful, or FALSE if a refresh wasn't attempted or was unsuccessful; if this isn't implemented it's assumed FALSE
|
|
Packit |
4b6dd7 |
would've been returned, if it is implemented it must be thread safe.
|
|
Packit |
4b6dd7 |
[allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
refresh_authorization_async ()
|
|
Packit |
4b6dd7 |
an asynchronous version of refresh_authorization
|
|
Packit |
4b6dd7 |
; if this isn't implemented and refresh_authorization
|
|
Packit |
4b6dd7 |
is, refresh_authorization
|
|
Packit |
4b6dd7 |
will be called in a thread to simulate this function, whereas if this is implemented refresh_authorization_finish
|
|
Packit |
4b6dd7 |
must
|
|
Packit |
4b6dd7 |
also be implemented and both functions must be thread safe.
|
|
Packit |
4b6dd7 |
[allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
refresh_authorization_finish ()
|
|
Packit |
4b6dd7 |
a finish function for the asynchronous version of refresh_authorization
|
|
Packit |
4b6dd7 |
; this must be implemented
|
|
Packit |
4b6dd7 |
exactly if refresh_authorization_async
|
|
Packit |
4b6dd7 |
is implemented, and must be thread safe if it is implemented.
|
|
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 |
|
|
Packit |
4b6dd7 |
Generated by GTK-Doc V1.26.1
|
|
Packit |
4b6dd7 |
</body>
|
|
Packit |
4b6dd7 |
</html>
|