vmbx/vmbxengine/inc/vmbxvoipengine.h
branchRCL_3
changeset 19 7d48bed6ce0c
equal deleted inserted replaced
18:594d59766373 19:7d48bed6ce0c
       
     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 VoIp engine implementation
       
    15 *  Interface   : Private, CVmbxVoIpEngine
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef C_VMBXVOIPENGINE_H
       
    21 #define C_VMBXVOIPENGINE_H
       
    22 
       
    23 // INCLUDES
       
    24 #include <e32std.h>
       
    25 #include <e32base.h>
       
    26 
       
    27 // FORWARD DECLARATIONS
       
    28 class CVmbxEngineBase;
       
    29 //class CGulIcon;
       
    30 class CVmSPSHandler;
       
    31 class CVmBSHandler;
       
    32 class TVmbxServiceInfo;
       
    33 //class CFbsBitmap;
       
    34 
       
    35 // CLASS DECLARATION
       
    36 
       
    37 /**
       
    38 *  Implements functionality specifig to voip mailbox entry
       
    39 *
       
    40 *  @lib vmbxengine.lib
       
    41 */
       
    42 NONSHARABLE_CLASS( CVmbxVoIpEngine ) : public CVmbxEngineBase
       
    43     {
       
    44 
       
    45 public:  // Constructors and destructor
       
    46 
       
    47     /**
       
    48      * Two-phased constructor
       
    49      * @param aProvider Reference to Ui Utilities
       
    50      */
       
    51     static CVmbxVoIpEngine* NewL( MVmbxResourceProvider& aProvider );
       
    52 
       
    53 
       
    54     /**
       
    55      * Destructor.
       
    56      */
       
    57     virtual ~CVmbxVoIpEngine();
       
    58 
       
    59 public: // from base class CVmbxEntryBase
       
    60 
       
    61     /**
       
    62      *
       
    63      * @see CVmbxEntryBase::GetL
       
    64      * @param aEntry Reference to store handler
       
    65      */
       
    66     void GetL( CVoiceMailboxEntry*& aEntry );
       
    67 
       
    68     /**
       
    69      *
       
    70      * @see CVmbxEntryBase::SaveL
       
    71      * @param aEntry Reference to CVoiceMailboxEntry
       
    72      * @param aShowNotesAllowed Provision mode is used to decide whether show
       
    73      *          saved notification UI dialog. If aShowNotesAllowed is EFalse,
       
    74      *          saved notification UI dialog will not show. 
       
    75      */
       
    76     void SaveL( const CVoiceMailboxEntry& aEntry,
       
    77                 TBool aShowNotesAllowed );
       
    78 
       
    79     /**
       
    80      * To save mailbox Provisioned entry value
       
    81      *
       
    82      * @param aEntry Provisioned Entry data
       
    83      */
       
    84     void SaveProvisionedEntryL( const CVoiceMailboxEntry& aEntry );
       
    85 
       
    86     /**
       
    87      * see CVmbxEntryBase::CheckConfiguration
       
    88      *
       
    89      */   
       
    90     TBool CheckConfiguration( const TVoiceMailboxParams& aParams,
       
    91                                  const TInt aFlags );
       
    92 
       
    93     /**
       
    94      * Displays number query dialog
       
    95      *
       
    96      * @param aEntry CVoiceMailboxEntry
       
    97      */
       
    98     void QueryDefineNumberL( CVoiceMailboxEntry& aEntry );
       
    99 
       
   100     /**
       
   101      * Displays number query dialog
       
   102      *
       
   103      * @param aEntry Entry data
       
   104      */
       
   105     void QueryChangeNumberL( CVoiceMailboxEntry& aEntry );
       
   106 
       
   107 private: // New function
       
   108 
       
   109     /**
       
   110      * C++ default constructor.
       
   111      *
       
   112      * @param aProvider Reference to Ui Utilities
       
   113      */
       
   114     CVmbxVoIpEngine( MVmbxResourceProvider& aProvider );
       
   115 
       
   116     /**
       
   117      * By default Symbian 2nd phase constructor is private.
       
   118      *
       
   119     */
       
   120     void ConstructL();
       
   121 
       
   122     /**
       
   123      * Check from SPSettings if there are VoIP profiles
       
   124      * @param None
       
   125      * @return ETrue if VoIP profiles were found, otherwise EFalse
       
   126      */
       
   127     TBool IsVoIPProfilesFound();
       
   128 
       
   129     /**
       
   130      * Checks the Voice Mailbox how many VoIP service Ids
       
   131      *
       
   132      * @param aProfileIds
       
   133      * @return KErrNone if get service Ids successfully.
       
   134      */
       
   135     void GetServiceIdsL( RIdArray& aProfileIds );
       
   136 
       
   137     /**
       
   138      * Get branded icon
       
   139      * @param in aBrandingId Brandind Id
       
   140      * @param out aBrandedBitmap Bitmap for branded icon
       
   141      * @param out aBrandedBitmapMask Mask to branded icon
       
   142      */
       
   143     //void GetBrandedIconL( const TDesC8& aBrandingId,
       
   144     //    CFbsBitmap*& aBrandedBitmap, CFbsBitmap*& aBrandedBitmapMask );
       
   145 
       
   146     /**
       
   147      * see CVoiceMailbox::GetVmbxImage
       
   148      * 
       
   149      */
       
   150     //CGulIcon* GetVmbxImageL( const TVoiceMailboxParams& aParams );
       
   151 
       
   152     /**
       
   153      * Get brand id
       
   154      * @param in aServiceId Used Service
       
   155      * @param out aBrandId On completion, contains Brand Id
       
   156      */
       
   157     void BrandIdL( TInt aServiceId, TDes8& aBrandId );
       
   158 
       
   159     /**
       
   160      * Get service ids
       
   161      * @param in&out aServiceInfo On completion contains service ids
       
   162      */
       
   163     TInt GetServiceInfo( TVmbxServiceInfo& aServiceInfo );
       
   164 
       
   165 private: // data
       
   166 
       
   167     /**
       
   168      * Handles Service proviver Settings, Own.
       
   169      */
       
   170     CVmSPSHandler* iVmSpsHandler;
       
   171     
       
   172     /**
       
   173      * Handles Branding Server, Own.
       
   174      */
       
   175     CVmBSHandler* iVmBsHandler;
       
   176     };
       
   177 
       
   178 #endif  // C_VMBXVOIPENGINE_H