1 /*

     2 * Copyright (c) 2002-2005 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:  Invitation handling interface for UI

    15 *

    16 */

    17 

    18 #ifndef MCAINVITEOBSERVER_H

    19 #define MCAINVITEOBSERVER_H

    20 

    21 // INCLUDES

    22 #include "MCAInvitation.h"

    23 

    24 #include <e32std.h>

    25 

    26 // CLASS DECLARATION

    27 

    28 /**

    29 *  Invitation handling interface for UI. Receiving of invites is serialized

    30 *  in engine, so client will receive only one invite per time through this

    31 *  interface. If engine receives several invites, it will cache those invites

    32 *  and call appropriate methods from this interface after client has returned

    33 *  control from HandleInvitation.

    34 *

    35 *

    36 *  @lib CAEngine.lib

    37 *  @since 1.2

    38 */

    39 class MCAInviteObserver

    40     {

    41     public:

    42         enum TInviteEventType

    43             {

    44             ENewInvite,

    45             EInviteExpired,

    46             EInviteCancel,

    47             EInviteRead

    48             };

    49 

    50         /**

    51          * Gets called when invite event occurs.

    52          * @param aEvent Type of event.

    53          * @param aInvitation specifies the invitation message.

    54          */

    55         virtual void HandleInvitationEventL( TInviteEventType aEvent,

    56                                              const MCAInvitation* aInvitation ) = 0;

    57 

    58         /**

    59          * Gets called when we received response to our invitation

    60          * @since 2.1

    61          * @param aAcceptance Accepted or rejected

    62          * @param aUserId User Id of the response sender

    63          * @param aGroupName group name

    64          * @param aResponse response text

    65          */

    66         virtual void HandleInvitationResponse( TBool aAcceptance,

    67                                                const TDesC& aUserId,

    68                                                const TDesC& aGroupName,

    69                                                const TDesC& aResponse ) = 0;

    70     protected:

    71 

    72         /**

    73         * Destructor.

    74         */

    75         virtual ~MCAInviteObserver() {};

    76     };

    77 

    78 #endif      // MCAINVITEOBSERVER_H

    79 

    80 // End of File