1 /*

     2 * Copyright (c) 2006, 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:  Interface for protocol request completion event.

    15 *

    16 */

    17 

    18 #ifndef MXIMPFWPROTOCOLREQUESTCOMPLETEEVENT_H

    19 #define MXIMPFWPROTOCOLREQUESTCOMPLETEEVENT_H

    20 

    21 #include <e32std.h>

    22 #include <ximpbase.h>

    23 #include <ximpprotocolpluginhostifids.hrh>

    24 

    25 

    26 

    27 /**

    28  * Interface for protocol request completion event.

    29  * This interface is implemented by XIMP Framework.

    30  *

    31  * This event is signalled from XIMP Framework to

    32  * protocol adaptation to inform protocol implementation

    33  * about its request completion (succesfully or otherwise).

    34  *

    35  * @ingroup ximpprotocolpluginhostapi

    36  * @since S60 v3.2

    37  */

    38 class MXIMPProtocolRequestCompleteEvent : public MXIMPBase

    39     {

    40 public:

    41 

    42     /** Interface ID for the MXIMPProtocolRequestCompleteEvent. */

    43     enum { KInterfaceId = XIMP_IF_ID_PROTOCOL_REQUEST_COMPLETE_EVENT };

    44 

    45 

    46 protected:

    47 

    48     /**

    49      * Protected destructor.

    50      * Event objects can't be deleted via this interface.

    51      */

    52     virtual ~MXIMPProtocolRequestCompleteEvent() {}

    53 

    54 

    55 public:

    56 

    57 

    58     /**

    59      * Gets request id of the completed request.

    60      *

    61      * @return The request id.

    62      */

    63     virtual const TXIMPRequestId& RequestId() const = 0;

    64 

    65 

    66     /**

    67      * Gets request completion code.

    68      *

    69      * Result code can be:

    70      *  - one of the system wide errors

    71      *  - one of the XIMP specific errors defined in ximperrors.hrh and 

    72      *    in presenceerrors.hrh

    73      *

    74      * @return The result code.

    75      */

    76     virtual TInt ResultCode() const = 0;

    77 

    78 

    79     };

    80 

    81 

    82 #endif // MXIMPFWPROTOCOLREQUESTCOMPLETEEVENT_H

    83 

    84 

    85