Callbacks

	FreeFormExpBuildSexpFunc (word, options, hint)
	GDataObjectCallback (gdata, object, *user_data)
	OAuth2ServiceRefSourceFunc (user_data, uid)
	SourceRefreshFunc (source, *user_data)
	TypeFunc (type, *user_data)
	WebDAVDiscoverRefSourceFunc (user_data, uid)
	WebDAVPropstatTraverseFunc (webdav, prop_node, request_uri, href, status_code, *user_data)
	XmlHashFunc (key, value, *user_data)
	XmlHashRemoveFunc (key, value, *user_data)

Details

EDataServer.FreeFormExpBuildSexpFunc(word, options, hint)

Parameters:

• word (str) –

• options (str) –

• hint (str) –

Return type:

str

EDataServer.GDataObjectCallback(gdata, object, *user_data)

Parameters:

• gdata (EDataServer.GDataSession) – an EDataServer.GDataSession

• object (Json.Object) – a #JSonObject with received content

• user_data (object or None) – user data passed to the call

Returns:

whether the traverse can continue

Return type:

bool

Callback used to traverse response from the server, which is an array.

New in version 3.46.

EDataServer.OAuth2ServiceRefSourceFunc(user_data, uid)

Parameters:

• user_data (object or None) – user data, as passed to EDataServer.OAuth2Service.get_access_token_sync() or EDataServer.OAuth2Service.receive_and_store_token_sync(), or EDataServer.OAuth2Service.refresh_and_store_token_sync()

• uid (str) – an EDataServer.Source UID to return

Returns:

an EDataServer.Source with UID uid, or None, if not found. Dereference the returned non-None EDataServer.Source with GObject.Object.unref(), when no longer needed.

Return type:

EDataServer.Source or None

New in version 3.28.

EDataServer.SourceRefreshFunc(source, *user_data)

Parameters:

• source (EDataServer.Source) – an EDataServer.Source

• user_data (object or None) – user data provided to the callback function

New in version 3.6.

EDataServer.TypeFunc(type, *user_data)

Parameters:

• type (GObject.GType) – a GObject.GType

• user_data (object or None) – user data passed to EDataServer.type_traverse()

Specifies the type of functions passed to EDataServer.type_traverse().

New in version 3.4.

EDataServer.WebDAVDiscoverRefSourceFunc(user_data, uid)

Parameters:

• user_data (object or None) – user data, as passed to EDataServer.webdav_discover_sources_full() or EDataServer.webdav_discover_sources_full_sync()

• uid (str) – an EDataServer.Source UID to return

Returns:

an EDataServer.Source with UID uid, or None, if not found. Dereference the returned non-None EDataServer.Source with GObject.Object.unref(), when no longer needed.

Return type:

EDataServer.Source or None

New in version 3.30.

EDataServer.WebDAVPropstatTraverseFunc(webdav, prop_node, request_uri, href, status_code, *user_data)

Parameters:

• webdav (EDataServer.WebDAVSession) – an EDataServer.WebDAVSession

• prop_node (libxml2.Node) – an libxml2.Node

• request_uri (GLib.Uri) – a GLib.Uri, containing the request URI, maybe redirected by the server

• href (str or None) – a full URI to which the property belongs, or None, when not found

• status_code (int) – an HTTP status code for this property

• user_data (object or None) – user data, as passed to EDataServer.WebDAVSession.propfind_sync()

Returns:

True to continue traversal of the returned response, False otherwise.

Return type:

bool

A callback function for EDataServer.WebDAVSession.propfind_sync(), EDataServer.WebDAVSession.report_sync() and other XML response with DAV:propstat elements traversal functions.

The prop_node points to the actual property (prop) node and it can be examined with e_xml_find_child(), e_xml_find_children_nodes() and other provided XML helper functions.

New in version 3.26.

EDataServer.XmlHashFunc(key, value, *user_data)

Parameters:

• key (str) –

• value (str) –

• user_data (object or None) –

EDataServer.XmlHashRemoveFunc(key, value, *user_data)

Parameters:

• key (str) –

• value (str) –

• user_data (object or None) –

Return type:

bool