1 /*

     2 * Copyright (c) 2006 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 for Login,Logout

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef MCALOGINPC_H

    21 #define MCALOGINPC_H

    22 

    23 

    24 // INCLUDES

    25 #include <e32base.h>

    26 #include "PublicEngineDefinitions.h"

    27 #include "MCABackgroundTaskObserver.h"

    28 

    29 // FORWARD DECLARATION

    30 class CPEngNWSessionSlotID2;

    31 class CIMPSSAPSettings;

    32 class TPEngWVCspServicesTree2;

    33 class MCALoginRefreshObserverPC;

    34 

    35 // CLASS DECLARATION

    36 /**

    37 * MCALoginPC

    38 * Process Component Interface for Login,Logout

    39 * @lib wvuiprocessng.dll

    40 * @since 3.2

    41 */

    42 

    43 class MCALoginPC

    44     {

    45     public:

    46 

    47         /**

    48         * Does Login to IM Engine

    49         * @param aState - NetworkState login/logout

    50         * @param aSettings - pointer to SAP Settings

    51         * @param aSessionSlotID - Specifies the current session

    52         * @param aImpsServices - Reference to supported IMPS Services

    53         * @return true if logged in successfully else false

    54         */

    55         virtual TBool LoginL( TNetworkState aState, CIMPSSAPSettings* aSettings,

    56                               CPEngNWSessionSlotID2* aSessionSlotID, TPEngWVCspServicesTree2 &aImpsServices ) = 0;

    57 

    58         /**

    59          * Notifies the IM Engine about the Logged out state

    60          * @param aState - NetworkState login/logout

    61          * @param aSessionSlotID - Specifies the current session

    62          * @param aImpsServices - Reference to IMPS Services

    63          * @return true if notified successfully else false

    64          */

    65         virtual TBool NotifyEngineForLogoutL( TNetworkState aState,

    66                                               CPEngNWSessionSlotID2* aSessionSlotID, TPEngWVCspServicesTree2 &aImpsServices ) = 0;

    67 

    68         /**

    69          * Logout - Does Logout from IM Engine

    70          *

    71          */

    72         virtual void LogoutL() = 0;

    73 

    74         /**

    75          * ReadyForShutdown for engine

    76          * @return true if ready for shutdown

    77          */

    78         virtual TBool ReadyForShutdown() = 0;

    79 

    80         /**

    81          * Cancel All engine requests

    82          */

    83         virtual void CancelAllRequests() = 0;

    84 

    85 

    86         /**

    87          * Set the value to show nickname or not

    88          * @param aShowNickName 'Show nick name' -value

    89          */

    90         virtual void SetShowNicknameL( TBool aShowNickName ) = 0;

    91 

    92         /**

    93          * Set the alias

    94          * @param aAlias - Alias value to be set

    95          */

    96         virtual void SetAliasL( const TDesC& aAlias ) = 0;

    97 

    98         /**

    99          * Tells if Logged in with a different userid or not

   100          * @return ETrue if yes else EFalse.

   101          */

   102         virtual TBool FreshLoginL( ) = 0;

   103 

   104 

   105         /**

   106          * AddObserver method

   107          */

   108         virtual void AddObserver( MCALoginRefreshObserverPC *aObserver ) = 0;

   109 

   110         /**

   111          * RemoveObserver method

   112          */

   113         virtual void RemoveObserver() = 0;

   114 

   115 

   116 

   117         /**

   118         * RegisterBackGroundTaskObserver method

   119         */

   120         virtual void RegisterBackGroundTaskObserver( MCABackGroundTaskObserver *aObserver ) = 0;

   121 

   122         /**

   123         * UnRegisterBackGroundTaskObserver method

   124         */

   125         virtual void UnRegisterBackGroundTaskObserver( MCABackGroundTaskObserver *aObserver ) = 0;

   126 

   127         /**

   128          * To know whether Background task has started

   129          * @return TBool

   130          */

   131         virtual TBool IsBackgroundTaskPending()  = 0;

   132 

   133 

   134         /**

   135         * Performs the Network State Changes upon a slot

   136         *

   137         */

   138         virtual void PerformNetworkStateChangeL( TNetworkState aState,

   139                                                  CPEngNWSessionSlotID2* aSessionSlotID, TPEngWVCspServicesTree2 &aImpsServices ) = 0;

   140 

   141 

   142 

   143         /**

   144          * Destructor

   145          */

   146         virtual ~MCALoginPC() {};

   147 

   148 

   149     };

   150 

   151 

   152 #endif  // MCALOGINPC_H

   153 

   154 // End of File