Versit Plugins

Example Plugin: Backup and Restore

A plugin is provided with the Qt Versit module that provides backup and restore functionality to the exporter and importer.

These can be used by creating the exporter and importer under the "backup" profile:

 QVersitContactExporter exporter(QVersitContactHandlerFactory::ProfileBackup);

 QVersitContactImporter importer(QVersitContactHandlerFactory::ProfileBackup);

When applied to the exporter, this handler encodes all writable details that the exporter doesn't recognise. The format it uses to encode the detail is as follows:

• All generated properties will have the name X-NOKIA-QCONTACTFIELD
• All generated properties will have a single Versit group, and all properties generated from a single detail will have the same group.
• All generated properties will have at least the parameters DETAIL, which holds the definition name of the QContactDetail from which it was generated, and FIELD, which holds the name of the field within the detail from which it was generated.
• If the field is of type QString or QByteArray, the property's value is set directly to the value of the field. (For a QByteArray value, the QVersitWriter will base-64 encode it.)
• If the field is of type bool, int, uint, QDate, QTime, QDateTime or QUrl a the property's value is set to a string representation of the field. A parameter DATATYPE is added to the property with value BOOL, INT, UINT, DATE, TIME or DATETIME depending on the type.
• If the field is of some other type, the field value is encoded to a QByteArray via QDataStream (and the resulting byte array is base-64 encoded by the QVersitWriter). In this case, the parameter DATATYPE=VARIANT is added to the Versit property.

For example, a detail with definition name "Pet" and fields "Name"="Rex" and "Age"=(int)14 will be exported to the vCard properties:

 G0.X-NOKIA-QCONTACTFIELD;DETAIL=Pet;FIELD=Name:Rex
 G0.X-NOKIA-QCONTACTFIELD;DETAIL=Pet;FIELD=Age;DATATYPE=INT:14

And the next detail (say, "Pet" with a field "Name"="Molly" will generate:

 G1.X-NOKIA-QCONTACTFIELD;DETAIL=Pet;FIELD=Name:Molly

When applied to the importer, this handler decodes the properties that were generated by the exporter under the backup profile.

The code for this plugin can be perused in the plugins/versit/backuphandler directory.