wvuing/wvuiprocess/Inc/MCAInvitationPC.h
changeset 0 094583676ce7
equal deleted inserted replaced
-1:000000000000 0:094583676ce7
       
     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 Process Manager
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MCAINVITATIONPC_H
       
    20 #define MCAINVITATIONPC_H
       
    21 
       
    22 //INCLUDES
       
    23 //Platform includes
       
    24 #include	"e32base.h"
       
    25 
       
    26 //FORWARD DECLARATION
       
    27 
       
    28 class MCAInvitationObserverPC;
       
    29 
       
    30 //CLASS DECLARATION
       
    31 
       
    32 class MCAInvitationPC
       
    33     {
       
    34 
       
    35     public:
       
    36 
       
    37         virtual void RegisterObserver( MCAInvitationObserverPC* aObserver ) = 0;
       
    38 
       
    39         virtual void UnRegisterObserver() = 0;
       
    40 
       
    41         /**
       
    42          * Gets the UserID of the give invitaton index
       
    43          * @param aIndex: invitation index
       
    44          */
       
    45         virtual const TDesC& InvitationUserIDL( TInt aIndex ) = 0;
       
    46 
       
    47         /**
       
    48          * Gets the time this invite was received
       
    49          * @param aIndex is the invitation index.
       
    50          * @since 3.2
       
    51          * @return Time and date of creation
       
    52          */
       
    53         virtual TTime ReceivedAt( TInt aIndex ) = 0;
       
    54 
       
    55         /**
       
    56          * Gets the invitation message.
       
    57          * @param aIndex is the invitation index.
       
    58          * @return Message.
       
    59          */
       
    60         virtual const TDesC& Message( TInt aIndex ) = 0;
       
    61 
       
    62         /**
       
    63          * Gets the group name.
       
    64          * @return Group name.
       
    65          */
       
    66         virtual const TDesC& GroupName( TInt aIndex ) = 0;
       
    67 
       
    68         /**
       
    69          * Sets the active invitation index
       
    70          */
       
    71         virtual void SetActiveInvitation( const TInt aIndex ) = 0;
       
    72 
       
    73         /**
       
    74          * Gets the active invitation index
       
    75          */
       
    76         virtual TInt GetActiveInvitationIndex( ) = 0;
       
    77 
       
    78         /**
       
    79          * checks if the given invitation is read or not
       
    80          * @returns ETrue if the invitation is read. Else EFalse.
       
    81          */
       
    82         virtual TBool IsInvitationUnread( TInt aIndex ) = 0;
       
    83 
       
    84         /**
       
    85          * Set invitation as read.
       
    86          * @param aIndex is the tabindex of
       
    87          * the current active invitation
       
    88          */
       
    89         virtual void SetInvitationAsReadL( TInt aIndex ) = 0;
       
    90 
       
    91         /**
       
    92          * Maps the given tabindex to invitationindex
       
    93          * in mainviewarraypc
       
    94          * @return invitationindex
       
    95          */
       
    96         virtual TInt GetInvitationIndex( TInt aTabIndex ) = 0;
       
    97 
       
    98 
       
    99 
       
   100         /**
       
   101          * Deletes the invitation
       
   102          * @param aInvitationIndex: index of the
       
   103          * invitation to be deleted
       
   104          */
       
   105         virtual void DeleteInvitationL( TInt aInvitationIndex ) = 0;
       
   106 
       
   107         /**
       
   108          * This is the reply to an invitation.
       
   109          * Note that invitation gets removed by this call, so do not try to use
       
   110          * it after calling this!!!
       
   111          * @param aInvitationIndex is the invitation index in teh array.
       
   112          * @param aInviteAccepted specifies if the invite was accepted or not.
       
   113          * @param aResponse is the response
       
   114          * @param aScreenName is our own screenname
       
   115          */
       
   116         virtual void ReplyInvitationL( TInt aInvitationIndex,
       
   117                                        const TBool aInviteAccepted,
       
   118                                        const TDesC& aResponse,
       
   119                                        const TDesC& aScreenName ) = 0;
       
   120 
       
   121         /**
       
   122         * Gets the buffer holding the reject reason
       
   123         * This is stored in the engine side because the last written
       
   124         * reason must be remembered
       
   125         * @return The buffer to reject reason, which can be modified
       
   126         */
       
   127         virtual HBufC* RejectReason() = 0;
       
   128 
       
   129         /**
       
   130          * Deletes the invitation at aIndex
       
   131          * @param aIndex Index of the invitation to be deleted
       
   132          */
       
   133         virtual void DeleteSingleListViewInvitationL( const TDesC& aInviteID/*TInt aIndex*/ ) = 0;
       
   134 
       
   135         /**
       
   136         * Finds an invitation
       
   137         * @param aWvId - contatc wv
       
   138         * @param aInviteTime - Invite Time
       
   139         * @return TInt - Index of the found invitation else -1
       
   140         */
       
   141         virtual TInt FindInvitationIndex( const TDesC& aWvId, TTime aInviteTime ) = 0 ;
       
   142 
       
   143 
       
   144         /**
       
   145         * Finds an invitation
       
   146         * @param aInviteId: id of the invitation
       
   147         * @return TInt - Index of the found invitation else -1
       
   148         */
       
   149         virtual TInt FindInvitationIndex( const TDesC& aInviteId ) = 0;
       
   150 
       
   151         /**
       
   152         * Unread Invites Counts
       
   153            * return no of unread inviation
       
   154         */
       
   155         virtual TInt UnreadInvitesCount() const = 0;
       
   156 
       
   157         /**
       
   158         * Unresd Invitation Info
       
   159            * return Invitation Id
       
   160         */
       
   161 
       
   162 
       
   163         virtual const TDesC& UnresdInvitationInfo() = 0 ;
       
   164 
       
   165         virtual const TDesC& GetInviteID( TInt aInvitationIndex ) = 0;
       
   166 
       
   167         /**
       
   168         * @param aIndex : invitation index
       
   169            * return identification of the sender of the invitation
       
   170         */
       
   171         virtual TPtrC InvUserIdentificationL( TInt aIndex ) = 0;
       
   172 
       
   173         /**
       
   174          * Destructor
       
   175          */
       
   176         virtual ~MCAInvitationPC() {};
       
   177 
       
   178     };
       
   179 
       
   180 #endif    //MCAINVITATIONPC_H
       
   181 
       
   182 //End of File