cellular/telephonysettings/inc/MCallDiverting.h
changeset 0 ff3b6d0fd310
child 19 7d48bed6ce0c
equal deleted inserted replaced
-1:000000000000 0:ff3b6d0fd310
       
     1 /*
       
     2 * Copyright (c) 2002-2006 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: Declaration of MCallDiverting interface class.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef     MCALLDIVERTING_H
       
    20 #define     MCALLDIVERTING_H
       
    21 
       
    22 /**
       
    23  *  MCallDiverting class is virtual interface class for divert 
       
    24  *  functionality.
       
    25  *
       
    26  *  @lib phonesettings
       
    27  *  @since S60 v5.1
       
    28  */
       
    29 class MCallDiverting
       
    30     {
       
    31     public:
       
    32 
       
    33         /**
       
    34         * Sets diverting to the network.
       
    35         * 
       
    36         * @param aDivert New divert settings.
       
    37         * @param aBsc List of basic service groups .
       
    38         */
       
    39         virtual void SetDivertingL( const TCallDivertSetting& aDivert,  
       
    40                                     TBasicServiceGroups aBsc ) = 0;
       
    41         /**
       
    42         * Checks the diverting status from network.
       
    43         * 
       
    44         * @param aServiceGroup Service group indication.
       
    45         * @param aCondition Diverting conditions.
       
    46         * @param aBsc List of basic service groups.
       
    47         */
       
    48         virtual void GetDivertingStatusL( 
       
    49                                     const TServiceGroup aServiceGroup, 
       
    50                                     const TCallDivertingCondition aCondition, 
       
    51                                     TBasicServiceGroups aBsc ) = 0;
       
    52         /**
       
    53         * Cancels current request.
       
    54         * 
       
    55         * @return Returns error code.
       
    56         */
       
    57         virtual TInt CancelCurrentRequest() = 0;
       
    58         
       
    59         /**
       
    60         *  Reads used divert numbers (0-3) from central repository
       
    61         *  and fills array with them.
       
    62         *
       
    63         *  @param aType used line.
       
    64         *  @param aArray array of divert number.
       
    65         *  @return amount of numbers.
       
    66         */
       
    67         virtual TInt GetNumbersFromSharedDataL( 
       
    68                                     TInt aType, 
       
    69                                     CDesC16ArrayFlat& aArray ) = 0;
       
    70         /**
       
    71         * Sets new default number the the default numbers list, 
       
    72         * erases the oldest one.
       
    73         * 
       
    74         * @param aNumber phone number. 
       
    75         * @return Returns error code.
       
    76         */
       
    77         virtual TInt SetNewDefaultNumberL( TDes& aNumber ) = 0;
       
    78         
       
    79         /**
       
    80         *  Gets the default time for CF No Reply.
       
    81         *  No error checking for return values which should be
       
    82         *  5-30, in steps of 5.
       
    83         *
       
    84         * @return Returns the current timer value.
       
    85         */
       
    86         virtual TInt GetTimerValueL() = 0;
       
    87         
       
    88         /*
       
    89         *  Sets the default time for CF No Reply.
       
    90         *  No error checking to parameters, which should be on range 5-30,
       
    91         *  using steps of 5.
       
    92         *
       
    93         *  @param aIndex New value for timer.
       
    94         *  @return Returns error code.
       
    95         */
       
    96         virtual TInt SetTimerValueL( const TInt& aValue ) = 0;
       
    97         
       
    98         /**
       
    99         * Swaps the most recently used number to first in shared data file.
       
   100         *
       
   101         * @param  aLocation Used number's location (1-3) in shared data.
       
   102         */
       
   103         virtual void SwapDefaultNumberL( const TInt& aLocation ) = 0;
       
   104         
       
   105         /**
       
   106         * Saves a single value to central repository. Make sure that repository
       
   107         * is open before calling this function.
       
   108         */
       
   109         virtual TInt SaveKey( TUint32 aKeyId, const TDesC& aKeyValue ) = 0;
       
   110         
       
   111         /**
       
   112         * Opens Vmbx connection. Leaves vmbx to the stack. 
       
   113         * 
       
   114         * @param aTelNumber vmbx number.
       
   115         * @param aVmbx vmbx connection.
       
   116         * @return used vmbx number.
       
   117         */ 
       
   118         virtual TInt OpenVmbxLC( TDes& aTelNumber, RVmbxNumber& aVmbx ) = 0;
       
   119         
       
   120         /*
       
   121         * Virtual destructor. 
       
   122         */ 
       
   123         virtual ~MCallDiverting() {};
       
   124     };
       
   125 
       
   126 #endif // MPCALLDIVERTING_H