CVPbkContactCopier Class Reference

#include <app/CVPbkContactCopier.h>

Link against: VPbkEng.lib

class CVPbkContactCopier : public CBase

Inherits from

  • CVPbkContactCopier

    Detailed Description

    Virtual Phonebook contact copier. Copies source contacts to the target store according to copying rules.

    Member Enumeration Documentation

    Enum TVPbkContactCopyFlags

    A set of flags for copying. Fastest copy is EVPbkSimpleContactCopy.

    EnumeratorValueDescription
    EVPbkSimpleContactCopy0

    Copies a field if the target store supports the field type. Does not perform additional checks.

    EVPbkUseStoreSpecificCopyPolicy0x01

    Uses a store specific copy policy if found for the target store. Can do e.g field type conversion between source and target field types. Falls back to simple copy if the copy policy was not found for the store.

    EVPbkUsePlatformSpecificDuplicatePolicy0x02

    Finds duplicates before saving a contact if there is a copy policy for the store that can handle the possible merge of new and existing contact data. Falls back to simple copy if the copy policy was not found for the store.

    Constructor & Destructor Documentation

    ~CVPbkContactCopier ( )

    ~CVPbkContactCopier()

    Destructor.

    Member Function Documentation

    CopyContactsL ( TUint32, const MVPbkContactLinkArray &, MVPbkContactStore *, CVPbkContactLinkArray &, MVPbkBatchOperationObserver & )

    IMPORT_C MVPbkContactOperationBase *CopyContactsL(TUint32aContactCopyFlags,
    const MVPbkContactLinkArray &aSourceContactLinks,
    MVPbkContactStore *aTargetStore,
    CVPbkContactLinkArray &aCopiedContactLinks,
    MVPbkBatchOperationObserver &aObserver
    )

    Copies a set of contacts to the target store.

    ParameterDescription
    aContactCopyFlagsA set of TVPbkContactCopyFlags
    aSourceContactLinksSource contact links
    aTargetStoreTarget of the copy operation. If NULL this behaves like duplicate.
    aCopiedContactLinksThe results of the copy. Copied contacts are added to this array.
    aObserverAn observer for asynchronous operation

    Returns: A copy contact operation

    NewL ( CVPbkContactManager & )

    IMPORT_C CVPbkContactCopier *NewL(CVPbkContactManager &aContactManager)[static]

    Creates a new copier instance. Remember to open the stores first before starting any copy operation.

    ParameterDescription
    aContactManagerThe contact manager for getting stores.

    Returns: A new instance of this class