imstutils/imconversationview/imcvuiengine/inc/mimcvenginecchhandler.h
branchRCL_3
changeset 28 3104fc151679
parent 27 2b7283837edb
child 29 9a48e301e94b
equal deleted inserted replaced
27:2b7283837edb 28:3104fc151679
     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:  M-Class handling the use of Cch
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef     M_CIMCVENGINECCHHANDLER_H
       
    20 #define     M_CIMCVENGINECCHHANDLER_H
       
    21 
       
    22 // INCLUDES
       
    23 #include <e32base.h>
       
    24 #include <cch.h>
       
    25 
       
    26 
       
    27 // CLASS DECLARATION
       
    28 /**
       
    29  *  CCH handler
       
    30  *  This class implements the handling of CCH
       
    31  *
       
    32  *  @lib imcvengine.lib
       
    33  *  @since S60 5.0
       
    34  */ 
       
    35 
       
    36  
       
    37 NONSHARABLE_CLASS( MIMCVEngineCchHandler ) 
       
    38     {
       
    39     public:
       
    40 
       
    41         
       
    42         /**
       
    43          * Standard C++ destructor
       
    44          */    
       
    45         virtual ~MIMCVEngineCchHandler()
       
    46         {
       
    47         	
       
    48         }
       
    49         
       
    50         /**
       
    51          * Gets service state
       
    52          *
       
    53          * @since S60 5.0         
       
    54          * @param aCCHState service state (result)
       
    55          * @return TInt Standard Symbian error code
       
    56          */         
       
    57          virtual TInt GetServiceState( 
       
    58 									TCCHSubserviceState& aCCHState
       
    59 									) = 0;
       
    60 
       
    61         /**
       
    62          * Enables service
       
    63          *
       
    64          * @since S60 5.0         
       
    65          * @return TInt, error code
       
    66          */
       
    67         virtual TInt EnableService() = 0;
       
    68             
       
    69         
       
    70         /**
       
    71          * Returns the User Id for this service
       
    72          * Returns HbufC* and the caller of this function should deallocate the same
       
    73          * @since S60 5.0         
       
    74          * @return HBufC*
       
    75          */
       
    76         virtual HBufC* GetUserIdL() = 0 ; 
       
    77         
       
    78         /**
       
    79          * Returns the XimpFw Protocol UID for this service
       
    80          * Returns TInt 
       
    81          * @since S60 5.0         
       
    82          * @return TInt , error code
       
    83          */
       
    84         virtual TInt GetAdapterUidL()= 0 ; 
       
    85         /**
       
    86          * Disables service
       
    87          *
       
    88          * @since S60 5.0         
       
    89          * @return TInt, error code
       
    90          */
       
    91         virtual TInt DisableService() = 0;  
       
    92         
       
    93        
       
    94        	/**
       
    95          * IsServiceLoggedIn
       
    96          *
       
    97          * @since S60 5.0         
       
    98          * 
       
    99          * @return ETrue - if Service Logged In, EFalse - Service Not Logged In
       
   100          */         
       
   101          virtual TBool IsServiceLoggedIn() = 0;
       
   102               
       
   103     };
       
   104 
       
   105 #endif // M_CIMCVENGINECCHHANDLER_H
       
   106 
       
   107 // End of file