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:  Event interface for invitation content.

    15 *

    16 */

    17 

    18 #ifndef MIMINVITATIONEVENT_H

    19 #define MIMINVITATIONEVENT_H

    20 

    21 #include <e32std.h>

    22 #include <ximpbase.h>

    23 #include <immanagementifids.hrh>

    24 

    25 

    26 class MXIMPIdentity;

    27 class MImInvitationInfo;

    28 class MImDataSubscriptionState;

    29 

    30 

    31 /**

    32  * Event interface for invitation content.

    33  *

    34  * This interface is implemented by the IM and

    35  * event object is signalled to registered client observers

    36  * through MImContextObserver observer interface.

    37  * This event notifies clients about changes in

    38  * invitation content.

    39  *

    40  * IM signals this event when:

    41  * - New invitation for group is received from protocol.

    42  * - New invitation for conversation is received from protocol.

    43  * - Invitation response for group is received

    44  * - Invitation response for conversation is received

    45  * @ininvitation immanagementapievents

    46  * 

    47  */

    48 class MImInvitationEvent : public MXIMPBase

    49     {

    50 public:

    51     /** Interface ID for the MImInvitationEvent. */

    52     enum { KInterfaceId = IM_IF_ID_INVITATION_EVENT };

    53 

    54 

    55 

    56 protected:

    57 

    58     /**

    59      * Protected destructor.

    60      * Object instancies can't be deleted via this interface.

    61      */

    62     virtual ~MImInvitationEvent() {}

    63 

    64 

    65 public: // Access to "current information"

    66 

    67 

    68     /**

    69      * Gets count of invitations.

    70      *

    71      * @return The count of invitations.

    72      */

    73     virtual TInt InvitationCount() const = 0;

    74 

    75 

    76     /**

    77      * Gets invitation response by index.

    78      *

    79      * @param [in] aIndex

    80      *        The index of the invitation entry to get.

    81      *

    82      * @return The invitation response from given index.

    83      */

    84     virtual const MImInvitationInfo& InvitationResponse(

    85                 TInt aIndex ) const = 0;

    86 

    87 

    88 

    89 

    90 

    91 public: // Access to subscription state

    92 

    93 

    94     /**

    95      * Returns subscription state object holding

    96      * information about data items data subscription state.

    97      *

    98      * @return The data items data subscription state.

    99      *         Object ownership is not returned.

   100      */

   101     virtual const MImDataSubscriptionState& DataSubscriptionState() const = 0;

   102 

   103 

   104     };

   105 

   106 

   107 #endif // MIMINVITATIONEVENT_H

   108 

   109 

   110