vmbx/vmbxengine/inc/vmbxenginebase.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".
    31 // CLASS DECLARATION
    31 // CLASS DECLARATION
    32 /**
    32 /**
    33 *  Implemets mailbox entry base class functionality
    33 *  Implemets mailbox entry base class functionality
    34 *
    34 *
    35 *  @lib vmbxengine.lib
    35 *  @lib vmbxengine.lib
    36 *  @since S60 v5.2
       
    37 */
    36 */
    38 NONSHARABLE_CLASS( CVmbxEngineBase ) : public CBase
    37 NONSHARABLE_CLASS( CVmbxEngineBase ) : public CBase
    39     {
    38     {
    40 
    39 
    41 public:  // Constructors and destructor
    40 public:  // Constructors and destructor
    54 public: // New functions
    53 public: // New functions
    55     /**
    54     /**
    56      * To get mailbox entry value
    55      * To get mailbox entry value
    57      * Leave if no number got or Symbian OS error code
    56      * Leave if no number got or Symbian OS error code
    58      *
    57      *
    59      * @since S60 v5.2
       
    60      * @param aEntry Entry data
    58      * @param aEntry Entry data
    61      */
    59      */
    62     virtual void GetL( CVoiceMailboxEntry*& aEntry ) = 0;
    60     virtual void GetL( CVoiceMailboxEntry*& aEntry ) = 0;
    63 
    61 
    64     /**
    62     /**
    65      * To save mailbox entry value
    63      * To save mailbox entry value
    66      * Leave with Symbian OS error code
    64      * Leave with Symbian OS error code
    67      *
    65      *
    68      * @since S60 v5.2
       
    69      * @param aEntry Entry data
    66      * @param aEntry Entry data
    70      */
    67      */
    71     virtual void SaveL( const CVoiceMailboxEntry& aEntry ) = 0;
    68     virtual void SaveL( const CVoiceMailboxEntry& aEntry ) = 0;
    72 
    69 
    73     /**
    70     /**
    74      * To save mailbox Provisioned entry value
    71      * To save mailbox Provisioned entry value
    75      * Leave with Symbian OS error code
    72      * Leave with Symbian OS error code
    76      *
    73      *
    77      * @since S60 v5.2
       
    78      * @param aEntry Provisioned Entry data
    74      * @param aEntry Provisioned Entry data
    79      */
    75      */
    80     virtual void SaveProvisionedEntryL( const CVoiceMailboxEntry& aEntry ) = 0;
    76     virtual void SaveProvisionedEntryL( const CVoiceMailboxEntry& aEntry ) = 0;
    81 
    77 
    82     /**
    78     /**
    83      * Checks the Voice Mailbox how many VoIP service Ids
    79      * Checks the Voice Mailbox how many VoIP service Ids
    84      * Leave with Symbian OS error code
    80      * Leave with Symbian OS error code
    85      *
    81      *
    86      * @since S60 v5.2
       
    87      * @param aProfileIds id of voip profile
    82      * @param aProfileIds id of voip profile
    88      */
    83      */
    89     virtual void GetServiceIdsL( RIdArray& aProfileIds );
    84     virtual void GetServiceIdsL( RIdArray& aProfileIds );
    90 
    85 
    91     /**
    86     /**
    92      * see CVoiceMailbox::GetVmbxImage
    87      * see CVoiceMailbox::GetVmbxImage
    93      * 
    88      * 
    94      * @since S60 v5.2
       
    95      */
    89      */
    96     //virtual CGulIcon* GetVmbxImageL( const TVoiceMailboxParams& aParams );
    90     //virtual CGulIcon* GetVmbxImageL( const TVoiceMailboxParams& aParams );
    97 
    91 
    98     /**
    92     /**
    99      * Sets the Voice Mailbox current service id.
    93      * Sets the Voice Mailbox current service id.
   100      *
    94      *
   101      * @since S60 v5.2
       
   102      * @param aVmbxServiceId Voice Mailbox service id.
    95      * @param aVmbxServiceId Voice Mailbox service id.
   103      */
    96      */
   104     virtual void SetCurrentServiceId( const TServiceId& aVmbxServiceId );
    97     virtual void SetCurrentServiceId( const TServiceId& aVmbxServiceId );
   105 
    98 
   106     /**
    99     /**
   107      * Checks the Voice Mailbox configuration to find out if a features
   100      * Checks the Voice Mailbox configuration to find out if a features
   108      * are disabled or enabled.
   101      * are disabled or enabled.
   109      *
   102      *
   110      * @since S60 v5.2
       
   111      * @param aParams Specifies which mailbox capabilities,
   103      * @param aParams Specifies which mailbox capabilities,
   112      *          the caller wants to check.
   104      *          the caller wants to check.
   113      * @param aFlags Use TVmbxFeatureCapability values for this parameter.
   105      * @param aFlags Use TVmbxFeatureCapability values for this parameter.
   114      *          Specifies what features client wants to check.
   106      *          Specifies what features client wants to check.
   115 
   107 
   120     
   112     
   121     /**
   113     /**
   122      * Displays number query dialog
   114      * Displays number query dialog
   123      * Leave if user don't select or Symbian OS error code
   115      * Leave if user don't select or Symbian OS error code
   124      *
   116      *
   125      * @since S60 v5.2
       
   126      * @param aEntry CVoiceMailboxEntry
   117      * @param aEntry CVoiceMailboxEntry
   127      */
   118      */
   128     virtual void QueryDefineNumberL( CVoiceMailboxEntry& aEntry );
   119     virtual void QueryDefineNumberL( CVoiceMailboxEntry& aEntry );
   129 
   120 
   130     /**
   121     /**
   131      * Displays number query dialog
   122      * Displays number query dialog
   132      * Leave if user don't select or Symbian OS error code
   123      * Leave if user don't select or Symbian OS error code
   133      *
   124      *
   134      * @since S60 v5.2
       
   135      * @param aEntry Entry data
   125      * @param aEntry Entry data
   136      */
   126      */
   137     virtual void QueryChangeNumberL( CVoiceMailboxEntry& aEntry );
   127     virtual void QueryChangeNumberL( CVoiceMailboxEntry& aEntry );
   138 
   128 
   139 
   129