|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
<html>
|
|
Packit |
4b6dd7 |
<head>
|
|
Packit |
4b6dd7 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
4b6dd7 |
<title>GDataAccessRule: 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="GDataAccessHandler.html" title="GDataAccessHandler">
|
|
Packit |
4b6dd7 |
<link rel="next" href="ch04.html" title="Batch Operation API">
|
|
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 |
Properties
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAccessRule
|
|
Packit |
4b6dd7 |
GDataAccessRule — GData access rule object
|
|
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 |
GDataAccessRule *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_access_rule_new ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_access_rule_get_role ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
void
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_access_rule_set_role ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
void
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_access_rule_get_scope ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
void
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_access_rule_set_scope ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gint64
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_access_rule_get_edited ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_access_rule_get_key ()
|
|
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 |
gint64
|
|
Packit |
4b6dd7 |
edited
|
|
Packit |
4b6dd7 |
Read
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gchar *
|
|
Packit |
4b6dd7 |
key
|
|
Packit |
4b6dd7 |
Read
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gchar *
|
|
Packit |
4b6dd7 |
role
|
|
Packit |
4b6dd7 |
Read / Write
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gchar *
|
|
Packit |
4b6dd7 |
scope-type
|
|
Packit |
4b6dd7 |
Read / Write
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gchar *
|
|
Packit |
4b6dd7 |
scope-value
|
|
Packit |
4b6dd7 |
Read / Write
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Types and Values
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
#define
|
|
Packit |
4b6dd7 |
GDATA_ACCESS_SCOPE_USER
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
#define
|
|
Packit |
4b6dd7 |
GDATA_ACCESS_SCOPE_DOMAIN
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
#define
|
|
Packit |
4b6dd7 |
GDATA_ACCESS_SCOPE_DEFAULT
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
#define
|
|
Packit |
4b6dd7 |
GDATA_ACCESS_ROLE_NONE
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAccessRule
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAccessRuleClass
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Object Hierarchy
|
|
Packit |
4b6dd7 |
GObject
|
|
Packit |
4b6dd7 |
╰── GDataParsable
|
|
Packit |
4b6dd7 |
╰── GDataEntry
|
|
Packit |
4b6dd7 |
╰── GDataAccessRule
|
|
Packit |
4b6dd7 |
├── GDataCalendarAccessRule
|
|
Packit |
4b6dd7 |
╰── GDataDocumentsAccessRule
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Includes
|
|
Packit |
4b6dd7 |
#include <gdata/gdata-access-rule.h>
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Description
|
|
Packit |
4b6dd7 |
GDataAccessRule is a subclass of GDataEntry to represent a generic access rule from an access control list (ACL).
|
|
Packit |
4b6dd7 |
It is returned by the ACL methods implemented in the GDataAccessHandler interface.
|
|
Packit |
4b6dd7 |
Access rules should be inserted to the GDATA_LINK_ACCESS_CONTROL_LIST URI of the feed or entry they should be applied to. This will return a
|
|
Packit |
4b6dd7 |
GDATA_SERVICE_ERROR_CONFLICT error if a rule already exists on that feed or entry for that scope type and value.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Example 4. Adding a Rule to the Access Control List for an Entry
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
1
|
|
Packit |
4b6dd7 |
2
|
|
Packit |
4b6dd7 |
3
|
|
Packit |
4b6dd7 |
4
|
|
Packit |
4b6dd7 |
5
|
|
Packit |
4b6dd7 |
6
|
|
Packit |
4b6dd7 |
7
|
|
Packit |
4b6dd7 |
8
|
|
Packit |
4b6dd7 |
9
|
|
Packit |
4b6dd7 |
10
|
|
Packit |
4b6dd7 |
11
|
|
Packit |
4b6dd7 |
12
|
|
Packit |
4b6dd7 |
13
|
|
Packit |
4b6dd7 |
14
|
|
Packit |
4b6dd7 |
15
|
|
Packit |
4b6dd7 |
16
|
|
Packit |
4b6dd7 |
17
|
|
Packit |
4b6dd7 |
18
|
|
Packit |
4b6dd7 |
19
|
|
Packit |
4b6dd7 |
20
|
|
Packit |
4b6dd7 |
21
|
|
Packit |
4b6dd7 |
22
|
|
Packit |
4b6dd7 |
23
|
|
Packit |
4b6dd7 |
24
|
|
Packit |
4b6dd7 |
25
|
|
Packit |
4b6dd7 |
26
|
|
Packit |
4b6dd7 |
27
|
|
Packit |
4b6dd7 |
28
|
|
Packit |
4b6dd7 |
29
|
|
Packit |
4b6dd7 |
30
|
|
Packit |
4b6dd7 |
31
|
|
Packit |
4b6dd7 |
32
|
|
Packit |
4b6dd7 |
33
|
|
Packit |
4b6dd7 |
34
|
|
Packit |
4b6dd7 |
35
|
|
Packit |
4b6dd7 |
36
|
|
Packit |
4b6dd7 |
37
|
|
Packit |
4b6dd7 |
38
|
|
Packit |
4b6dd7 |
GDataAuthorizationDomain *domain;
|
|
Packit |
4b6dd7 |
GDataService *service;
|
|
Packit |
4b6dd7 |
GDataEntry *entry;
|
|
Packit |
4b6dd7 |
GDataFeed *acl_feed;
|
|
Packit |
4b6dd7 |
GDataAccessRule *rule, *new_rule;
|
|
Packit |
4b6dd7 |
GError *error = NULL;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
domain = gdata_documents_service_get_primary_authorization_domain ();
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
service = build_my_service ();
|
|
Packit |
4b6dd7 |
entry = get_the_entry (service);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
example@gmail.com
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
rule = gdata_access_rule_new (NULL);
|
|
Packit |
4b6dd7 |
gdata_access_rule_set_role (rule, GDATA_ACCESS_ROLE_NONE);
|
|
Packit |
4b6dd7 |
gdata_access_rule_set_scope (rule, GDATA_ACCESS_SCOPE_USER, "example@gmail.com");
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
acl_link = gdata_entry_look_up_link (entry, GDATA_LINK_ACCESS_CONTROL_LIST);
|
|
Packit |
4b6dd7 |
new_rule = GDATA_ACCESS_RULE (gdata_service_insert_entry (GDATA_SERVICE (service), domain, gdata_link_get_uri (acl_link),
|
|
Packit |
4b6dd7 |
GDATA_ENTRY (rule), NULL, &error));
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
g_object_unref (rule);
|
|
Packit |
4b6dd7 |
g_object_unref (entry);
|
|
Packit |
4b6dd7 |
g_object_unref (service);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
if (error != NULL) {
|
|
Packit |
4b6dd7 |
g_error ("Error inserting access rule: %s", error->message);
|
|
Packit |
4b6dd7 |
g_error_free (error);
|
|
Packit |
4b6dd7 |
return;
|
|
Packit |
4b6dd7 |
}
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
g_object_unref (new_rule);
|
|
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_access_rule_new ()
|
|
Packit |
4b6dd7 |
GDataAccessRule *
|
|
Packit |
4b6dd7 |
gdata_access_rule_new (const gchar *id);
|
|
Packit |
4b6dd7 |
Creates a new GDataAccessRule with the given ID and default properties.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Parameters
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
id
|
|
Packit |
4b6dd7 |
the access rule's ID, or NULL
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
a new GDataAccessRule; unref with g_object_unref()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.3.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_access_rule_get_role ()
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
gdata_access_rule_get_role (GDataAccessRule *self);
|
|
Packit |
4b6dd7 |
Gets the “role” property.
|
|
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 GDataAccessRule
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
the access rule's role, or NULL
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.3.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_access_rule_set_role ()
|
|
Packit |
4b6dd7 |
void
|
|
Packit |
4b6dd7 |
gdata_access_rule_set_role (GDataAccessRule *self,
|
|
Packit |
4b6dd7 |
const gchar *role);
|
|
Packit |
4b6dd7 |
Sets the “role” property to role
|
|
Packit |
4b6dd7 |
. role
|
|
Packit |
4b6dd7 |
must be a non-empty string, such as GDATA_ACCESS_ROLE_NONE.
|
|
Packit |
4b6dd7 |
Set role
|
|
Packit |
4b6dd7 |
to NULL to unset the property in the access rule.
|
|
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 GDataAccessRule
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
role
|
|
Packit |
4b6dd7 |
a new role, or NULL
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.3.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_access_rule_get_scope ()
|
|
Packit |
4b6dd7 |
void
|
|
Packit |
4b6dd7 |
gdata_access_rule_get_scope (GDataAccessRule *self,
|
|
Packit |
4b6dd7 |
const gchar **type,
|
|
Packit |
4b6dd7 |
const gchar **value);
|
|
Packit |
4b6dd7 |
Gets the “scope-type” and “scope-value” properties.
|
|
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 GDataAccessRule
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
type
|
|
Packit |
4b6dd7 |
return location for the scope type, or NULL.
|
|
Packit |
4b6dd7 |
[out callee-allocates][transfer none][allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
value
|
|
Packit |
4b6dd7 |
return location for the scope value, or NULL.
|
|
Packit |
4b6dd7 |
[out callee-allocates][transfer none][allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.3.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_access_rule_set_scope ()
|
|
Packit |
4b6dd7 |
void
|
|
Packit |
4b6dd7 |
gdata_access_rule_set_scope (GDataAccessRule *self,
|
|
Packit |
4b6dd7 |
const gchar *type,
|
|
Packit |
4b6dd7 |
const gchar *value);
|
|
Packit |
4b6dd7 |
Sets the “scope-type” property to type
|
|
Packit |
4b6dd7 |
and the “scope-value” property to value
|
|
Packit |
4b6dd7 |
.
|
|
Packit |
4b6dd7 |
Set scope_value
|
|
Packit |
4b6dd7 |
to NULL to unset the “scope-value” property in the access rule. type
|
|
Packit |
4b6dd7 |
cannot
|
|
Packit |
4b6dd7 |
be NULL. scope_value
|
|
Packit |
4b6dd7 |
must be NULL if type
|
|
Packit |
4b6dd7 |
is default, and non-NULL otherwise.
|
|
Packit |
4b6dd7 |
See the
|
|
Packit |
4b6dd7 |
online
|
|
Packit |
4b6dd7 |
documentation for more information.
|
|
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 GDataAccessRule
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
type
|
|
Packit |
4b6dd7 |
a new scope type
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
value
|
|
Packit |
4b6dd7 |
a new scope value, or NULL.
|
|
Packit |
4b6dd7 |
[allow-none]
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.3.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_access_rule_get_edited ()
|
|
Packit |
4b6dd7 |
gint64
|
|
Packit |
4b6dd7 |
gdata_access_rule_get_edited (GDataAccessRule *self);
|
|
Packit |
4b6dd7 |
Gets the “edited” property. If the property is unset, -1 will be returned.
|
|
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 GDataAccessRule
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
the UNIX timestamp for the time the access rule was last edited, or -1
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_access_rule_get_key ()
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
gdata_access_rule_get_key (GDataAccessRule *self);
|
|
Packit |
4b6dd7 |
Gets the “key” property.
|
|
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 GDataAccessRule
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
the access rule's authorisation key, or NULL
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.16.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Types and Values
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_ACCESS_SCOPE_USER
|
|
Packit |
4b6dd7 |
#define GDATA_ACCESS_SCOPE_USER "user"
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The GDataAccessRule applies to a single individual, whose e-mail address is given in “scope-value”.
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_ACCESS_SCOPE_DOMAIN
|
|
Packit |
4b6dd7 |
#define GDATA_ACCESS_SCOPE_DOMAIN "domain"
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The GDataAccessRule applies to all users in a Google Apps For Your Domain domain, given in “scope-value”.
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_ACCESS_SCOPE_DEFAULT
|
|
Packit |
4b6dd7 |
#define GDATA_ACCESS_SCOPE_DEFAULT "default"
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The GDataAccessRule applies to all users.
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDATA_ACCESS_ROLE_NONE
|
|
Packit |
4b6dd7 |
#define GDATA_ACCESS_ROLE_NONE "none"
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The users specified by the GDataAccessRule have no rights.
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAccessRule
|
|
Packit |
4b6dd7 |
typedef struct _GDataAccessRule GDataAccessRule;
|
|
Packit |
4b6dd7 |
All the fields in the GDataAccessRule structure are private and should never be accessed directly.
|
|
Packit |
4b6dd7 |
Since: 0.3.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAccessRuleClass
|
|
Packit |
4b6dd7 |
typedef struct {
|
|
Packit |
4b6dd7 |
} GDataAccessRuleClass;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
All the fields in the GDataAccessRuleClass structure are private and should never be accessed directly.
|
|
Packit |
4b6dd7 |
Since: 0.3.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Property Details
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “edited” property
|
|
Packit |
4b6dd7 |
“edited” gint64
|
|
Packit |
4b6dd7 |
The last time the access rule was edited. If the rule has not been edited yet, the content indicates the time it was created.
|
|
Packit |
4b6dd7 |
For more information, see the
|
|
Packit |
4b6dd7 |
Atom Publishing Protocol specification.
|
|
Packit |
4b6dd7 |
Flags: Read
|
|
Packit |
4b6dd7 |
Allowed values: >= -1
|
|
Packit |
4b6dd7 |
Default value: -1
|
|
Packit |
4b6dd7 |
Since: 0.7.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “key” property
|
|
Packit |
4b6dd7 |
“key” gchar *
|
|
Packit |
4b6dd7 |
An optional authorisation key required to access this item with the given scope. If set, this restricts
|
|
Packit |
4b6dd7 |
access to those principals who have a copy of the key. The key is generated server-side and cannot be
|
|
Packit |
4b6dd7 |
modified by the client. If no authorisation key is set (and hence none is needed for access to the item),
|
|
Packit |
4b6dd7 |
this will be NULL.
|
|
Packit |
4b6dd7 |
Flags: Read
|
|
Packit |
4b6dd7 |
Default value: NULL
|
|
Packit |
4b6dd7 |
Since: 0.16.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “role” property
|
|
Packit |
4b6dd7 |
“role” gchar *
|
|
Packit |
4b6dd7 |
The role of the person concerned by this ACL. By default, this can only be GDATA_ACCESS_ROLE_NONE. Services may extend it with
|
|
Packit |
4b6dd7 |
their own namespaced roles.
|
|
Packit |
4b6dd7 |
Flags: Read / Write
|
|
Packit |
4b6dd7 |
Default value: "none"
|
|
Packit |
4b6dd7 |
Since: 0.3.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “scope-type” property
|
|
Packit |
4b6dd7 |
“scope-type” gchar *
|
|
Packit |
4b6dd7 |
Specifies to whom this access rule applies. For example, GDATA_ACCESS_SCOPE_USER or GDATA_ACCESS_SCOPE_DEFAULT.
|
|
Packit |
4b6dd7 |
Flags: Read / Write
|
|
Packit |
4b6dd7 |
Default value: "default"
|
|
Packit |
4b6dd7 |
Since: 0.3.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “scope-value” property
|
|
Packit |
4b6dd7 |
“scope-value” gchar *
|
|
Packit |
4b6dd7 |
A value representing the user who is represented by the access rule, such as an
|
|
Packit |
4b6dd7 |
e-mail address for users, or a domain name for domains.
|
|
Packit |
4b6dd7 |
This must be NULL if and only if “scope-type” is GDATA_ACCESS_SCOPE_DEFAULT.
|
|
Packit |
4b6dd7 |
Flags: Read / Write
|
|
Packit |
4b6dd7 |
Default value: NULL
|
|
Packit |
4b6dd7 |
Since: 0.3.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Generated by GTK-Doc V1.26.1
|
|
Packit |
4b6dd7 |
</body>
|
|
Packit |
4b6dd7 |
</html>
|