backsteppingsrv/inc/bsclient.h
changeset 0 79c6a41cd166
equal deleted inserted replaced
-1:000000000000 0:79c6a41cd166
       
     1 /*
       
     2 * Copyright (c) 2007 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:  Client session for BS engine
       
    15  *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_CBSCLIENT_H
       
    20 #define C_CBSCLIENT_H
       
    21 
       
    22 #include <e32base.h>
       
    23 
       
    24 /**
       
    25  * Client-side interface to BS Engine
       
    26  *
       
    27  * This class provides the client-side interface to the BS server session,
       
    28  * it just passes requests to the server.
       
    29  *
       
    30  * @since S60 v3.2
       
    31  */
       
    32 class RBSClient : public RSessionBase
       
    33     {
       
    34 public:
       
    35 
       
    36     /**
       
    37      * Constructor.
       
    38      * @since S60 v3.2
       
    39      */
       
    40     RBSClient();
       
    41 
       
    42     /**
       
    43      * Connects to the server and create a session.
       
    44      * When the server is not running, the function starts the server.
       
    45      *
       
    46      * @since S60 v3.2
       
    47      * @return error code
       
    48      */
       
    49     TInt Connect();
       
    50 
       
    51     /**
       
    52      * Initialize session with given application UID.
       
    53      *
       
    54      * @since S60 v3.2
       
    55      * @return error code
       
    56      */
       
    57     TInt Initialize( TUid aApp );
       
    58 
       
    59     /**
       
    60      * Forwards activation event.
       
    61      *     
       
    62      * @since S60 v3.2
       
    63      * @param aState state of application like view ids
       
    64      * @param aIsItem indicate if it is item/exit activation
       
    65      * @return error code
       
    66      */
       
    67     TInt ForwardActivationEvent( const TDesC8& aState, TBool aIsItem );
       
    68 
       
    69     /**
       
    70      * Handle back command.
       
    71      *
       
    72      * @since S60 v3.2
       
    73      * @param aState state of application
       
    74      * @param aCheckOnly indicates if only checking should be done (no actual action)
       
    75      * @return error code
       
    76      */
       
    77     TInt HandleBackCommand( const TDesC8& aState, TBool aCheckOnly );
       
    78 
       
    79     /**
       
    80      * Returns the version number.
       
    81      *
       
    82      * @return the version
       
    83      */
       
    84     TVersion Version() const;
       
    85     };
       
    86 
       
    87 #endif // C_CBSCLIENT_H
       
    88 // End of File