AbstractSyncSourceConfig Class Reference
[Client]
#include <AbstractSyncSourceConfig.h>
Public Member Functions | |
| virtual | ~AbstractSyncSourceConfig () |
| virtual const char * | getName () const =0 |
| virtual const char * | getURI () const =0 |
| virtual const char * | getSyncModes () const =0 |
| virtual const char * | getType () const =0 |
| virtual const char * | getSync () const =0 |
| virtual const char * | getEncoding () const =0 |
| virtual const char * | getVersion () const =0 |
| virtual const char * | getSupportedTypes () const =0 |
| virtual void | setLast (unsigned long timestamp)=0 |
| virtual unsigned long | getLast () const =0 |
| virtual const char * | getEncryption () const =0 |
| virtual const ArrayList & | getCtCaps () const =0 |
| virtual bool | getFieldLevel () const |
Static Public Attributes | |
| static const int | FLEVEL_UNDEFINED = -1 |
| static const int | FLEVEL_ENABLED = 1 |
| static const int | FLEVEL_DISABLED = 0 |
Detailed Description
This class is the API expected by SyncClient/SyncManager for each sync source. AbstractSyncSourceConfig is a part of SyncManagerConfig (along with AccessConfig and an array of DeviceConfig).Definition at line 56 of file AbstractSyncSourceConfig.h.
Constructor & Destructor Documentation
| virtual AbstractSyncSourceConfig::~AbstractSyncSourceConfig | ( | ) | [inline, virtual] |
Destructor
Definition at line 65 of file AbstractSyncSourceConfig.h.
Member Function Documentation
| virtual const ArrayList& AbstractSyncSourceConfig::getCtCaps | ( | ) | const [pure virtual] |
Returns an array of CtCap with all the capabilities for this Source
- Returns:
- an ArrayList of CTCap
Implemented in EvolutionSyncSourceConfig, and SyncSourceConfig.
| virtual const char* AbstractSyncSourceConfig::getEncoding | ( | ) | const [pure virtual] |
Specifies how the content of an outgoing item should be encoded by the client library if the sync source does not set an encoding on the item that it created. Valid values are listed in SyncItem::encodings.
Implemented in EvolutionSyncSourceConfig, and SyncSourceConfig.
| virtual const char* AbstractSyncSourceConfig::getEncryption | ( | ) | const [pure virtual] |
Specifies if the content of an outgoing item should be encrypted. If this property is not empty and valid, the 'encodings' value is ignored for outgoing items. The only valid value is "des".
Implemented in EvolutionSyncSourceConfig, and SyncSourceConfig.
| virtual bool AbstractSyncSourceConfig::getFieldLevel | ( | ) | const [inline, virtual] |
Return fieldLevel param. Not implemented yet. Now just returns false
Note: explaining the method "getFieldLevel()" as "return fieldLevel param" does not add any information and might as well be left out.
- Returns:
- fieldLevel ... which is what?
Definition at line 166 of file AbstractSyncSourceConfig.h.
| virtual unsigned long AbstractSyncSourceConfig::getLast | ( | ) | const [pure virtual] |
Returns the last sync timestamp
Implemented in EvolutionSyncSourceConfig, and SyncSourceConfig.
| virtual const char* AbstractSyncSourceConfig::getName | ( | ) | const [pure virtual] |
Returns the SyncSource name.
Implemented in EvolutionSyncSourceConfig, and SyncSourceConfig.
| virtual const char* AbstractSyncSourceConfig::getSupportedTypes | ( | ) | const [pure virtual] |
A string representing the source types (with versions) supported by the SyncSource. The string must be formatted as a sequence of "type:version" separated by commas ','. For example: "text/x-vcard:2.1,text/vcard:3.0". The version can be left empty, for example: "text/x-s4j-sifc:". Supported types will be sent as part of the DevInf.
Implemented in AddressBookSource, EvolutionCalendarSource, EvolutionContactSource, EvolutionMemoSource, FileSyncSource, SQLiteContactSource, TestEvolutionSyncSource, EvolutionSyncSource, EvolutionSyncSourceConfig, PersistentEvolutionSyncSourceConfig, TrackingSyncSource, and SyncSourceConfig.
| virtual const char* AbstractSyncSourceConfig::getSync | ( | ) | const [pure virtual] |
Gets the default syncMode as one of the strings listed in setSyncModes.
Implemented in EvolutionSyncSourceConfig, and SyncSourceConfig.
| virtual const char* AbstractSyncSourceConfig::getSyncModes | ( | ) | const [pure virtual] |
Returns a comma separated list of the possible syncModes for the SyncSource. Sync modes can be one of
- slow
- two-way
- one-way-from-server
- one-way-from-client
- refresh-from-server
- refresh-from-client
- one-way-from-server
- one-way-from-client
- addrchange
Implemented in EvolutionSyncSourceConfig, and SyncSourceConfig.
| virtual const char* AbstractSyncSourceConfig::getType | ( | ) | const [pure virtual] |
Returns the mime type of the items handled by the sync source.
Implemented in EvolutionSyncSourceConfig, and SyncSourceConfig.
| virtual const char* AbstractSyncSourceConfig::getURI | ( | ) | const [pure virtual] |
Returns the SyncSource URI (used in SyncML addressing).
Implemented in EvolutionSyncSourceConfig, and SyncSourceConfig.
| virtual const char* AbstractSyncSourceConfig::getVersion | ( | ) | const [pure virtual] |
Returns the version of the source type used by client.
Implemented in EvolutionSyncSourceConfig, and SyncSourceConfig.
| virtual void AbstractSyncSourceConfig::setLast | ( | unsigned long | timestamp | ) | [pure virtual] |
Sets the last sync timestamp. Called by the sync engine at the end of a sync. The client must save that modified value; it is needed to decide during the next sync whether an incremental sync is possible.
A client which wants to force a slow sync after a failed sync can reset the time stamp. The sync engine itself won't do that.
- Parameters:
-
timestamp the last sync timestamp
Implemented in EvolutionSyncSourceConfig, and SyncSourceConfig.
Referenced by EvolutionSyncSource::beginSync().
Member Data Documentation
const int AbstractSyncSourceConfig::FLEVEL_DISABLED = 0 [static] |
Definition at line 60 of file AbstractSyncSourceConfig.h.
const int AbstractSyncSourceConfig::FLEVEL_ENABLED = 1 [static] |
Definition at line 59 of file AbstractSyncSourceConfig.h.
const int AbstractSyncSourceConfig::FLEVEL_UNDEFINED = -1 [static] |
Definition at line 58 of file AbstractSyncSourceConfig.h.
The documentation for this class was generated from the following file:
- build-client-api/include/common/spds/AbstractSyncSourceConfig.h
