vmbx/vmbxengine/inc/vmbxsimhandler.h
branchRCL_3
changeset 20 987c9837762f
parent 19 7d48bed6ce0c
child 21 0a6dd2dc9970
equal deleted inserted replaced
19:7d48bed6ce0c 20:987c9837762f
     1 /*
       
     2 * Copyright (c) 2009-2010 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:  Access class to SIM
       
    15 *  Interface   : Private, CVmbxSimHandler
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef C_VMBXSIMHANDLER_H
       
    21 #define C_VMBXSIMHANDLER_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <e32base.h>
       
    25 #include <voicemailboxdefs.h>
       
    26 #include "voicemailboxdefsinternal.h"
       
    27 
       
    28 
       
    29 // FORWARD DECLARATION
       
    30 class CVmbxPbkStore;
       
    31 class CVoiceMailboxEntry;
       
    32 
       
    33 
       
    34 // CLASS DECLARATION
       
    35 /**
       
    36 *  Creates connection to Sim phonebook and handles data flow from/to it
       
    37 *
       
    38 *  @lib vmbxengine.lib
       
    39 */
       
    40 NONSHARABLE_CLASS( CVmbxSimHandler ) : public CBase
       
    41     {
       
    42 
       
    43 public:  // Constructors and destructor
       
    44 
       
    45     /**
       
    46      * Two-phased constructor.
       
    47      */
       
    48     static CVmbxSimHandler* NewL();
       
    49 
       
    50     /**
       
    51      * Destructor.
       
    52      */
       
    53     virtual ~CVmbxSimHandler();
       
    54 
       
    55 public: // New functions
       
    56 
       
    57     /**
       
    58      * Retrieves mailbox number from Sim
       
    59      * @param in aEntry a data type of CVoiceMailboxEntry
       
    60      */
       
    61     void GetL( CVoiceMailboxEntry& aEntry );
       
    62 
       
    63     /**
       
    64      * Saves vmbx number to Sim
       
    65      * @param in aEntry a data type of CVoiceMailboxEntry
       
    66      * @return Symbian OS error code (KErrNone if successful)
       
    67      */
       
    68     TInt Save( const CVoiceMailboxEntry& aEntry );
       
    69 
       
    70     /**
       
    71      * Returns sim write access info
       
    72      * @return ETrue if Sim is writable
       
    73      **/
       
    74     TBool IsWritable();
       
    75 
       
    76     /**
       
    77      * @see RMobilePhoneStore::NotifyStoreEvent
       
    78      *
       
    79      */
       
    80     void NotifyStoreEvent( TRequestStatus& aStatus,
       
    81                                              TUint32& aEvent,
       
    82                                              TInt& aIndex ) const;
       
    83     /**
       
    84      * Retrieves Sim PhoneBook Type
       
    85      * @return TVmbxSimPhonebookType
       
    86      */
       
    87     TVmbxSimPhonebookType PhoneBookType();
       
    88 
       
    89     /**
       
    90      * CancelAsyncRequest
       
    91      * @param aReqToCancel Entry data
       
    92      */
       
    93     void CancelAsyncRequest( TInt aReqToCancel ) const;
       
    94 
       
    95 protected:
       
    96 
       
    97     /**
       
    98      * C++ constructor.
       
    99      */
       
   100     CVmbxSimHandler();
       
   101 
       
   102    /**
       
   103     * By default Symbian 2nd phase constructor is private.
       
   104     */
       
   105    void ConstructL();
       
   106 
       
   107 private: // data
       
   108 
       
   109     /**
       
   110      * pbk store
       
   111      * Own.
       
   112      */
       
   113     CVmbxPbkStore* iPbkStore;
       
   114     };
       
   115 
       
   116 #endif      // C_VMBXSIMHANDLER_H