vmbx/vmbxengine/inc/vmbxvoipengine.h
changeset 12 ae8abd0db65c
child 19 e44a8c097b15
equal deleted inserted replaced
0:ff3b6d0fd310 12:ae8abd0db65c
       
     1 /*
       
     2 * Copyright (c) 2009 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 *  @since S60 v5.2
       
    42 */
       
    43 NONSHARABLE_CLASS( CVmbxVoIpEngine ) : public CVmbxEngineBase
       
    44     {
       
    45 
       
    46 public:  // Constructors and destructor
       
    47 
       
    48     /**
       
    49      * Two-phased constructor
       
    50      * @param aProvider Reference to Ui Utilities
       
    51      */
       
    52     static CVmbxVoIpEngine* NewL( MVmbxResourceProvider& aProvider );
       
    53 
       
    54 
       
    55     /**
       
    56      * Destructor.
       
    57      */
       
    58     virtual ~CVmbxVoIpEngine();
       
    59 
       
    60 public: // from base class CVmbxEntryBase
       
    61 
       
    62     /**
       
    63      *
       
    64      * @since S60 v5.2
       
    65      * @see CVmbxEntryBase::GetL
       
    66      * @param aEntry Reference to store handler
       
    67      */
       
    68     void GetL( CVoiceMailboxEntry*& aEntry );
       
    69 
       
    70     /**
       
    71      *
       
    72      * @since S60 v5.2
       
    73      * @see CVmbxEntryBase::SaveL
       
    74      * @param aEntry Reference to CVoiceMailboxEntry
       
    75      */
       
    76     void SaveL( const CVoiceMailboxEntry& aEntry );
       
    77 
       
    78     /**
       
    79      * To save mailbox Provisioned entry value
       
    80      *
       
    81      * @since S60 v5.2
       
    82      * @param aEntry Provisioned Entry data
       
    83      */
       
    84     void SaveProvisionedEntryL( const CVoiceMailboxEntry& aEntry );
       
    85 
       
    86     /**
       
    87      * see CVmbxEntryBase::CheckConfiguration
       
    88      *
       
    89      * @since S60 v5.2
       
    90      */   
       
    91     TBool CheckConfiguration( const TVoiceMailboxParams& aParams,
       
    92                                  const TInt aFlags );
       
    93 
       
    94     /**
       
    95      * Displays number query dialog
       
    96      *
       
    97      * @since S60 v5.2
       
    98      * @param aEntry CVoiceMailboxEntry
       
    99      */
       
   100     void QueryDefineNumberL( CVoiceMailboxEntry& aEntry );
       
   101 
       
   102     /**
       
   103      * Displays number query dialog
       
   104      *
       
   105      * @since S60 v5.2
       
   106      * @param aEntry Entry data
       
   107      */
       
   108     void QueryChangeNumberL( CVoiceMailboxEntry& aEntry );
       
   109 
       
   110 private: // New function
       
   111 
       
   112     /**
       
   113      * C++ default constructor.
       
   114      *
       
   115      * @since S60 v5.2
       
   116      * @param aProvider Reference to Ui Utilities
       
   117      */
       
   118     CVmbxVoIpEngine( MVmbxResourceProvider& aProvider );
       
   119 
       
   120     /**
       
   121      * By default Symbian 2nd phase constructor is private.
       
   122      *
       
   123      * @since S60 v5.2
       
   124     */
       
   125     void ConstructL();
       
   126 
       
   127     /**
       
   128      * Check from SPSettings if there are VoIP profiles
       
   129      * @since S60 3.2.3
       
   130      * @param None
       
   131      * @return ETrue if VoIP profiles were found, otherwise EFalse
       
   132      */
       
   133     TBool IsVoIPProfilesFound();
       
   134 
       
   135     /**
       
   136      * Checks the Voice Mailbox how many VoIP service Ids
       
   137      *
       
   138      * @since S60 v5.2
       
   139      * @param aProfileIds
       
   140      * @return KErrNone if get service Ids successfully.
       
   141      */
       
   142     void GetServiceIdsL( RIdArray& aProfileIds );
       
   143 
       
   144     /**
       
   145      * Get branded icon
       
   146      * @since S60 v5.2
       
   147      * @param in aBrandingId Brandind Id
       
   148      * @param out aBrandedBitmap Bitmap for branded icon
       
   149      * @param out aBrandedBitmapMask Mask to branded icon
       
   150      */
       
   151     //void GetBrandedIconL( const TDesC8& aBrandingId,
       
   152     //    CFbsBitmap*& aBrandedBitmap, CFbsBitmap*& aBrandedBitmapMask );
       
   153 
       
   154     /**
       
   155      * see CVoiceMailbox::GetVmbxImage
       
   156      * 
       
   157      * @since S60 v5.2
       
   158      */
       
   159     //CGulIcon* GetVmbxImageL( const TVoiceMailboxParams& aParams );
       
   160 
       
   161     /**
       
   162      * Get brand id
       
   163      * @since S60 v5.2
       
   164      * @param in aServiceId Used Service
       
   165      * @param out aBrandId On completion, contains Brand Id
       
   166      */
       
   167     void BrandIdL( TInt aServiceId, TDes8& aBrandId );
       
   168 
       
   169     /**
       
   170      * Get service ids
       
   171      * @since S60 v5.2
       
   172      * @param in&out aServiceInfo On completion contains service ids
       
   173      */
       
   174     TInt GetServiceInfo( TVmbxServiceInfo& aServiceInfo );
       
   175 
       
   176 private: // data
       
   177 
       
   178     /**
       
   179      * Handles Service proviver Settings, Own.
       
   180      */
       
   181     CVmSPSHandler* iVmSpsHandler;
       
   182     
       
   183     /**
       
   184      * Handles Branding Server, Own.
       
   185      */
       
   186     CVmBSHandler* iVmBsHandler;
       
   187     };
       
   188 
       
   189 #endif  // C_VMBXVOIPENGINE_H