gdata_authorizer_process_request ()

void
gdata_authorizer_process_request (GDataAuthorizer *self,
                                  GDataAuthorizationDomain *domain,
                                  SoupMessage *message);

Processes message , adding all the necessary extra headers and parameters to ensure that it's correctly authenticated and authorized under the given domain 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 if it's a query from a non-logged-in user. Similarly, if the GDataAuthorizer isn't authenticated or authorized (for domain ), no changes will be made to the message .

domain may be NULL if the request doesn't require authorization.

This modifies message in place.

This method is thread safe.

Since: 0.9.0

gdata_authorizer_is_authorized_for_domain ()

gboolean
gdata_authorizer_is_authorized_for_domain
                               (GDataAuthorizer *self,
                                GDataAuthorizationDomain *domain);

Returns whether the GDataAuthorizer instance believes it's currently authorized to access the given domain . Note that this will not perform any 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 of date, as the server may have since invalidated the authorization. If the GDataAuthorizer class supports timeouts and TTLs on authorizations, they will not be taken into account; this method effectively returns whether the last successful authorization operation performed on the GDataAuthorizer included domain in the list of requested authorization domains.

Note that NULL may be passed as the GDataAuthorizer, in which case FALSE will always be returned, regardless of the domain . This is for convenience of checking whether a domain is authorized by the GDataAuthorizer returned by gdata_service_get_authorizer(), which may be NULL. For example:

1
2
3

if (gdata_authorizer_is_authorized_for_domain (gdata_service_get_authorizer (my_service), my_domain) == TRUE) {
    /<!-- -->* Code to execute only if we're authorized for the given domain *<!-- -->/
}

This method is thread safe.

Since: 0.9.0

gdata_authorizer_refresh_authorization ()

gboolean
gdata_authorizer_refresh_authorization
                               (GDataAuthorizer *self,
                                GCancellable *cancellable,
                                GError **error);

Forces the GDataAuthorizer to refresh any authorization tokens it holds with the online service. This should typically be called when a GDataService query returns GDATA_SERVICE_ERROR_AUTHENTICATION_REQUIRED, and is already called transparently by methods such as gdata_service_query() and gdata_service_insert_entry() (see their documentation for more details).

If re-authorization is successful, it's guaranteed that by the time this method returns, the properties containing the relevant authorization tokens on the GDataAuthorizer instance will have been updated.

If FALSE is returned, error will be set if (and only if) it's due to a refresh being attempted and failing. If a refresh is not attempted, FALSE will be returned but error will not be set.

If the GDataAuthorizer has not been previously authenticated or authorized (using the class' specific methods), no authorization will be attempted, FALSE will be returned immediately and error will not be set.

Some GDataAuthorizer implementations may not support refreshing authorization tokens at all; for example if doing so requires user interaction. FALSE will be returned immediately in that case and error will not be set.

This method is thread safe.

Since: 0.9.0

gdata_authorizer_refresh_authorization_async ()

void
gdata_authorizer_refresh_authorization_async
                               (GDataAuthorizer *self,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

Forces the GDataAuthorizer to refresh any authorization tokens it holds with the online service. self and cancellable are reffed when this method is called, so can safely be freed after this method returns.

For more details, see gdata_authorizer_refresh_authorization(), which is the synchronous version of this method. If the GDataAuthorizer class doesn't implement GDataAuthorizerInterface.refresh_authorization_async but does implement GDataAuthorizerInterface.refresh_authorization, the latter will be called from a new thread to make it asynchronous.

When the authorization refresh operation is finished, callback will be called. You can then call gdata_authorizer_refresh_authorization_finish() to get the results of the operation.

This method is thread safe.

Since: 0.9.0

gdata_authorizer_refresh_authorization_finish ()

gboolean
gdata_authorizer_refresh_authorization_finish
                               (GDataAuthorizer *self,
                                GAsyncResult *async_result,
                                GError **error);

Finishes an asynchronous authorization refresh operation for the GDataAuthorizer, as started with gdata_authorizer_refresh_authorization_async().

This method is thread safe.

Since: 0.9.0

GDataAuthorizer

typedef struct _GDataAuthorizer GDataAuthorizer;

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

Since: 0.9.0

GDataAuthorizerInterface

typedef struct {
	GTypeInterface parent;

	void (*process_request) (GDataAuthorizer *self, GDataAuthorizationDomain *domain, SoupMessage *message);
	gboolean (*is_authorized_for_domain) (GDataAuthorizer *self, GDataAuthorizationDomain *domain);
	gboolean (*refresh_authorization) (GDataAuthorizer *self, GCancellable *cancellable, GError **error);
	void (*refresh_authorization_async) (GDataAuthorizer *self, GCancellable *cancellable,
	                                     GAsyncReadyCallback callback, gpointer user_data);
	gboolean (*refresh_authorization_finish) (GDataAuthorizer *self, GAsyncResult *async_result, GError **error);
} GDataAuthorizerInterface;

The class structure for the GDataAuthorizer interface.

Since: 0.9.0