epoc32/include/app/MVPbkStoreContact2.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*
     2 * Copyright (c) 2004-2007 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:  An interface for store contacts.
    15 *
    16 */
    17 
    18 
    19 #ifndef MVPBKSTORECONTACT2_H
    20 #define MVPBKSTORECONTACT2_H
    21 
    22 
    23 // FORWARD DECLARATIONS
    24 class MVPbkStoreContactProperties;
    25 
    26 // CLASS DECLARATIONS
    27 
    28 /**
    29  * This class is an extension to MVPbkStoreContact.
    30  * See documentation of MVPbkStoreContact from header MVPbkStoreContact.h 
    31  * 
    32  *
    33  * @see MVPbkStoreContact
    34  * 
    35  */
    36 class MVPbkStoreContact2
    37     {
    38     public:  // Destructor
    39         virtual ~MVPbkStoreContact2() { }
    40 
    41     public:
    42 
    43         /**   
    44          * Returns auxiliary properties.
    45          * Can return NULL if underlying store doesn't support any 
    46          * of MVPbkStoreContactProperties functions.
    47          *
    48          * @return A properties object
    49         */
    50         virtual MVPbkStoreContactProperties* PropertiesL() const =0;
    51           
    52         /**
    53          * Set the contact as the store's current own contact asynchronously. 
    54          *
    55          * @param aObserver The observer to call back when this operation
    56          *                  completes. The observer will not be called if this
    57          *                  function leaves.
    58          * @exception KErrInUse If another asynchronous operation is already
    59          *            in progress.
    60          * @exception KErrNotSupported If store does not support own contact
    61          */
    62         virtual void SetAsOwnL(MVPbkContactObserver& aObserver) const =0;
    63         
    64         
    65         
    66       
    67     };
    68 
    69 #endif  // MVPBKSTORECONTACT2_H
    70 
    71 //End of file