1 /*

     2 * Copyright (c) 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:  Defines interface for manipulating telephony call logging

    15 *                using ECOM plugin.

    16 *

    17 */

    18 

    19 

    20 #ifndef TELLOGGINGEXTENSION_H

    21 #define TELLOGGINGEXTENSION_H

    22 

    23 #include <e32base.h>

    24 #include <data_caging_path_literals.hrh>

    25 

    26 // Constants used in ECOM implementation

    27 const TUid KTelLoggingExtensionUid    = { 0x2001E2A2 };

    28 

    29 

    30 /**

    31  * Plugin interface class for manipulating telephony

    32  * call logging.

    33  *

    34  * @since S60 5.0

    35  */

    36 class CTelLoggingExtension : public CBase

    37     {

    38 public:

    39 

    40     /**

    41     * Creates new xSP plugin having the given UID.

    42     * @leave Uses Leave code KErrNotFound if implementation is not found.

    43     * @param aImplementationUid Implementation UID of the plugin to be

    44     *        created.

    45     */

    46     static CTelLoggingExtension* NewL(

    47         TUid aImplementationUid );

    48 

    49     /**

    50     * Destructor

    51     */

    52     virtual inline ~CTelLoggingExtension();

    53     

    54     /**

    55     * Initialize CTelLoggingExtension after it is created with NewL.

    56     * @param aServiceId - This id identify what service is currently used in call.

    57     * @param aOrigAddress - Original address.

    58     */

    59     virtual void InitializeL( TUint aServiceId, const TDesC& aOrigAddress ) = 0;

    60     

    61     /**

    62     * Gets phone number to be logged to Logs events phone number field.

    63     * Sets aPhoneNumber parameter as empty (KNullDesC) if valid phone number is not available.

    64     * Phone number have to be valid for GSM calls.

    65     * @param aPhoneNumber - Number to be logged to the log events phone number field.  

    66     * @return - Return KErrNone if operation succeed.

    67     */

    68     virtual TInt GetPhoneNumber( RBuf& aPhoneNumber ) = 0;

    69 

    70     /**

    71     * Gets VoIP address to be logged to Logs events VoIP address field.

    72     * Sets aVoipAddress parameter as empty (KNullDesC) if valid VoIP address is not available.

    73     * @param aVoipAddress - Address to be logged to the log events VoIP address field.  

    74     * @return - Return KErrNone if operation succeed.

    75     */

    76     virtual TInt GetVoipAddress( RBuf& aVoipAddress ) = 0;

    77     

    78     /**

    79     * Gets users own address for Logs application.

    80     * Sets aMyAddress parameter as empty (KNullDesC) if valid users own address is not available.

    81     * My address option will be visible in Logs when this parameter is available.

    82     * @param aMyAddress - Address to be shown by Logs application "Show my address"

    83     *                     option.  

    84     * @return - Return KErrNone if operation succeed.

    85     */

    86     virtual TInt GetMyAddress( RBuf& aMyAddress ) = 0;

    87     

    88     /**

    89     * Gets remote party name.

    90     * Remote party name (returned by plugin) will be shown on the logs event when contact 

    91     * matching not succeed nor call was not made as private/anonymous call (MT call, 

    92     * private address/number).

    93     * @param aRemotePartyName - Remote party name.

    94     * @return - Return KErrNone if operation succeed.

    95     */

    96     virtual TInt GetRemotePartyName( RBuf& aRemotePartyName ) = 0;

    97 

    98 

    99 private: // data

   100 

   101     /**

   102      * ECOM plugin instance UID.

   103      */

   104      TUid iDtor_ID_Key;

   105 

   106     };

   107 

   108 #include "telloggingextension.inl"

   109 

   110 #endif // TELLOGGINGEXTENSION_H

   111 

   112