epoc32/include/app/cntsync.h
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     3 // This component and the accompanying materials are made available
     4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     7 //
     8 // Initial Contributors:
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
     9 // Nokia Corporation - initial contribution.
    10 //
    10 //
    11 // Contributors:
    11 // Contributors:
    13 // Description:
    13 // Description:
    14 //
    14 //
    15 
    15 
    16 #ifndef __CNTSYNC_H__
    16 #ifndef __CNTSYNC_H__
    17 #define __CNTSYNC_H__
    17 #define __CNTSYNC_H__
    18 
       
    19 
    18 
    20 #include <e32base.h>
    19 #include <e32base.h>
    21 #include <cntdef.h>
    20 #include <cntdef.h>
    22 
    21 
    23 class CContactICCEntry;
    22 class CContactICCEntry;
    27 
    26 
    28 It should be inherited by classes which implement the phonebook 
    27 It should be inherited by classes which implement the phonebook 
    29 synchroniser API. The plug-in should have a second UID of 
    28 synchroniser API. The plug-in should have a second UID of 
    30 0x101F4A6E (KUidContactSynchroniserDll).
    29 0x101F4A6E (KUidContactSynchroniserDll).
    31 
    30 
    32 @internalAll
    31 @publishedAll
    33 */
    32 */
    34 	{
    33 	{
    35 public:
    34 public:
    36 	/**
    35 	/**
    37 	@internalAll
    36 	@publishedAll
       
    37 	@released
    38 	*/
    38 	*/
    39 	enum TValidateOperation
    39 	enum TValidateOperation
    40 		{
    40 		{
    41 		ERead,		/** Check a cached ICC contact can be read */
    41 		ERead,		/** Check a cached ICC contact can be read */
    42 		ESearch,	/** Check a cached ICC contact can be searched */
    42 		ESearch,	/** Check a cached ICC contact can be searched */
    94 	virtual TInt PhonebookList(RArray<TUid>& aPhonebookList) = 0;
    94 	virtual TInt PhonebookList(RArray<TUid>& aPhonebookList) = 0;
    95 
    95 
    96 private:
    96 private:
    97 	IMPORT_C virtual void MContactSynchroniser_Reserved_1();
    97 	IMPORT_C virtual void MContactSynchroniser_Reserved_1();
    98 	};
    98 	};
    99 	
       
   100 
    99 
   101 /** The UID for the default phone book synchroniser ECom plugin interface
   100 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
       
   101 
       
   102 /** The UID for the default phone book synchroniser ECom plugin interface.
       
   103 @publishedPartner
   102 */
   104 */
   103 const TUid KUidEcomCntPhBkSyncInterface = {0x102035FD};
   105 const TUid KUidEcomCntPhBkSyncInterface = {0x102035FD};
   104 	
   106 	
   105 class CContactSynchroniser : public CBase, public MContactSynchroniser
   107 class CContactSynchroniser : public CBase, public MContactSynchroniser
   106 /** 
   108 /** 
   107 Abstract interface for a ECom contacts phonebook synchroniser plugin
   109 Abstract interface for a ECom contacts phonebook synchroniser plugin
   108 
   110 
   109 It should be inherited by classes which implement the phonebook 
   111 It should be inherited by classes which implement the phonebook 
   110 synchroniser API in a platform secured environment. The ECom plug-in interface uid is 
   112 synchroniser API in a platform secured environment. The ECom plug-in interface uid is 
   111 KUidEcomCntPhBkSyncInterface
   113 KUidEcomCntPhBkSyncInterface
   112 @internalAll
   114 @publishedPartner
   113 */
   115 */
   114 	{
   116 	{
   115 public:
   117 public:
   116 	// From MContactSynchroniser
   118 	// From MContactSynchroniser
   117 	virtual TInt ValidateContact(TValidateOperation aOp, TContactItemId aId) = 0;
   119 	virtual TInt ValidateContact(TValidateOperation aOp, TContactItemId aId) = 0;
   131 private:
   133 private:
   132 	TUid iDtor_ID_Key;
   134 	TUid iDtor_ID_Key;
   133 	};
   135 	};
   134 
   136 
   135 #endif
   137 #endif
       
   138 	
       
   139 #endif