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
Checks whether the service can be used with the given source.
The default implementation checks whether the source has an #ESourceAuthentication
extension and when its method matches e_oauth2_service_get_name(), then it automatically
returns %TRUE. Contrary, when the source contains GNOME Online Accounts or Ubuntu
Online Accounts extension, then it returns %FALSE.
The default implementation is tried always as the first and when it fails, then the descendant's implementation is called.
an #ESource
Deletes token information for the service and source from the secret store.
an #ESource
optional #GCancellable object, or %NULL
Tries to extract an authorization code from a web page provided by the server. The function can be called multiple times, whenever the page load is finished.
There can happen three states: 1) either the service cannot determine
the authentication code from the page information, then the %FALSE is
returned and the out_authorization_code is left untouched; or 2) the server
reported a failure, in which case the function returns %TRUE and lefts
the out_authorization_code untouched; or 3) the service could extract
the authentication code from the given arguments, then the function
returns %TRUE and sets the received authorization code to out_authorization_code.
The page_content is %NULL, unless flags returned by e_oauth2_service_get_flags()
contain also %E_OAUTH2_SERVICE_FLAG_EXTRACT_REQUIRES_PAGE_CONTENT.
This method is always called after e_oauth2_service_get_authentication_policy().
an associated #ESource
a web page title
a web page URI
a web page content
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.
Reads access token information from the secret store for the source and
in case it's expired it refreshes the token, if possible.
Free the returned out_access_token with g_free(), when no longer needed.
an #ESource
an #EOAuth2ServiceRefSourceFunc function to obtain an #ESource
optional #GCancellable object, or %NULL
Used to decide what to do when the server redirects to the next page. The default implementation always returns %E_OAUTH2_SERVICE_NAVIGATION_POLICY_ALLOW.
This method is called before e_oauth2_service_extract_authorization_code() and can be used to block certain resources or to abort the authentication when the server redirects to an unexpected page (like when user denies authorization in the page).
an associated #ESource
a URI of the navigation resource
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Returns a human readable name of the service. This is similar to e_oauth2_service_get_name(), except this string should be localized, because it will be used in user-visible strings.
Returns the object that extension extends.
Returns a unique name of the service. It can be named for example by the server or the company from which it receives the OAuth2 token and where it refreshes it, like "Company" for login.company.com.
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
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Returns a value for the "redirect_uri" keys in the authenticate and get_token operations. The default implementation returns "urn:ietf:wg:oauth:2.0:oob".
an associated #ESource
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
Checks whether the service can be used with the given protocol and/or hostname.
Any of protocol and hostname can be %NULL, but not both. It's up to each implementer
to decide, which of the arguments are important and whether all or only any of them
can be required.
The function is meant to check whether the service can be offered
for example when configuring a new account. The real usage is
determined by e_oauth2_service_can_process().
The default implementation consults org.gnome.evolution-data-server.oauth2-services-hint GSettings key against given hostname. See its description for more information.
The default implementation is tried always as the first and when it fails, then the descendant's implementation is called.
a protocol to search the service for, like "imap", or %NULL
a host name to search the service for, like "server.example.com", or %NULL
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.
The service can change what arguments are passed in the authentication URI
in this method. The default implementation sets some values too, namely
"response_type", "client_id", "redirect_uri" and "login_hint", if available
in the source. These parameters are always provided, even when the interface
implementer overrides this method.
The uri_query hash table expects both key and value to be newly allocated
strings, which will be freed together with the hash table or when the key
is replaced.
an associated #ESource
query for the URI to use
Sets additional form parameters to be used in the POST request when requesting access token after successfully obtained authorization code. The default implementation sets some values too, namely "code", "client_id", "client_secret", "redirect_uri" and "grant_type". These parameters are always provided, even when the interface implementer overrides this method.
The form hash table expects both key and value to be newly allocated
strings, which will be freed together with the hash table or when the key
is replaced.
an associated #ESource
authorization code, as returned from e_oauth2_service_extract_authorization_code()
form parameters to be used in the POST request
The service can change the message before it's sent to
the e_oauth2_service_get_authentication_uri(), with POST data
being provided by e_oauth2_service_prepare_get_token_form().
The default implementation does nothing with the message.
an associated #ESource
a #SoupMessage
Sets additional form parameters to be used in the POST request when requesting to refresh an access token. The default implementation sets some values too, namely "refresh_token", "client_id", "client_secret" and "grant_type". These parameters are always provided, even when the interface implementer overrides this method.
The form hash table expects both key and value to be newly allocated
strings, which will be freed together with the hash table or when the key
is replaced.
an associated #ESource
a refresh token to be used
form parameters to be used in the POST request
The service can change the message before it's sent to
the e_oauth2_service_get_refresh_uri(), with POST data
being provided by e_oauth2_service_prepare_refresh_token_form().
The default implementation does nothing with the message.
an associated #ESource
a #SoupMessage
Queries service at e_oauth2_service_get_refresh_uri() with a request to obtain
a new access token, associated with the given authorization_code and stores
it into the secret store on success.
an #ESource
authorization code provided by the server
an #EOAuth2ServiceRefSourceFunc function to obtain an #ESource
optional #GCancellable object, or %NULL
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().
Queries service at e_oauth2_service_get_refresh_uri() with a request to refresh
existing access token with provided refresh_token and stores it into the secret
store on success.
an #ESource
refresh token as provided by the server
an #EOAuth2ServiceRefSourceFunc function to obtain an #ESource
optional #GCancellable object, or %NULL
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
Sets a property on an object.
the name of the property to set
the value
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.
Checks whether the service can be used with the given source.
The default implementation checks whether the source has an #ESourceAuthentication
extension and when its method matches e_oauth2_service_get_name(), then it automatically
returns %TRUE. Contrary, when the source contains GNOME Online Accounts or Ubuntu
Online Accounts extension, then it returns %FALSE.
The default implementation is tried always as the first and when it fails, then the descendant's implementation is called.
an #ESource
Tries to extract an authorization code from a web page provided by the server. The function can be called multiple times, whenever the page load is finished.
There can happen three states: 1) either the service cannot determine
the authentication code from the page information, then the %FALSE is
returned and the out_authorization_code is left untouched; or 2) the server
reported a failure, in which case the function returns %TRUE and lefts
the out_authorization_code untouched; or 3) the service could extract
the authentication code from the given arguments, then the function
returns %TRUE and sets the received authorization code to out_authorization_code.
The page_content is %NULL, unless flags returned by e_oauth2_service_get_flags()
contain also %E_OAUTH2_SERVICE_FLAG_EXTRACT_REQUIRES_PAGE_CONTENT.
This method is always called after e_oauth2_service_get_authentication_policy().
an associated #ESource
a web page title
a web page URI
a web page content
Used to decide what to do when the server redirects to the next page. The default implementation always returns %E_OAUTH2_SERVICE_NAVIGATION_POLICY_ALLOW.
This method is called before e_oauth2_service_extract_authorization_code() and can be used to block certain resources or to abort the authentication when the server redirects to an unexpected page (like when user denies authorization in the page).
an associated #ESource
a URI of the navigation resource
Returns a human readable name of the service. This is similar to e_oauth2_service_get_name(), except this string should be localized, because it will be used in user-visible strings.
Returns a unique name of the service. It can be named for example by the server or the company from which it receives the OAuth2 token and where it refreshes it, like "Company" for login.company.com.
Returns a value for the "redirect_uri" keys in the authenticate and get_token operations. The default implementation returns "urn:ietf:wg:oauth:2.0:oob".
an associated #ESource
Checks whether the service can be used with the given protocol and/or hostname.
Any of protocol and hostname can be %NULL, but not both. It's up to each implementer
to decide, which of the arguments are important and whether all or only any of them
can be required.
The function is meant to check whether the service can be offered
for example when configuring a new account. The real usage is
determined by e_oauth2_service_can_process().
The default implementation consults org.gnome.evolution-data-server.oauth2-services-hint GSettings key against given hostname. See its description for more information.
The default implementation is tried always as the first and when it fails, then the descendant's implementation is called.
a protocol to search the service for, like "imap", or %NULL
a host name to search the service for, like "server.example.com", or %NULL
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 service can change what arguments are passed in the authentication URI
in this method. The default implementation sets some values too, namely
"response_type", "client_id", "redirect_uri" and "login_hint", if available
in the source. These parameters are always provided, even when the interface
implementer overrides this method.
The uri_query hash table expects both key and value to be newly allocated
strings, which will be freed together with the hash table or when the key
is replaced.
an associated #ESource
query for the URI to use
Sets additional form parameters to be used in the POST request when requesting access token after successfully obtained authorization code. The default implementation sets some values too, namely "code", "client_id", "client_secret", "redirect_uri" and "grant_type". These parameters are always provided, even when the interface implementer overrides this method.
The form hash table expects both key and value to be newly allocated
strings, which will be freed together with the hash table or when the key
is replaced.
an associated #ESource
authorization code, as returned from e_oauth2_service_extract_authorization_code()
form parameters to be used in the POST request
The service can change the message before it's sent to
the e_oauth2_service_get_authentication_uri(), with POST data
being provided by e_oauth2_service_prepare_get_token_form().
The default implementation does nothing with the message.
an associated #ESource
a #SoupMessage
Sets additional form parameters to be used in the POST request when requesting to refresh an access token. The default implementation sets some values too, namely "refresh_token", "client_id", "client_secret" and "grant_type". These parameters are always provided, even when the interface implementer overrides this method.
The form hash table expects both key and value to be newly allocated
strings, which will be freed together with the hash table or when the key
is replaced.
an associated #ESource
a refresh token to be used
form parameters to be used in the POST request
The service can change the message before it's sent to
the e_oauth2_service_get_refresh_uri(), with POST data
being provided by e_oauth2_service_prepare_refresh_token_form().
The default implementation does nothing with the message.
an associated #ESource
a #SoupMessage
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 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
Creates a binding between
source_propertyonsourceandtarget_propertyontarget.Whenever the
source_propertyis changed thetarget_propertyis updated using the same value. For instance: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
flagscontains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: iftarget_propertyontargetchanges then thesource_propertyonsourcewill be updated as well.The binding will automatically be removed when either the
sourceor thetargetinstances are finalized. To remove the binding without affecting thesourceand thetargetyou 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,
sourceandtargetare only used from a single thread and it is clear that bothsourceandtargetoutlive the binding. Especially it is not safe to rely on this if the binding,sourceortargetcan 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.