vmbx/vmbxengine/inc/vmbxvoipengine.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".
    36 
    36 
    37 /**
    37 /**
    38 *  Implements functionality specifig to voip mailbox entry
    38 *  Implements functionality specifig to voip mailbox entry
    39 *
    39 *
    40 *  @lib vmbxengine.lib
    40 *  @lib vmbxengine.lib
    41 *  @since S60 v5.2
       
    42 */
    41 */
    43 NONSHARABLE_CLASS( CVmbxVoIpEngine ) : public CVmbxEngineBase
    42 NONSHARABLE_CLASS( CVmbxVoIpEngine ) : public CVmbxEngineBase
    44     {
    43     {
    45 
    44 
    46 public:  // Constructors and destructor
    45 public:  // Constructors and destructor
    59 
    58 
    60 public: // from base class CVmbxEntryBase
    59 public: // from base class CVmbxEntryBase
    61 
    60 
    62     /**
    61     /**
    63      *
    62      *
    64      * @since S60 v5.2
       
    65      * @see CVmbxEntryBase::GetL
    63      * @see CVmbxEntryBase::GetL
    66      * @param aEntry Reference to store handler
    64      * @param aEntry Reference to store handler
    67      */
    65      */
    68     void GetL( CVoiceMailboxEntry*& aEntry );
    66     void GetL( CVoiceMailboxEntry*& aEntry );
    69 
    67 
    70     /**
    68     /**
    71      *
    69      *
    72      * @since S60 v5.2
       
    73      * @see CVmbxEntryBase::SaveL
    70      * @see CVmbxEntryBase::SaveL
    74      * @param aEntry Reference to CVoiceMailboxEntry
    71      * @param aEntry Reference to CVoiceMailboxEntry
    75      */
    72      */
    76     void SaveL( const CVoiceMailboxEntry& aEntry );
    73     void SaveL( const CVoiceMailboxEntry& aEntry );
    77 
    74 
    78     /**
    75     /**
    79      * To save mailbox Provisioned entry value
    76      * To save mailbox Provisioned entry value
    80      *
    77      *
    81      * @since S60 v5.2
       
    82      * @param aEntry Provisioned Entry data
    78      * @param aEntry Provisioned Entry data
    83      */
    79      */
    84     void SaveProvisionedEntryL( const CVoiceMailboxEntry& aEntry );
    80     void SaveProvisionedEntryL( const CVoiceMailboxEntry& aEntry );
    85 
    81 
    86     /**
    82     /**
    87      * see CVmbxEntryBase::CheckConfiguration
    83      * see CVmbxEntryBase::CheckConfiguration
    88      *
    84      *
    89      * @since S60 v5.2
       
    90      */   
    85      */   
    91     TBool CheckConfiguration( const TVoiceMailboxParams& aParams,
    86     TBool CheckConfiguration( const TVoiceMailboxParams& aParams,
    92                                  const TInt aFlags );
    87                                  const TInt aFlags );
    93 
    88 
    94     /**
    89     /**
    95      * Displays number query dialog
    90      * Displays number query dialog
    96      *
    91      *
    97      * @since S60 v5.2
       
    98      * @param aEntry CVoiceMailboxEntry
    92      * @param aEntry CVoiceMailboxEntry
    99      */
    93      */
   100     void QueryDefineNumberL( CVoiceMailboxEntry& aEntry );
    94     void QueryDefineNumberL( CVoiceMailboxEntry& aEntry );
   101 
    95 
   102     /**
    96     /**
   103      * Displays number query dialog
    97      * Displays number query dialog
   104      *
    98      *
   105      * @since S60 v5.2
       
   106      * @param aEntry Entry data
    99      * @param aEntry Entry data
   107      */
   100      */
   108     void QueryChangeNumberL( CVoiceMailboxEntry& aEntry );
   101     void QueryChangeNumberL( CVoiceMailboxEntry& aEntry );
   109 
   102 
   110 private: // New function
   103 private: // New function
   111 
   104 
   112     /**
   105     /**
   113      * C++ default constructor.
   106      * C++ default constructor.
   114      *
   107      *
   115      * @since S60 v5.2
       
   116      * @param aProvider Reference to Ui Utilities
   108      * @param aProvider Reference to Ui Utilities
   117      */
   109      */
   118     CVmbxVoIpEngine( MVmbxResourceProvider& aProvider );
   110     CVmbxVoIpEngine( MVmbxResourceProvider& aProvider );
   119 
   111 
   120     /**
   112     /**
   121      * By default Symbian 2nd phase constructor is private.
   113      * By default Symbian 2nd phase constructor is private.
   122      *
   114      *
   123      * @since S60 v5.2
       
   124     */
   115     */
   125     void ConstructL();
   116     void ConstructL();
   126 
   117 
   127     /**
   118     /**
   128      * Check from SPSettings if there are VoIP profiles
   119      * Check from SPSettings if there are VoIP profiles
   129      * @since S60 3.2.3
       
   130      * @param None
   120      * @param None
   131      * @return ETrue if VoIP profiles were found, otherwise EFalse
   121      * @return ETrue if VoIP profiles were found, otherwise EFalse
   132      */
   122      */
   133     TBool IsVoIPProfilesFound();
   123     TBool IsVoIPProfilesFound();
   134 
   124 
   135     /**
   125     /**
   136      * Checks the Voice Mailbox how many VoIP service Ids
   126      * Checks the Voice Mailbox how many VoIP service Ids
   137      *
   127      *
   138      * @since S60 v5.2
       
   139      * @param aProfileIds
   128      * @param aProfileIds
   140      * @return KErrNone if get service Ids successfully.
   129      * @return KErrNone if get service Ids successfully.
   141      */
   130      */
   142     void GetServiceIdsL( RIdArray& aProfileIds );
   131     void GetServiceIdsL( RIdArray& aProfileIds );
   143 
   132 
   144     /**
   133     /**
   145      * Get branded icon
   134      * Get branded icon
   146      * @since S60 v5.2
       
   147      * @param in aBrandingId Brandind Id
   135      * @param in aBrandingId Brandind Id
   148      * @param out aBrandedBitmap Bitmap for branded icon
   136      * @param out aBrandedBitmap Bitmap for branded icon
   149      * @param out aBrandedBitmapMask Mask to branded icon
   137      * @param out aBrandedBitmapMask Mask to branded icon
   150      */
   138      */
   151     //void GetBrandedIconL( const TDesC8& aBrandingId,
   139     //void GetBrandedIconL( const TDesC8& aBrandingId,
   152     //    CFbsBitmap*& aBrandedBitmap, CFbsBitmap*& aBrandedBitmapMask );
   140     //    CFbsBitmap*& aBrandedBitmap, CFbsBitmap*& aBrandedBitmapMask );
   153 
   141 
   154     /**
   142     /**
   155      * see CVoiceMailbox::GetVmbxImage
   143      * see CVoiceMailbox::GetVmbxImage
   156      * 
   144      * 
   157      * @since S60 v5.2
       
   158      */
   145      */
   159     //CGulIcon* GetVmbxImageL( const TVoiceMailboxParams& aParams );
   146     //CGulIcon* GetVmbxImageL( const TVoiceMailboxParams& aParams );
   160 
   147 
   161     /**
   148     /**
   162      * Get brand id
   149      * Get brand id
   163      * @since S60 v5.2
       
   164      * @param in aServiceId Used Service
   150      * @param in aServiceId Used Service
   165      * @param out aBrandId On completion, contains Brand Id
   151      * @param out aBrandId On completion, contains Brand Id
   166      */
   152      */
   167     void BrandIdL( TInt aServiceId, TDes8& aBrandId );
   153     void BrandIdL( TInt aServiceId, TDes8& aBrandId );
   168 
   154 
   169     /**
   155     /**
   170      * Get service ids
   156      * Get service ids
   171      * @since S60 v5.2
       
   172      * @param in&out aServiceInfo On completion contains service ids
   157      * @param in&out aServiceInfo On completion contains service ids
   173      */
   158      */
   174     TInt GetServiceInfo( TVmbxServiceInfo& aServiceInfo );
   159     TInt GetServiceInfo( TVmbxServiceInfo& aServiceInfo );
   175 
   160 
   176 private: // data
   161 private: // data