vmbx/vmbxengine/inc/vmbxcsvoiceengine.h
changeset 19 e44a8c097b15
parent 12 ae8abd0db65c
child 32 1f002146abb4
equal deleted inserted replaced
15:d7fc66ccd6fb 19:e44a8c097b15
     1 /*
     1 /*
     2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
     2 * Copyright (c) 2009-2010 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     4 * This component and the accompanying materials are made available
     5 * under the terms of "Eclipse Public License v1.0"
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
    30 // CLASS DECLARATION
    30 // CLASS DECLARATION
    31 /**
    31 /**
    32 *  Implements functionality specifig to voice mailbox entry
    32 *  Implements functionality specifig to voice mailbox entry
    33 *
    33 *
    34 *  @lib vmbxengine.lib
    34 *  @lib vmbxengine.lib
    35 *  @since S60 v5.2
       
    36 */
    35 */
    37 NONSHARABLE_CLASS( CVmbxCsVoiceEngine ) : public CVmbxEngineBase
    36 NONSHARABLE_CLASS( CVmbxCsVoiceEngine ) : public CVmbxEngineBase
    38     {
    37     {
    39 
    38 
    40 public:  // Constructors and destructor
    39 public:  // Constructors and destructor
    41 
    40 
    42     /**
    41     /**
    43      * Two-phased constructor
    42      * Two-phased constructor
    44      * @since S60 v5.2
       
    45      * @param aProvider Reference to MVmbxResourceProvider.
    43      * @param aProvider Reference to MVmbxResourceProvider.
    46      * @return New instance of the object. Ownership transferred.
    44      * @return New instance of the object. Ownership transferred.
    47      */
    45      */
    48     static CVmbxCsVoiceEngine* NewL( MVmbxResourceProvider& aProvider );
    46     static CVmbxCsVoiceEngine* NewL( MVmbxResourceProvider& aProvider );
    49 
    47 
    55 // from base class CVmbxEntryBase
    53 // from base class CVmbxEntryBase
    56 
    54 
    57     /**
    55     /**
    58      * @see CVmbxEntryBase::GetL
    56      * @see CVmbxEntryBase::GetL
    59      *
    57      *
    60      * @since S60 v5.2
       
    61      * @param aEntry Reference to CVoiceMailboxEntry
    58      * @param aEntry Reference to CVoiceMailboxEntry
    62      */
    59      */
    63     void GetL( CVoiceMailboxEntry*& aEntry );
    60     void GetL( CVoiceMailboxEntry*& aEntry );
    64 
    61 
    65     /**
    62     /**
    66      * @see CVmbxEntryBase::SaveL
    63      * @see CVmbxEntryBase::SaveL
    67      *
    64      *
    68      * @since S60 v5.2
       
    69      * @param aEntry 
    65      * @param aEntry 
    70      */
    66      */
    71     void SaveL( const CVoiceMailboxEntry& aEntry );
    67     void SaveL( const CVoiceMailboxEntry& aEntry );
    72 
    68 
    73     /**
    69     /**
    74      * To save mailbox Provisioned entry value
    70      * To save mailbox Provisioned entry value
    75      *
    71      *
    76      * @since S60 v5.2
       
    77      * @param aEntry Provisioned Entry data
    72      * @param aEntry Provisioned Entry data
    78      */
    73      */
    79     void SaveProvisionedEntryL( const CVoiceMailboxEntry& aEntry );
    74     void SaveProvisionedEntryL( const CVoiceMailboxEntry& aEntry );
    80 
    75 
    81     /**
    76     /**
    82      * @see CVoiceMailbox::CheckConfiguration
    77      * @see CVoiceMailbox::CheckConfiguration
    83      *
    78      *
    84      * @since S60 v5.2
       
    85      * @param aParams Specifies which mailbox capabilities,
    79      * @param aParams Specifies which mailbox capabilities,
    86      *          the caller wants to check.
    80      *          the caller wants to check.
    87      * @param aFlags Use TVmbxFeatureCapabilityFlag values for this parameter.
    81      * @param aFlags Use TVmbxFeatureCapabilityFlag values for this parameter.
    88      *          Specifies what features client wants to check.
    82      *          Specifies what features client wants to check.
    89 
    83 
    93                                  const TInt aFlags );
    87                                  const TInt aFlags );
    94 
    88 
    95     /**
    89     /**
    96      * Check Entry writable
    90      * Check Entry writable
    97      *
    91      *
    98      * @since S60 v5.2
       
    99      * @param aParams params of Entry data
    92      * @param aParams params of Entry data
   100      * @return ETrue if entry is writable
    93      * @return ETrue if entry is writable
   101      */
    94      */
   102     TBool IsWritable( const TVoiceMailboxParams& aParams );
    95     TBool IsWritable( const TVoiceMailboxParams& aParams );
   103  
    96  
   104 private:
    97 private:
   105 
    98 
   106     /**
    99     /**
   107      * C++ default constructor.
   100      * C++ default constructor.
   108      *
   101      *
   109      * @since S60 v5.2
       
   110      * @param aProvider Reference to MVmbxResourceProvider
   102      * @param aProvider Reference to MVmbxResourceProvider
   111      */
   103      */
   112     CVmbxCsVoiceEngine( MVmbxResourceProvider& aProvider );
   104     CVmbxCsVoiceEngine( MVmbxResourceProvider& aProvider );
   113 
   105 
   114     /**
   106     /**
   115      * By default Symbian 2nd phase constructor is private.
   107      * By default Symbian 2nd phase constructor is private.
   116      *
   108      *
   117      * @since S60 v5.2
       
   118      */
   109      */
   119     void ConstructL();
   110     void ConstructL();
   120 
   111 
   121     /**
   112     /**
   122      * Queries where to save and then saves
   113      * Queries where to save and then saves
   123      *
   114      *
   124      * @since S60 v5.2
       
   125      * @param in aEntry Entry data
   115      * @param in aEntry Entry data
   126      */
   116      */
   127     void SaveEntryToPhoneL( const CVoiceMailboxEntry& aEntry );
   117     void SaveEntryToPhoneL( const CVoiceMailboxEntry& aEntry );
   128 
   118 
   129     /**
   119     /**
   130      * For saving to place that user selects
   120      * For saving to place that user selects
   131      *
   121      *
   132      * @since S60 v5.2
       
   133      * @param in aEntry Entry data
   122      * @param in aEntry Entry data
   134      */
   123      */
   135     void SaveEntryToSimL( const CVoiceMailboxEntry& aEntry );
   124     void SaveEntryToSimL( const CVoiceMailboxEntry& aEntry );
   136 
   125 
   137     /**
   126     /**
   138      * Returns Sim writable or not
   127      * Returns Sim writable or not
   139      *
   128      *
   140      * @since S60 v5.2
       
   141      * @return ETrue if writable
   129      * @return ETrue if writable
   142      */
   130      */
   143     TBool IsSimWritable();
   131     TBool IsSimWritable();
   144 
   132 
   145 private: // data
   133 private: // data