Camel.OfflineFolder¶

Subclasses:: None

Methods¶

Inherited:: Camel.Folder (85), Camel.Object (4), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`can_downsync` ()
	`downsync` (expression, io_priority, cancellable, callback, *user_data)
	`downsync_finish` (result)
	`downsync_sync` (expression, cancellable)
	`get_offline_sync` ()
	`set_offline_sync` (offline_sync)

Virtual Methods¶

Inherited:: Camel.Folder (42), Camel.Object (2), GObject.Object (7)

do_downsync_sync (expression, cancellable)

Properties¶

Inherited:: Camel.Folder (6), Camel.Object (1)

Name	Type	Flags	Short Description
`offline-sync`	`Camel.ThreeState`	r/w/en	Copy folder content locally for _offline operation

Signals¶

Inherited:: Camel.Folder (3), GObject.Object (1)

Fields¶

Inherited:: Camel.Folder (3), GObject.Object (1)

Name	Type	Access	Description
parent	`Camel.Folder`	r

Class Details¶

class Camel.OfflineFolder(**kwargs)¶

Bases:: Camel.Folder
Abstract:: No
Structure:: Camel.OfflineFolderClass

can_downsync()¶

Returns:: True, when the self can be synchronized for offline; False otherwise.
Return type:: bool

Checks whether the self can run downsync according to its settings (Camel.OfflineFolder.get_offline_sync()) and to the parent’s Camel.OfflineStore settings (Camel.OfflineSettings.get_stay_synchronized()).

New in version 3.22.

downsync(expression, io_priority, cancellable, callback, *user_data)¶

Parameters:

expression (str or None) – search expression describing which set of messages to downsync (None for all)
io_priority (int) – the I/O priority of the request
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when the request is satisfied
user_data (object or None) – data to pass to the callback function

Synchronizes messages in self described by the search expression to the local machine asynchronously for offline availability.

When the operation is finished, callback will be called. You can then call Camel.OfflineFolder.downsync_finish() to get the result of the operation.

New in version 3.0.

downsync_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: True on success, False on error
Return type:: bool

Finishes the operation started with Camel.OfflineFolder.downsync().

New in version 3.0.

downsync_sync(expression, cancellable)¶

Parameters:

expression (str or None) – search expression describing which set of messages to downsync (None for all)
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

True on success, False on error

Return type:

bool

Synchronizes messages in self described by the search expression to the local machine for offline availability.

New in version 3.0.

get_offline_sync()¶

Return type:: Camel.ThreeState

New in version 2.32.

set_offline_sync(offline_sync)¶

Parameters:: offline_sync (Camel.ThreeState) – whether to synchronize for offline use, as a Camel.ThreeState enum

The Camel.ThreeState.INCONSISTENT means what the parent store has set.

New in version 2.32.

do_downsync_sync(expression, cancellable) virtual¶

Parameters:

expression (str or None) – search expression describing which set of messages to downsync (None for all)
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Returns:

True on success, False on error

Return type:

bool

Synchronizes messages in folder described by the search expression to the local machine for offline availability.

New in version 3.0.

Property Details¶

Camel.OfflineFolder.props.offline_sync¶

Name:: offline-sync
Type:: Camel.ThreeState
Default Value:: Camel.ThreeState.INCONSISTENT
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Copy folder content locally for _offline operation