SyncSourceConfig Class Reference
[Client]

This class groups all configuration properties for a SyncSource. More...

#include <SyncSourceConfig.h>

List of all members.

Public Member Functions

 SyncSourceConfig ()
 Constructs a new SyncSourceConfig object.
 ~SyncSourceConfig ()
 Destructor.
const char * getName () const
 Returns the SyncSource name.
void setName (const char *n)
 Sets the SyncSource name.
const char * getURI () const
 Returns the SyncSource URI (used in SyncML addressing).
void setURI (const char *u)
 Sets the SyncSource URI (used in SyncML addressing).
const char * getSyncModes () const
 Returns a comma separated list of the possible syncModes for the SyncSource.
void setSyncModes (const char *s)
 Sets the available syncModes for the SyncSource as comma separated values.
const char * getType () const
 Returns the mime type of the items handled by the sync source.
void setType (const char *t)
 Sets the mime type of the items handled by the sync source.
const char * getSync () const
 Gets the default syncMode as one of the strings listed in setSyncModes.
void setSync (const char *s)
 Returns the default syncMode as one of the strings above.
const char * getEncoding () const
 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.
void setEncoding (const char *s)
const char * getVersion () const
 Returns the version of the source type used by client.
void setVersion (const char *n)
 Sets the SyncSource version.
const char * getSupportedTypes () const
 A string representing the source types (with versions) supported by the SyncSource.
void setSupportedTypes (const char *s)
 Sets the supported source types for this source.
CTCap getCtCap () const
void setCtCap (CTCap v)
void setLast (unsigned long timestamp)
 Sets the last sync timestamp.
unsigned long getLast () const
 Returns the last sync timestamp.
const char * getEncryption () const
 Specifies if the content of an outgoing item should be encrypted.
void setEncryption (const char *n)
 Sets the encryption type.
void assign (const SyncSourceConfig &sc)
 Initialize this object with the given SyncSourceConfig.
SyncSourceConfigoperator= (const SyncSourceConfig &sc)
 Assign operator.

Protected Attributes

char * name
char * uri
char * syncModes
char * type
char * sync
char * encodings
char * version
char * supportedTypes
CTCap ctCap
char * encryption
unsigned long last


Detailed Description

This class groups all configuration properties for a SyncSource.

SyncSourceConfig is a part of SyncManagerConfig (along with AccessConfig and an array of DeviceConfig).


Member Function Documentation

void SyncSourceConfig::setName ( const char *  n  ) 

Sets the SyncSource name.

Parameters:
n the new name

void SyncSourceConfig::setURI ( const char *  u  ) 

Sets the SyncSource URI (used in SyncML addressing).

Parameters:
u the new uri

const char* SyncSourceConfig::getSyncModes (  )  const

Returns a comma separated list of the possible syncModes for the SyncSource.

Sync modes can be one of

void SyncSourceConfig::setSyncModes ( const char *  s  ) 

Sets the available syncModes for the SyncSource as comma separated values.

Parameters:
s the new list

void SyncSourceConfig::setType ( const char *  t  ) 

Sets the mime type of the items handled by the sync source.

Parameters:
t the mime type

const char* SyncSourceConfig::getEncoding (  )  const

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.

void SyncSourceConfig::setVersion ( const char *  n  ) 

Sets the SyncSource version.

Parameters:
n the new version

const char* SyncSourceConfig::getSupportedTypes (  )  const

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.

void SyncSourceConfig::setSupportedTypes ( const char *  s  ) 

Sets the supported source types for this source.

Parameters:
s the supported types string

void SyncSourceConfig::setLast ( unsigned long  timestamp  ) 

Sets the last sync timestamp.

Parameters:
timestamp the last sync timestamp

const char* SyncSourceConfig::getEncryption (  )  const

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".

void SyncSourceConfig::setEncryption ( const char *  n  ) 

Sets the encryption type.

Parameters:
n the encryption type

void SyncSourceConfig::assign ( const SyncSourceConfig sc  ) 

Initialize this object with the given SyncSourceConfig.

Parameters:
sc the source config object


The documentation for this class was generated from the following file:
Generated on Fri Nov 9 12:21:35 2007 for Funambol Outlook Plug-in Library by  doxygen 1.5.2