EDataServer.SourceWebdav

EDataServer.SourceWebdav

EDataServer.SourceWebdav¶

Subclasses:: None

Methods¶

Inherited:: EDataServer.SourceExtension (4), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`dup_color` ()
	`dup_display_name` ()
	`dup_email_address` ()
	`dup_resource_path` ()
	`dup_resource_query` ()
	`dup_ssl_trust` ()
	`dup_uri` ()
	`get_avoid_ifmatch` ()
	`get_calendar_auto_schedule` ()
	`get_color` ()
	`get_display_name` ()
	`get_email_address` ()
	`get_order` ()
	`get_resource_path` ()
	`get_resource_query` ()
	`get_ssl_trust` ()
	`get_ssl_trust_response` ()
	`set_avoid_ifmatch` (avoid_ifmatch)
	`set_calendar_auto_schedule` (calendar_auto_schedule)
	`set_color` (color)
	`set_display_name` (display_name)
	`set_email_address` (email_address)
	`set_order` (order)
	`set_resource_path` (resource_path)
	`set_resource_query` (resource_query)
	`set_ssl_trust` (ssl_trust)
	`set_ssl_trust_response` (response)
	`set_uri` (uri)
	`unset_temporary_ssl_trust` ()
	`update_ssl_trust` (host, cert, response)
	`verify_ssl_trust` (host, cert, cert_errors)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: EDataServer.SourceExtension (1)

Name	Type	Flags	Short Description
`avoid-ifmatch`	`bool`	r/w/c/en	Work around a bug in old Apache servers
`calendar-auto-schedule`	`bool`	r/w/c/en	Whether the server handles meeting invitations (CalDAV-only)
`color`	`str`	r/w/c/en	Color of the WebDAV resource
`display-name`	`str`	r/w/c/en	Display name of the WebDAV resource
`email-address`	`str`	r/w/c/en	The user’s email address
`order`	`int`	r/w/c/en	A sorting order of the resource
`resource-path`	`str`	r/w/c/en	Absolute path to a WebDAV resource
`resource-query`	`str`	r/w/c/en	Query to access a WebDAV resource
`ssl-trust`	`str`	r/w/c/en	SSL/TLS certificate trust setting, for invalid server certificates
`uri`	`GLib.Uri`	r/w/en	WebDAV service as a `GLib.Uri`

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`EDataServer.SourceExtension`	r

Class Details¶

class EDataServer.SourceWebdav(**kwargs)¶

Bases:: EDataServer.SourceExtension
Abstract:: No
Structure:: EDataServer.SourceWebdavClass

Contains only private data that should be read and manipulated using the functions below.

New in version 3.6.

dup_color()¶

Returns:: a newly-allocated copy of EDataServer.SourceWebdav :color
Return type:: str or None

Thread-safe variation of EDataServer.SourceWebdav.get_color(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.30.

dup_display_name()¶

Returns:: a newly-allocated copy of EDataServer.SourceWebdav :display-name
Return type:: str or None

Thread-safe variation of EDataServer.SourceWebdav.get_display_name(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.6.

dup_email_address()¶

Returns:: the newly-allocated copy of EDataServer.SourceWebdav :email-address
Return type:: str or None

Thread-safe variation of EDataServer.SourceWebdav.get_email_address(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.6.

dup_resource_path()¶

Returns:: the newly-allocated copy of EDataServer.SourceWebdav :resource-path
Return type:: str or None

Thread-safe variation of EDataServer.SourceWebdav.get_resource_path(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.6.

dup_resource_query()¶

Returns:: the newly-allocated copy of EDataServer.SourceWebdav :resource-query
Return type:: str or None

Thread-safe variation of EDataServer.SourceWebdav.get_resource_query(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.6.

dup_ssl_trust()¶

Returns:: the newly-allocated copy of EDataServer.SourceWebdav :ssl-trust
Return type:: str or None

Thread-safe variation of EDataServer.SourceWebdav.get_ssl_trust(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.8.

dup_uri()¶

Returns:: a newly-allocated GLib.Uri
Return type:: GLib.Uri

This is a convenience function which returns a newly-allocated GLib.Uri, its contents assembled from the EDataServer.SourceAuthentication extension, the EDataServer.SourceSecurity extension, and self itself. Free the returned GLib.Uri with g_uri_unref().

New in version 3.46.

get_avoid_ifmatch()¶

Returns:: whether the WebDAV server is known to exhibit the bug
Return type:: bool

This setting works around a

bug in older Apache mod_dav versions.

We may deprecate this once Apache 2.2.8 or newer becomes sufficiently ubiquitous, or we figure out a way to detect and work around the bug automatically.

New in version 3.6.

get_calendar_auto_schedule()¶

Return type:: bool

FIXME Document me!

New in version 3.6.

get_color()¶

Returns:: the color of the WebDAV resource, if any set on the server
Return type:: str or None

Returns the last known color of a WebDAV resource as provided by the server.

New in version 3.30.

get_display_name()¶

Returns:: the display name of the WebDAV resource
Return type:: str or None

Returns the last known display name of a WebDAV resource, which may differ from the EDataServer.Source :display-name property of the EDataServer.Source to which self belongs.

New in version 3.6.

get_email_address()¶

Returns:: the user’s email address
Return type:: str or None

Returns the user’s email address which can be passed to a CalDAV server if the user wishes to receive scheduling messages.

New in version 3.6.

get_order()¶

Returns:: the sorting order of the resource, if known. The default is (int) -1, which means unknown/unset.
Return type:: int

New in version 3.40.

get_resource_path()¶

Returns:: the absolute path to a WebDAV resource
Return type:: str or None

Returns the absolute path to a resource on a WebDAV server.

New in version 3.6.

get_resource_query()¶

Returns:: the query to access a WebDAV resource
Return type:: str or None

Returns the URI query required to access a resource on a WebDAV server.

This is typically used when the EDataServer.SourceWebdav :resource-path points not to the resource itself but to a web program that generates the resource content on-the-fly. The EDataServer.SourceWebdav :resource-query holds the input values for the program.

New in version 3.6.

get_ssl_trust()¶

Returns:: an SSL/TLS certificate trust for the self
Return type:: str or None

Returns an SSL/TLS certificate trust for the self. The value encodes three parameters, divided by a pipe ‘|’, the first is users preference, can be one of “reject”, “accept”, “temporary-reject” and “temporary-accept”. The second is a host name for which the trust was set. Finally the last is a SHA256 hash of the certificate. This is not meant to be changed by a caller, it is supposed to be manipulated with EDataServer.SourceWebdav.update_ssl_trust() and EDataServer.SourceWebdav.verify_ssl_trust().

New in version 3.8.

get_ssl_trust_response()¶

Returns:: the last SSL trust response, as EDataServer.TrustPromptResponse, if none is set, then returns EDataServer.TrustPromptResponse.UNKNOWN
Return type:: EDataServer.TrustPromptResponse

New in version 3.32.

set_avoid_ifmatch(avoid_ifmatch)¶

Parameters:: avoid_ifmatch (bool) – whether the WebDAV server is known to exhibit the bug

This setting works around a

bug in older Apache mod_dav versions.

We may deprecate this once Apache 2.2.8 or newer becomes sufficiently ubiquitous, or we figure out a way to detect and work around the bug automatically.

New in version 3.6.

set_calendar_auto_schedule(calendar_auto_schedule)¶

Parameters:: calendar_auto_schedule (bool) – whether the server supports the “calendar-auto-schedule” feature of CalDAV

FIXME Document me!

New in version 3.6.

set_color(color)¶

Parameters:: color (str or None) – the color of the WebDAV resource, or None

Updates the last known color of a WebDAV resource, as provided by the server.

The internal copy of color is automatically stripped of leading and trailing whitespace. If the resulting string is empty, None is set instead.

New in version 3.30.

set_display_name(display_name)¶

Parameters:: display_name (str or None) – the display name of the WebDAV resource, or None

Updates the last known display name of a WebDAV resource, which may differ from the EDataServer.Source :display-name property of the EDataServer.Source to which self belongs.

The internal copy of display_name is automatically stripped of leading and trailing whitespace. If the resulting string is empty, None is set instead.

New in version 3.6.

set_email_address(email_address)¶

Parameters:: email_address (str or None) – the user’s email address, or None

Sets the user’s email address which can be passed to a CalDAV server if the user wishes to receive scheduling messages.

The internal copy of email_address is automatically stripped of leading and trailing whitespace. If the resulting string is empty, None is set instead.

New in version 3.6.

set_order(order)¶

Parameters:: order (int) – a sorting order

Set the sorting order of the resource.

New in version 3.40.

set_resource_path(resource_path)¶

Parameters:: resource_path (str or None) – the absolute path to a WebDAV resource, or None

Sets the absolute path to a resource on a WebDAV server.

The internal copy of resource_path is automatically stripped of leading and trailing whitespace. If the resulting string is empty, None is set instead.

New in version 3.6.

set_resource_query(resource_query)¶

Parameters:: resource_query (str or None) – the query to access a WebDAV resource, or None

Sets the URI query required to access a resource on a WebDAV server.

This is typically used when the EDataServer.SourceWebdav :resource-path points not to the resource itself but to a web program that generates the resource content on-the-fly. The EDataServer.SourceWebdav :resource-query holds the input values for the program.

The internal copy of resource_query is automatically stripped of leading and trailing whitespace. If the resulting string is empty, None is set instead.

New in version 3.6.

set_ssl_trust(ssl_trust)¶

Parameters:: ssl_trust (str or None) – the ssl_trust to store, or None to unset

Sets the SSL/TLS certificate trust. See EDataServer.SourceWebdav.get_ssl_trust() for more infomation about its content and how to use it.

New in version 3.8.

set_ssl_trust_response(response)¶

Parameters:: response (EDataServer.TrustPromptResponse) – an EDataServer.TrustPromptResponse to set

Set the SSL trust response, as EDataServer.TrustPromptResponse, while keeping the certificate and host information as before. The function does nothing, when none SSL trust is set or when EDataServer.TrustPromptResponse.UNKNOWN is used as the response.

New in version 3.32.

set_uri(uri)¶

Parameters:: uri (GLib.Uri) – a GLib.Uri

This is a convenience function which propagates the components of uri to the EDataServer.SourceAuthentication extension, the EDataServer.SourceSecurity extension, and self itself. (The “fragment” component of uri is ignored.)

New in version 3.46.

unset_temporary_ssl_trust()¶: Unsets temporary trust set on this self, but keeps it as is for other values.

New in version 3.8.

update_ssl_trust(host, cert, response)¶

Parameters:

host (str) – a host name to store the certificate for
cert (Gio.TlsCertificate) – the invalid certificate of the connection over which host is about to be sent
response (EDataServer.TrustPromptResponse) – user’s response from a trust prompt for cert

Updates user’s response from a trust prompt, thus it is re-used the next time it’ll be needed. An EDataServer.TrustPromptResponse.UNKNOWN is treated as a temporary reject, which means the user will be asked again.

New in version 3.16.

verify_ssl_trust(host, cert, cert_errors)¶

Parameters:

host (str) – a host name to store the certificate for
cert (Gio.TlsCertificate) – the invalid certificate of the connection over which host is about to be sent
cert_errors (Gio.TlsCertificateFlags) – a bit-or of Gio.TlsCertificateFlags describing the reason for the cert to be considered invalid

Return type:

EDataServer.TrustPromptResponse

Verifies SSL/TLS trust for the given host and cert, as previously stored in the self with EDataServer.SourceWebdav.update_ssl_trust().

Property Details¶

EDataServer.SourceWebdav.props.avoid_ifmatch¶

Name:: avoid-ifmatch
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Work around a bug in old Apache servers

EDataServer.SourceWebdav.props.calendar_auto_schedule¶

Name:: calendar-auto-schedule
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Whether the server handles meeting invitations (CalDAV-only)

EDataServer.SourceWebdav.props.color¶

Name:: color
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Color of the WebDAV resource

EDataServer.SourceWebdav.props.display_name¶

Name:: display-name
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Display name of the WebDAV resource

EDataServer.SourceWebdav.props.email_address¶

Name:: email-address
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

The user’s email address

EDataServer.SourceWebdav.props.order¶

Name:: order
Type:: int
Default Value:: 4294967295
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

A sorting order of the resource

EDataServer.SourceWebdav.props.resource_path¶

Name:: resource-path
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Absolute path to a WebDAV resource

EDataServer.SourceWebdav.props.resource_query¶

Name:: resource-query
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

Query to access a WebDAV resource

EDataServer.SourceWebdav.props.ssl_trust¶

Name:: ssl-trust
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

SSL/TLS certificate trust setting, for invalid server certificates

EDataServer.SourceWebdav.props.uri¶

Name:: uri
Type:: GLib.Uri
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

WebDAV service as a GLib.Uri