|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
<html>
|
|
Packit |
4b6dd7 |
<head>
|
|
Packit |
4b6dd7 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
4b6dd7 |
<title>GDataAccessHandler: 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="ch03.html" title="Access Control List API">
|
|
Packit |
4b6dd7 |
<link rel="prev" href="ch03.html" title="Access Control List API">
|
|
Packit |
4b6dd7 |
<link rel="next" href="GDataAccessRule.html" title="GDataAccessRule">
|
|
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 |
GDataAccessHandler
|
|
Packit |
4b6dd7 |
GDataAccessHandler — GData access handler 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 |
GDataFeed *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_access_handler_get_rules ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
void
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_access_handler_get_rules_async ()
|
|
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 |
#define
|
|
Packit |
4b6dd7 |
GDATA_LINK_ACCESS_CONTROL_LIST
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAccessHandler
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAccessHandlerIface
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Object Hierarchy
|
|
Packit |
4b6dd7 |
GInterface
|
|
Packit |
4b6dd7 |
╰── GDataAccessHandler
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Prerequisites
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAccessHandler requires
|
|
Packit |
4b6dd7 |
GDataEntry.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Known Implementations
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAccessHandler is implemented by
|
|
Packit |
4b6dd7 |
GDataCalendarCalendar, GDataDocumentsDocument, GDataDocumentsDrawing, GDataDocumentsEntry, GDataDocumentsFolder, GDataDocumentsPdf, GDataDocumentsPresentation, GDataDocumentsSpreadsheet and GDataDocumentsText.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Includes
|
|
Packit |
4b6dd7 |
#include <gdata/gdata-access-handler.h>
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Description
|
|
Packit |
4b6dd7 |
GDataAccessHandler is an interface which can be implemented by GDataEntrys which can have their permissions controlled by an
|
|
Packit |
4b6dd7 |
access control list (ACL). It has a set of methods which allow the GDataAccessRules for the access handler/entry to be retrieved,
|
|
Packit |
4b6dd7 |
added, modified and deleted, with immediate effect.
|
|
Packit |
4b6dd7 |
For an example of inserting an access rule into an ACL, see the documentation for GDataAccessRule.
|
|
Packit |
4b6dd7 |
When implementing the interface, classes must implement an is_owner_rule function. It's optional to implement a
|
|
Packit |
4b6dd7 |
get_authorization_domain function, but if it's not implemented, any operations on the access handler's
|
|
Packit |
4b6dd7 |
GDataAccessRules will be performed unauthorized (i.e. as if by a non-logged-in user). This will not usually work.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Functions
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_access_handler_get_rules ()
|
|
Packit |
4b6dd7 |
GDataFeed *
|
|
Packit |
4b6dd7 |
gdata_access_handler_get_rules (GDataAccessHandler *self,
|
|
Packit |
4b6dd7 |
GDataService *service,
|
|
Packit |
4b6dd7 |
GCancellable *cancellable,
|
|
Packit |
4b6dd7 |
GDataQueryProgressCallback progress_callback,
|
|
Packit |
4b6dd7 |
gpointer progress_user_data,
|
|
Packit |
4b6dd7 |
GError **error);
|
|
Packit |
4b6dd7 |
Retrieves a GDataFeed containing all the access rules which apply to the given GDataAccessHandler. Only the owner of a GDataAccessHandler may
|
|
Packit |
4b6dd7 |
view its rule feed.
|
|
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 |
A GDATA_SERVICE_ERROR_PROTOCOL_ERROR will be returned if the server indicates there is a problem with the query.
|
|
Packit |
4b6dd7 |
For each rule in the response feed, progress_callback
|
|
Packit |
4b6dd7 |
will be called in the main thread. If there was an error parsing the XML response,
|
|
Packit |
4b6dd7 |
a GDataParserError will be returned.
|
|
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 GDataAccessHandler
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
service
|
|
Packit |
4b6dd7 |
a GDataService
|
|
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 |
progress_callback
|
|
Packit |
4b6dd7 |
a GDataQueryProgressCallback to call when a rule is loaded, or NULL.
|
|
Packit |
4b6dd7 |
[allow-none][scope call][closure progress_user_data]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
progress_user_data
|
|
Packit |
4b6dd7 |
data to pass to the progress_callback
|
|
Packit |
4b6dd7 |
function.
|
|
Packit |
4b6dd7 |
[closure]
|
|
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 |
a GDataFeed of access control rules, or NULL; unref with g_object_unref().
|
|
Packit |
4b6dd7 |
[transfer full]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.3.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_access_handler_get_rules_async ()
|
|
Packit |
4b6dd7 |
void
|
|
Packit |
4b6dd7 |
gdata_access_handler_get_rules_async (GDataAccessHandler *self,
|
|
Packit |
4b6dd7 |
GDataService *service,
|
|
Packit |
4b6dd7 |
GCancellable *cancellable,
|
|
Packit |
4b6dd7 |
GDataQueryProgressCallback progress_callback,
|
|
Packit |
4b6dd7 |
gpointer progress_user_data,
|
|
Packit |
4b6dd7 |
GDestroyNotify destroy_progress_user_data,
|
|
Packit |
4b6dd7 |
GAsyncReadyCallback callback,
|
|
Packit |
4b6dd7 |
gpointer user_data);
|
|
Packit |
4b6dd7 |
Retrieves a GDataFeed containing all the access rules which apply to the given GDataAccessHandler. Only the owner of a GDataAccessHandler may
|
|
Packit |
4b6dd7 |
view its rule feed. self
|
|
Packit |
4b6dd7 |
and service
|
|
Packit |
4b6dd7 |
are both reffed when this function is called, so can safely be unreffed after this function returns.
|
|
Packit |
4b6dd7 |
For more details, see gdata_access_handler_get_rules(), which is the synchronous version of this function, and gdata_service_query_async(), which
|
|
Packit |
4b6dd7 |
is the base asynchronous query function.
|
|
Packit |
4b6dd7 |
When the operation is finished, callback
|
|
Packit |
4b6dd7 |
will be called. You can then call gdata_service_query_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 GDataAccessHandler
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
service
|
|
Packit |
4b6dd7 |
a GDataService
|
|
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 |
progress_callback
|
|
Packit |
4b6dd7 |
a GDataQueryProgressCallback to call when a rule is loaded, or NULL.
|
|
Packit |
4b6dd7 |
[allow-none][closure progress_user_data]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
progress_user_data
|
|
Packit |
4b6dd7 |
data to pass to the progress_callback
|
|
Packit |
4b6dd7 |
function.
|
|
Packit |
4b6dd7 |
[closure]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
destroy_progress_user_data
|
|
Packit |
4b6dd7 |
the function to call when progress_callback
|
|
Packit |
4b6dd7 |
will not be called any more, or NULL. This function will be
|
|
Packit |
4b6dd7 |
called with progress_user_data
|
|
Packit |
4b6dd7 |
as a parameter and can be used to free any memory allocated for it.
|
|
Packit |
4b6dd7 |
[allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
callback
|
|
Packit |
4b6dd7 |
a GAsyncReadyCallback to call when the query 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.1
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Types and Values
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_LINK_ACCESS_CONTROL_LIST
|
|
Packit |
4b6dd7 |
#define GDATA_LINK_ACCESS_CONTROL_LIST "http://schemas.google.com/acl/2007#accessControlList"
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The relation type URI of the access control list location for this resource.
|
|
Packit |
4b6dd7 |
For more information, see the
|
|
Packit |
4b6dd7 |
ACL specification.
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAccessHandler
|
|
Packit |
4b6dd7 |
typedef struct _GDataAccessHandler GDataAccessHandler;
|
|
Packit |
4b6dd7 |
All the fields in the GDataAccessHandler structure are private and should never be accessed directly.
|
|
Packit |
4b6dd7 |
Since: 0.3.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAccessHandlerIface
|
|
Packit |
4b6dd7 |
typedef struct {
|
|
Packit |
4b6dd7 |
GTypeInterface parent;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gboolean (*is_owner_rule) (GDataAccessRule *rule);
|
|
Packit |
4b6dd7 |
GDataAuthorizationDomain *(*get_authorization_domain) (GDataAccessHandler *self);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataFeed *(*get_rules) (GDataAccessHandler *self,
|
|
Packit |
4b6dd7 |
GDataService *service,
|
|
Packit |
4b6dd7 |
GCancellable *cancellable,
|
|
Packit |
4b6dd7 |
GDataQueryProgressCallback progress_callback,
|
|
Packit |
4b6dd7 |
gpointer progress_user_data,
|
|
Packit |
4b6dd7 |
GError **error);
|
|
Packit |
4b6dd7 |
} GDataAccessHandlerIface;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The class structure for the GDataAccessHandler 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 |
is_owner_rule ()
|
|
Packit |
4b6dd7 |
a function to return whether the given GDataAccessRule has the role of an owner (of a GDataAccessHandler).
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
get_authorization_domain ()
|
|
Packit |
4b6dd7 |
a function to return the GDataAuthorizationDomain to be used for all operations on the access rules
|
|
Packit |
4b6dd7 |
belonging to this access handler; not implementing this function is equivalent to returning NULL from it, which signifies that operations on the
|
|
Packit |
4b6dd7 |
access rules don't require authorization; new in version 0.9.0.
|
|
Packit |
4b6dd7 |
[allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
get_rules ()
|
|
Packit |
4b6dd7 |
a function to query, parse and return a GDataFeed of
|
|
Packit |
4b6dd7 |
GDataAccessRules for a given entry — the virtual function for
|
|
Packit |
4b6dd7 |
gdata_access_handler_get_rules(); new in version 0.17.2.
|
|
Packit |
4b6dd7 |
[nullable]
|
|
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>
|