Creates a new #GDataOAuth2Authorizer. The client_id
must be unique for your
application, and as registered with Google, and the client_secret
must be
paired with it.
your application’s client ID
your application’s client secret
authorisation redirect URI
the #GType of a #GDataService subclass which the #GDataOAuth2Authorizer will be used with
A client ID for your application (see the
It is recommended that the ID is of the form
Client secret provided by Google. This is unique for each application and is accessible from Google’s Developer Console when registering an application. It must be paired with the #GDataOAuth2Authorizer:client-id.
See the
The locale to use for network requests, in UNIX locale format. (e.g. "en_GB", "cs", "de_DE".) Use %NULL for the default "C" locale (typically "en_US").
This locale will be used by the server-side software to localise the authentication and authorization pages at the URI returned by gdata_oauth2_authorizer_build_authentication_uri().
The server-side behaviour is undefined if it doesn't support a given locale.
The #GProxyResolver used to determine a proxy URI.
Redirect URI to send the response from the authorisation request to.
This must either be %GDATA_OAUTH2_REDIRECT_URI_OOB,
%GDATA_OAUTH2_REDIRECT_URI_OOB_AUTO, or a
http://localhost
URI with any port number (optionally)
specified.
This URI is where the authorisation server will redirect the user
after they have completed interacting with the authentication page
(gdata_oauth2_authorizer_build_authentication_uri()). If it is
%GDATA_OAUTH2_REDIRECT_URI_OOB, a page will be returned in the user’s
browser with the authorisation code in its title and also embedded in
the page for the user to copy if it is not possible to automatically
extract the code from the page title. If it is
%GDATA_OAUTH2_REDIRECT_URI_OOB_AUTO, a similar page will be returned
with the authorisation code in its title, but without displaying the
code to the user — the user will simply be asked to close the page.
If it is a localhost URI, the authentication page will redirect to
that URI with the authorisation code appended as a code
query parameter. If the user denies the authentication request, the
authentication page will redirect to that URI with
error=access_denied
appended as a query parameter.
Note that the redirect URI used must match that registered in Google’s Developer Console for your application.
See the
The server provided refresh token, which can be stored and passed in to new #GDataOAuth2Authorizer instances before calling gdata_authorizer_refresh_authorization_async() to create a new short-lived access token.
The refresh token is opaque data and must not be parsed.
A timeout, in seconds, for network operations. If the timeout is exceeded, the operation will be cancelled and %GDATA_SERVICE_ERROR_NETWORK_ERROR will be returned.
If the timeout is 0
, operations will
never time out.
Creates a binding between source_property
on source
and target_property
on target
.
Whenever the source_property
is changed the target_property
is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags
contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
if target_property
on target
changes then the source_property
on source
will be updated as well.
The binding will automatically be removed when either the source
or the
target
instances are finalized. To remove the binding without affecting the
source
and the target
you can just call g_object_unref() on the returned
#GBinding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source
and target
are only used from a single thread and it
is clear that both source
and target
outlive the binding. Especially it
is not safe to rely on this if the binding, source
or target
can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A #GObject can have multiple bindings.
the property on source
to bind
the target #GObject
the property on target
to bind
flags to pass to #GBinding
Creates a binding between source_property
on source
and target_property
on target,
allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.
the property on source
to bind
the target #GObject
the property on target
to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source
to the target,
or %NULL to use the default
a #GClosure wrapping the transformation function from the target
to the source,
or %NULL to use the default
Build an authentication URI to open in the user’s web browser (or an embedded browser widget). This will display an authentication page from Google, including an authentication form and confirmation of the authorisation domains being requested by this #GDataAuthorizer. The user will authenticate in the browser, then an authorisation code will be returned via the #GDataOAuth2Authorizer:redirect-uri, ready to be passed to gdata_oauth2_authorizer_request_authorization().
If login_hint
is non-%NULL, it will be passed to the server as a hint of
which user is attempting to authenticate, which can be used to pre-fill the
e-mail address box in the authentication form.
If include_granted_scopes
is %TRUE, the authentication request will
automatically include all authorisation domains previously granted to this
user/application pair, allowing for incremental authentication — asking for
permissions as needed, rather than all in one large bundle at the first
opportunity. If include_granted_scopes
is %FALSE, incremental authentication
will not be enabled, and only the domains passed to the
#GDataOAuth2Authorizer constructor will eventually be authenticated.
See the
optional e-mail address or sub identifier for the user
%TRUE to enable incremental authorisation
Returns the authorizer's refresh token, #GDataOAuth2Authorizer:refresh-token, as set by client code previously on the #GDataOAuth2Authorizer, or as returned by the most recent authentication operation.
This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object
. If the freeze count is
non-zero, the emission of "notify" signals on object
is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
#GObject::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Returns the authorizer's client ID, #GDataOAuth2Authorizer:client-id, as specified on constructing the #GDataOAuth2Authorizer.
Returns the authorizer's client secret, #GDataOAuth2Authorizer:client-secret, as specified on constructing the #GDataOAuth2Authorizer.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Returns the locale currently being used for network requests, or %NULL if the locale is the default.
Gets a property of an object.
The value
can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
Gets the #GProxyResolver on the #GDataOAuth2Authorizer's #SoupSession.
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Returns the authorizer’s redirect URI, #GDataOAuth2Authorizer:redirect-uri, as specified on constructing the #GDataOAuth2Authorizer.
Gets the #GDataOAuth2Authorizer:timeout property; the network timeout, in seconds.
Gets n_properties
properties for an object
.
Obtained properties will be set to values
. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
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:
|[
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.
@param domain the #GDataAuthorizationDomain to check against
Checks whether object
has a [floating][floating-ref] reference.
Emits a "notify" signal for the property property_name
on object
.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
the name of a property installed on the class of object
.
Emits a "notify" signal for the property specified by pspec
on object
.
This function omits the property name lookup, hence it is faster than g_object_notify().
One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the #GParamSpec of a property installed on the class of object
.
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.
the #GDataAuthorizationDomain the query falls under, or %NULL
the query to process
Increase the reference count of object,
and possibly remove the
[floating][floating-ref] reference, if object
has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object
will be propagated to the return type
under the same conditions as for g_object_ref().
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.
optional #GCancellable object, or %NULL
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.
optional #GCancellable object, or %NULL
a #GAsyncReadyCallback to call when the authorization refresh operation is finished, or %NULL
Finishes an asynchronous authorization refresh operation for the #GDataAuthorizer, as started with gdata_authorizer_refresh_authorization_async().
This method is thread safe.
a #GAsyncResult
Request an authorisation code from the user’s web browser is converted to authorisation (access and refresh) tokens. This is the final step in the authentication process; once complete, the #GDataOAuth2Authorizer should be fully authorised for its domains.
On failure, %GDATA_SERVICE_ERROR_FORBIDDEN will be returned if the user or
server denied the authorisation request. %GDATA_SERVICE_ERROR_PROTOCOL_ERROR
will be returned if the server didn’t follow the expected protocol.
%G_IO_ERROR_CANCELLED will be returned if the operation was cancelled using
cancellable
.
code returned from the authentication page
a #GCancellable, or %NULL
Asynchronous version of gdata_oauth2_authorizer_request_authorization().
code returned from the authentication page
an optional #GCancellable, or %NULL
a #GAsyncReadyCallback to call when authorization is finished
Finishes an asynchronous authorization operation started with gdata_oauth2_authorizer_request_authorization_async().
a #GAsyncResult
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key
is converted to a #GQuark using g_quark_from_string().
This means a copy of key
is kept permanently (even after object
has been
finalized) — so it is recommended to only use a small, bounded set of values
for key
in your program, to avoid the #GQuark storage growing unbounded.
name of the key
data to associate with that key
Set the locale used for network requests to locale,
given in standard UNIX
locale format. See #GDataOAuth2Authorizer:locale for more details.
Note that while it’s possible to change the locale after sending network requests (i.e. calling gdata_oauth2_authorizer_build_authentication_uri() for the first time), it is unsupported, as the server-side software may behave unexpectedly. The only supported use of this method is after creation of the authorizer, but before any network requests are made.
the new locale in UNIX locale format, or %NULL for the default locale
Sets a property on an object.
the name of the property to set
the value
Sets the #GProxyResolver on the #SoupSession used internally by the given #GDataOAuth2Authorizer.
a #GProxyResolver, or %NULL
Sets the authorizer's refresh token, #GDataOAuth2Authorizer:refresh-token. This is used to periodically refresh the access token. Set it to %NULL to clear the current authentication from the authorizer.
the new refresh token, or %NULL to clear authorization
Sets the #GDataOAuth2Authorizer:timeout property; the network timeout, in seconds.
If timeout
is 0
, network operations will never
time out.
the timeout, or 0
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data
from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().
A #GQuark, naming the user data pointer
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Decreases the reference count of object
. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.
This function essentially limits the life time of the closure
to
the life time of the object. That is, when the object is finalized,
the closure
is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure,
to ensure that an extra
reference count is held on object
during invocation of the
closure
. Usually, this function will be called on closures that
use this object
as closure data.
#GClosure to watch
Find the #GParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init
member of
#GTypeInfo.) It must not be called after after class_init
has
been called for any object types implementing this interface.
If pspec
is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface
will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Creates a new #GDataOAuth2Authorizer. The client_id
must be unique for your
application, and as registered with Google, and the client_secret
must be
paired with it.
your application’s client ID
your application’s client secret
authorisation redirect URI
the #GType of a #GDataService subclass which the #GDataOAuth2Authorizer will be used with
Creates a new #GDataOAuth2Authorizer. The client_id
must be unique for your
application, and as registered with Google, and the client_secret
must be
paired with it.
your application’s client ID
your application’s client secret
authorisation redirect URI
a non-empty list of #GDataAuthorizationDomains to be authorized against by the #GDataOAuth2Authorizer
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
All the fields in the #GDataOAuth2Authorizer structure are private and should never be accessed directly.