|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
<html>
|
|
Packit |
4b6dd7 |
<head>
|
|
Packit |
4b6dd7 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
4b6dd7 |
<title>GDataAuthorizationDomain: 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="GDataAuthorizer.html" title="GDataAuthorizer">
|
|
Packit |
4b6dd7 |
<link rel="next" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer">
|
|
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 |
GDataAuthorizationDomain
|
|
Packit |
4b6dd7 |
GDataAuthorizationDomain — GData authorization domain
|
|
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 |
const gchar *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_authorization_domain_get_service_name ()
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_authorization_domain_get_scope ()
|
|
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 |
scope
|
|
Packit |
4b6dd7 |
Read / Write / Construct Only
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gchar *
|
|
Packit |
4b6dd7 |
service-name
|
|
Packit |
4b6dd7 |
Read / Write / Construct Only
|
|
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 |
GDataAuthorizationDomain
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAuthorizationDomainClass
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Object Hierarchy
|
|
Packit |
4b6dd7 |
GObject
|
|
Packit |
4b6dd7 |
╰── GDataAuthorizationDomain
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Includes
|
|
Packit |
4b6dd7 |
#include <gdata/gdata-authorization-domain.h>
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Description
|
|
Packit |
4b6dd7 |
A GDataAuthorizationDomain represents a single data domain which a user can authorize libgdata to access. This might be a domain covering the
|
|
Packit |
4b6dd7 |
whole of the user's Google Contacts account, for example. Typically, GDataServices map to GDataAuthorizationDomains in a one-to-one
|
|
Packit |
4b6dd7 |
fashion, though some services (such as GDataDocumentsService) use multiple authorization domains.
|
|
Packit |
4b6dd7 |
The GDataAuthorizationDomainss used by a service can be retrieved using gdata_service_get_authorization_domains(). The set of domains
|
|
Packit |
4b6dd7 |
used by a given service is static and will never change at runtime.
|
|
Packit |
4b6dd7 |
GDataAuthorizationDomains are used by a GDataAuthorizer instance to request authorization to interact with data in those domains when
|
|
Packit |
4b6dd7 |
first authenticating and authorizing with the online service. Typically, a given GDataAuthorizer will be passed a set of domains (or a service
|
|
Packit |
4b6dd7 |
type, from which it can retrieve the service's set of domains) at construction time, and will use those domains when initially asking the user for
|
|
Packit |
4b6dd7 |
authorization and whenever the authorization is refreshed afterwards. It's not expected that the set of domains used by a GDataAuthorizer will
|
|
Packit |
4b6dd7 |
change after construction time.
|
|
Packit |
4b6dd7 |
Note that it's not expected that GDataAuthorizationDomains will have to be constructed manually. All GDataServices should provide
|
|
Packit |
4b6dd7 |
accessor functions to return instances of all the authorization domains they support.
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Functions
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_authorization_domain_get_service_name ()
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
gdata_authorization_domain_get_service_name
|
|
Packit |
4b6dd7 |
(GDataAuthorizationDomain *self);
|
|
Packit |
4b6dd7 |
Returns the name of the service containing the authorization domain. See “service-name” for more details.
|
|
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 GDataAuthorizationDomain
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
name of the service containing the authorization domain
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gdata_authorization_domain_get_scope ()
|
|
Packit |
4b6dd7 |
const gchar *
|
|
Packit |
4b6dd7 |
gdata_authorization_domain_get_scope (GDataAuthorizationDomain *self);
|
|
Packit |
4b6dd7 |
Returns a URI detailing the scope of the authorization domain. See “scope” for more details.
|
|
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 GDataAuthorizationDomain
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Returns
|
|
Packit |
4b6dd7 |
URI detailing the scope of the authorization domain
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Types and Values
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAuthorizationDomain
|
|
Packit |
4b6dd7 |
typedef struct _GDataAuthorizationDomain GDataAuthorizationDomain;
|
|
Packit |
4b6dd7 |
All the fields in the GDataAuthorizationDomain structure are private and should never be accessed directly.
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataAuthorizationDomainClass
|
|
Packit |
4b6dd7 |
typedef struct {
|
|
Packit |
4b6dd7 |
} GDataAuthorizationDomainClass;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
All the fields in the GDataAuthorizationDomainClass structure are private and should never be accessed directly.
|
|
Packit |
4b6dd7 |
Since: 0.9.0
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
Property Details
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
The “scope” property
|
|
Packit |
4b6dd7 |
“scope” gchar *
|
|
Packit |
4b6dd7 |
A URI detailing the scope of the authorization domain, as enumerated in the
|
|
Packit |
4b6dd7 |
online documentation.
|
|
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 “service-name” property
|
|
Packit |
4b6dd7 |
“service-name” gchar *
|
|
Packit |
4b6dd7 |
The name of the service which contains the authorization domain, as enumerated in the
|
|
Packit |
4b6dd7 |
online documentation.
|
|
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 |
|
|
Packit |
4b6dd7 |
Generated by GTK-Doc V1.26.1
|
|
Packit |
4b6dd7 |
</body>
|
|
Packit |
4b6dd7 |
</html>
|