telephonyserverplugins/simatktsy/inc/MSatNotificationsBase.h
changeset 0 3553901f7fa8
equal deleted inserted replaced
-1:000000000000 0:3553901f7fa8
       
     1 /*
       
     2 * Copyright (c) 2005-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:
       
    15 * Name        : MSatNotificationsBase.h
       
    16 * Part of     : Common SIM ATK TSY / commonsimatktsy
       
    17 * Specific notifications classes
       
    18 * Version     : 1.0
       
    19 *
       
    20 */
       
    21 
       
    22 
       
    23 
       
    24 
       
    25 #ifndef MSATNOTIFICATIONSBASE_H
       
    26 #define MSATNOTIFICATIONSBASE_H
       
    27 
       
    28 
       
    29 //  INCLUDES
       
    30 #include <et_tsy.h>
       
    31 
       
    32 // CONSTANTS
       
    33     // None
       
    34 
       
    35 // MACROS
       
    36     // None
       
    37 
       
    38 // DATA TYPES
       
    39 	// None
       
    40 	
       
    41 // CONSTANTS
       
    42 	// None
       
    43 
       
    44 // FUNCTION PROTOTYPES
       
    45     // None
       
    46 
       
    47 // FORWARD DECLARATIONS
       
    48 class CSatDataPackage;
       
    49 
       
    50 // CLASS DECLARATION
       
    51     // The following classes are inherited from this class
       
    52     // CSatNotifyDisplayText, CSatNotifyGetInkey, CSatNotifyGetInput, 
       
    53     // CSatNotifyPlayTone, CSatNotifySetUpMenu, CSatNotifySelectItem, 
       
    54     // CSatNotifySendSm, CSatNotifySendSs, CSatNotifySendUssd, 
       
    55     // CSatNotifySetUpCall, CSatNotifyRefresh, CSatNotifySimSessionEnd, 
       
    56     // CSatNotifySetUpIdleModeText, CSatNotifyLaunchBrowser, 
       
    57     // CSatNotifyCallControlRequest, CSatNotifyPollInterval, CSatNotifySendDtmf,
       
    58     // CSatNotifySetUpEventList, CSatNotifyPollingOff, CSatNotifyLocalInfo, 
       
    59     // CSatNotifyTimerMgmt, CSatNotifyMoreTime, CSatNotifyLanguageNotification, 
       
    60     // CSatNotifyMoreTime, CSatNotifySendData, CSatNotifyReceiveData, 
       
    61     // CSatNotifyMoSmControlRequest, CSatNotifyGetChannelStatus, 
       
    62     // CSatNotifyOpenChannel, CSatNotifyCloseChannel
       
    63 	
       
    64 // DESCRIPTION
       
    65 // SAT notifications base class.
       
    66 // Pure virtual base class for SAT command notification classes.
       
    67 
       
    68 class MSatNotificationsBase 
       
    69     {
       
    70     
       
    71     public: // New functions
       
    72     
       
    73         /**
       
    74         * Pure virtual function for derived classes. Notification
       
    75         * request.
       
    76         * @param aTsyReqHandle: Request handle from ETel
       
    77         * @param aPackage: Packed data
       
    78         * @return KErrNone
       
    79         */        
       
    80         virtual TInt Notify( const TTsyReqHandle /*aTsyReqHandle*/,
       
    81             const TDataPackage& /*aPackage*/ )
       
    82 		    {
       
    83     		return KErrNotSupported;
       
    84     		}            
       
    85 
       
    86         /**
       
    87         * Pure virtual function for derived classes. Cancels notification 
       
    88         * request.
       
    89         * @param aReqHandle: Notify request handle
       
    90         * @return KErrNone
       
    91         */
       
    92         virtual TInt CancelNotification( const TTsyReqHandle /*aReqHandle*/ )
       
    93 		    {
       
    94     		return KErrNotSupported;
       
    95     		}  
       
    96     		
       
    97         /**
       
    98         * Pure virtual function for derived classes. Notification
       
    99         * completion method.
       
   100         * @param aDataPackage: Pointer to client parameter class
       
   101         * @param aErrorCode: status
       
   102         * @return KErrNone or status
       
   103         */
       
   104         virtual TInt CompleteNotifyL( CSatDataPackage* aDataPackage, 
       
   105             TInt aErrorCode ) = 0;         
       
   106 
       
   107         /**
       
   108         * Pure virtual function for derived classes. Handles the 
       
   109         * terminal response
       
   110         * @param aRsp: response structure
       
   111         * @return Success/Failure value
       
   112         */
       
   113         virtual TInt TerminalResponseL( TDes8* /*aRsp*/ )
       
   114 		    {
       
   115     		return KErrNotSupported;
       
   116     		}           
       
   117 
       
   118     };              
       
   119 
       
   120 #endif // MSATNOTIFICATIONSBASE_H