OfflineStore

OfflineStore

Object Hierarchy:

Description:

[ CCode ( type_id = "camel_offline_store_get_type ()" ) ]
public class OfflineStore : Store, Initable

Base class for offline-capable mail stores.

OfflineStore is a Store subclass that any remote backend supporting offline operation should extend instead of Store directly.

It adds a network availability state (online / offline) that client code can query and change via get_online and set_online. When going offline, the base class implementation synchronises all OfflineFolder instances that are currently active.

Backends using OfflineStore should also provide OfflineFolder -based folders for any folders representing remote data, so that the per-folder offline sync behaviour can be controlled.

Namespace: Camel

Package: camel-1.2

Content:

Properties:

public bool online { get; }
Whether the store is online

Creation methods:

protected OfflineStore ()

Methods:

public virtual GenericArray<Folder> dup_downsync_folders ()
Returns a GenericArray of Folder objects which should be checked for offline synchronization.
public bool get_online ()
Returns true if this is online.
public bool prepare_for_offline_sync (Cancellable? cancellable = null) throws Error
Downloads messages for offline, when setup to do so and when the host is reachable.
public bool requires_downsync ()
Check whether the this requires synchronization for offline usage.
public async bool set_online (bool online, int io_priority, Cancellable? cancellable = null) throws Error
An asynchronous variant of set_online_sync.
public bool set_online_sync (bool online, Cancellable? cancellable = null) throws Error
Sets the online/offline state of this according to online.

Inherited Members:

All known members inherited from class Camel.Store

All known members inherited from class Camel.Service

All known members inherited from class GLib.Object

All known members inherited from interface GLib.Initable

@new
init

new_valist

newv