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        : CSatNotifyGetInkey.h

    16 * Part of     : Common SIM ATK TSY / commonsimatktsy

    17 * Specific notifications class

    18 * Version     : 1.0

    19 *

    20 */

    21 

    22 

    23 

    24 #ifndef CSATNOTIFYGETINKEY_H

    25 #define CSATNOTIFYGETINKEY_H

    26 

    27 

    28 //  INCLUDES

    29 #include <etelsat.h>

    30 #include "MSatNotificationsBase.h"

    31 

    32 // FORWARD DECLARATIONS

    33 class CSatDataPackage;

    34 class CSatNotificationsTsy;

    35 

    36 /**

    37 * DESCRIPTION

    38 * SAT Get Inkey notification class.

    39 * Created when client requests to be notified when Get Inkey

    40 * command arrives from SIM.

    41 *

    42 * This command instructs the SAT to display text and expect the user

    43 * to enter a single character. Any response entered by the user shall

    44 * be passed transparently by the SAT to the SIM.

    45 * @lib Commonsimatktsy

    46 * @since 3.1

    47 */

    48 NONSHARABLE_CLASS ( CSatNotifyGetInkey ) : public CBase,

    49                            public MSatNotificationsBase

    50     {

    51     public:   // Constructors and destructor

    52         

    53         /**

    54         * Two-phased constructor.

    55         * @param aNotificationsTsy: Pointer to NotificationsTsy

    56         * return CSatNotifyGetInkey*: created object 

    57         */

    58         static CSatNotifyGetInkey* NewL( 

    59         	CSatNotificationsTsy* aNotificationsTsy );

    60 

    61         /**

    62         * C++ Destructor.

    63         */

    64         ~CSatNotifyGetInkey();

    65 

    66 	private:

    67 	

    68         /**

    69         * By default C++ constructor is private.

    70         * @param aNotificationsTsy: Pointer to NotificationsTsy

    71         * @return None

    72         */

    73         CSatNotifyGetInkey( CSatNotificationsTsy* aNotificationsTsy );

    74 

    75         /**

    76         * Class attributes are created in ConstructL. 

    77         * @param None

    78         * @return None

    79         */

    80         void ConstructL();

    81 

    82     public: // Functions from base classes

    83 

    84         /**

    85         * Get Inkey Notification request received from client

    86         * @param aTsyReqHandle: request handle from ETel

    87         * @param aPackage: Packed data

    88         * @return KErrNone

    89         */

    90         TInt Notify( const TTsyReqHandle aTsyReqHandle,

    91             const TDataPackage& aPackage );

    92 

    93         /**

    94         * Cancels notification request for GetInkey.

    95         * @param aReqHandle notify request handle

    96         * @return KErrNone

    97         */

    98         TInt CancelNotification( const TTsyReqHandle aReqHandle );

    99                  

   100         /**

   101         * Completes GetInkey message to client

   102         * @param aDataPackage: Packaged return data

   103         * @param aErrorCode: Possible error code

   104         * @return KErrNone/ KErrCorrupt

   105         */

   106         TInt CompleteNotifyL( CSatDataPackage* aDataPackage, TInt aErrorCode );

   107 

   108         /**

   109         * From CSatNotificationsBase handles Get Inkey terminal response 

   110         * coming from client.

   111         * @param aRsp: Response structure

   112         * @return KErrNone/ KErrCorrupt

   113         */

   114         TInt TerminalResponseL( TDes8* aRsp );

   115 

   116     public: // New methods 

   117     

   118         /**

   119         * Create notification specific terminal response data

   120         * @param aPCmdNumber: Proactive command number

   121         * @param aGeneralResult: Result of the proactive command

   122         * @param aAdditionalInfo: Additional info for terminal response

   123         * @param aDcs: Data Coding Scheme

   124         * @return Success/Failure value

   125         */

   126         TInt CreateTerminalRespL( TUint8 aPCmdNumber, TUint8 aGeneralResult,

   127            						 TDesC16& aAdditionalInfo, TUint8 aDcs = NULL );  

   128 

   129     private: // Data

   130 

   131         // Get inkey package store. Package allocated

   132         // in this class and received from ETel

   133         RSat::TGetInkeyV2Pckg* iGetInkeyV2Pckg;

   134         // Requested response format

   135         TUint8 iRequestedRspFormat;

   136         // Pointer to the notifications tsy class

   137         CSatNotificationsTsy* iNotificationsTsy;

   138     };

   139 

   140 

   141 #endif // CSATNOTIFYGETINKEY_H