1 /*

     2 * Copyright (c) 2008-2008 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:  Interface class to access the client information of a call

    15 *

    16 */

    17 

    18 #ifndef MPECLIENTINFORMATION_H

    19 #define MPECLIENTINFORMATION_H

    20 

    21 #include <pevirtualengine.h>

    22 

    23 /**

    24  * Interface to access the client information of a single call.

    25  */

    26 NONSHARABLE_CLASS( MPEClientInformation )

    27     {

    28     

    29 public:

    30     

    31     /**

    32      * Resets the state of this client information.

    33      */

    34     virtual void Reset() = 0;

    35     

    36     /**

    37      * Sets information from another client information.

    38      * 

    39      * @param   aSource         Client information to set.

    40      */

    41     virtual void Set( const MPEClientInformation& aSource ) = 0;

    42     

    43     /**

    44      * Sets the contact link used for retrieving contact information.

    45      * 

    46      * Should be available when dialing from Phonebook.

    47      * 

    48      * @param   aLink           Contact link to set.

    49      */

    50     virtual void SetContactLink( const TDesC8& aLink ) = 0;

    51 

    52     /**

    53      * Returns the contact link used for retrieving contact information.

    54      * 

    55      * @return  Contact link used for retrieving contact information.

    56      */

    57     virtual const TDesC8& ContactLink() const = 0;

    58     

    59     /**

    60      * Sets the name corresponding the phone number.

    61      * 

    62      * Must be defined if showing the phone number is disabled.

    63      * 

    64      * @param   aName           Name corresponding the phone number.

    65      */

    66     virtual void SetName( const TName& aName ) = 0;

    67     

    68     /**

    69      * Returns the name corresponding the phone number.

    70      * 

    71      * @return  Name corresponding the phone number.

    72      */

    73     virtual const TName& Name() const = 0;

    74     

    75     /**

    76      * Sets the phone number to be dialed.

    77      * 

    78      * @param   aNumber         Phone number to set.

    79      */

    80     virtual void SetNumber( const TPEPhoneNumber& aNumber ) = 0;

    81     

    82     /**

    83      * Returns the phone number to be dialed.

    84      * 

    85      * @return  Phone number to be dialed.

    86      */

    87     virtual const TPEPhoneNumber& Number() const = 0;

    88     

    89     /**

    90      * Sets the type of the call.

    91      * 

    92      * @param   aType           Type of the call to set.

    93      */

    94     virtual void SetCallType( TPECallType aType ) = 0;

    95     

    96     /**

    97      * Returns the type of the call.

    98      * 

    99      * @return  Type of the call.

   100      */

   101     virtual TPECallType CallType() const = 0;

   102 

   103     /**

   104      * Enables or disables contact matching.

   105      * 

   106      * @param   aAllow          Flag to enable or disable contact matching.

   107      */

   108     virtual void SetAllowMatch( TBool aAllow ) = 0;

   109     

   110     /**

   111      * Returns if contact matching is allowed.

   112      * 

   113      * @return  Flag to indicate if contact matching is allowed.

   114      */

   115     virtual TBool AllowMatch() const = 0;    

   116         

   117     /**

   118      * Shows or hides the phone number that is being dialed.

   119      * 

   120      * @param   aShow           Flag to indicate if the phone number being dialed should be shown.

   121      */

   122     virtual void SetShowNumber( TBool aShow ) = 0;

   123     

   124     /**

   125      * Returns a flag indicating if the phone number being dialed should be shown.

   126      * 

   127      * @return  Flag indicating if the phone number being dialed should be shown.

   128      */

   129     virtual TBool ShowNumber() const = 0;

   130     

   131     /**

   132      * Flag to indicate if existing calls should be terminated before this one is being attempted.

   133      * 

   134      * @param   aEndOtherCalls      Flag to indicate if existing calls should be terminated 

   135      *                              before this one is being attempted.

   136      */

   137     virtual void SetEndOtherCalls( TBool aEndOtherCalls ) = 0;

   138     

   139     /**

   140      * Returns a flag indicating if existing calls should be terminated before this one is being attempted.

   141      * 

   142      * @return  Flag indicating if existing calls should be terminated before this one is being attempted.

   143      */

   144     virtual TBool EndOtherCalls() const = 0;

   145     

   146     };

   147 

   148 #endif // MPECLIENTINFORMATION_H