|
1 /* |
|
2 * Copyright (c) 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: |
|
15 * UI Extension API for Meeting Request Utils. |
|
16 * |
|
17 */ |
|
18 |
|
19 |
|
20 |
|
21 #ifndef MMRUTILSUISERVICES_H |
|
22 #define MMRUTILSUISERVICES_H |
|
23 |
|
24 // INCLUDES |
|
25 #include <e32def.h> |
|
26 #include <msvstd.h> |
|
27 #include <CMRUtils.h> |
|
28 #include <msvids.h> |
|
29 #include <CalUser.h> |
|
30 #include "CMRUtilsInternal.h" |
|
31 |
|
32 // FORWARD DECLARATIONS |
|
33 class CCalEntry; |
|
34 class CCalInstance; |
|
35 |
|
36 // CLASS DECLARATION |
|
37 |
|
38 /** |
|
39 * Extension API for CMRUtils. This extension contains UI functionality. |
|
40 */ |
|
41 class MMRUtilsUiServices |
|
42 { |
|
43 public: // Constructors and destructors |
|
44 |
|
45 /** |
|
46 * Destructor, allows deletion through this interface. |
|
47 */ |
|
48 virtual ~MMRUtilsUiServices() {}; |
|
49 |
|
50 public: // New functions |
|
51 |
|
52 /** |
|
53 * Allows user to set attendee statuses and optionally edit and send |
|
54 * response to aEntries. If array contains multiple entries, |
|
55 * the same response value and information is sent to all given entries. |
|
56 * Cancelled or outdated entries are omitted, and so are those that |
|
57 * don't contain phone user as attendee whose response is requested. |
|
58 * Return values that are used are: |
|
59 * KErrNone if attendee status of one or more entries was set |
|
60 * KErrArgument if couldn't find any valid entry to respond |
|
61 * KErrCancel if user cancels responding (after setting attendee status) |
|
62 * @param aEntries entries belonging to same recurring meeting |
|
63 * @param aResponse responding status |
|
64 * @param aMailbox mailbox to use for sending |
|
65 * @return KErrNone or a system wide error code |
|
66 */ |
|
67 virtual TInt RespondWithUiL( const RPointerArray<CCalEntry>& aEntries, |
|
68 CCalAttendee::TCalStatus aStatus, |
|
69 TMsvId aMailbox ) = 0; |
|
70 |
|
71 /** |
|
72 * Allows organizer cancel, and optionally to edit and send |
|
73 * cancellation of aEntries, i.e. recurring meeting or instance(s) of it. |
|
74 * Already cancelled, unsent or outdated entries are omitted, |
|
75 * and so are those attendees that have declined participation |
|
76 * to a particular entry. Return values that are used are: |
|
77 * KErrNone if one or more entries was cancelled |
|
78 * KErrArgument if couldn't find any valid entry to cancel |
|
79 * KErrCancel if user cancels sending (after canceling entry(s)) |
|
80 * @param aEntries entries belonging to same recurring meeting |
|
81 * @param aMailbox mailbox to use for sending |
|
82 * @return KErrNone or a system wide error code |
|
83 */ |
|
84 virtual TInt CancelWithUiL( |
|
85 const RPointerArray<CCalEntry>& aEntries, |
|
86 TMsvId aMailbox ) = 0; |
|
87 |
|
88 /** |
|
89 * Deletes given aEntries from the database and possibly allows |
|
90 * user to cancel meeting or decline participation, depending on |
|
91 * participation type. |
|
92 * This method will leave with KErrNotSupported if caller doesn't |
|
93 * have CEikonEnv available. |
|
94 * @param aEntry entry to be deleted |
|
95 * @param aMailbox mailbox to use for possible cancel/response |
|
96 * @return KErrNone or a system wide error code |
|
97 */ |
|
98 virtual TInt DeleteWithUiL( const CCalEntry& aEntry, |
|
99 TMsvId aMailbox ) = 0; |
|
100 |
|
101 /** |
|
102 * Deletes given instance from the database and possibly allows |
|
103 * user to cancel meeting or decline participation, depending on |
|
104 * participation type. |
|
105 * This method takes ownership of aInstance. |
|
106 * This method will leave with KErrNotSupported if caller doesn't |
|
107 * have CEikonEnv available. |
|
108 * @param aInstance instance to be deleted, ownership transferred |
|
109 * @param aMailbox mailbox to use for possible cancel/response |
|
110 * @return KErrNone or a system wide error code |
|
111 */ |
|
112 virtual TInt DeleteWithUiL( CCalInstance* aInstance, |
|
113 TMsvId aMailbox ) = 0; |
|
114 |
|
115 /** |
|
116 * Open SendUI editor for replying to the recipient(s) with an e-mail. |
|
117 * aSenderAddr is omitted if aRecipients does not contain MR sender. |
|
118 * @param aRecipients enumeration determining the recipients |
|
119 * @param aCalEntry entry to be used as a base for sending reply |
|
120 * @param aSenderAddr specifies the sender, if applicable |
|
121 * @param aMailbox mailbox to use for sending |
|
122 */ |
|
123 virtual void ReplyToL( CMRUtilsInternal::TMailRecipients aRecipients, |
|
124 const CCalEntry& aCalEntry, |
|
125 const TDesC& aSenderAddr, |
|
126 TMsvId aMailbox ) = 0; |
|
127 |
|
128 /** |
|
129 * Send given meeting request. Sending recipients are determined based |
|
130 * on the request type, e.g. request, respond, update etc. |
|
131 * This method does not involve an UI editor. |
|
132 * @param aCalEntry entry to be sent |
|
133 * @param aMailbox mailbox to use for sending |
|
134 */ |
|
135 virtual void SendL( const CCalEntry& aCalEntry, |
|
136 TMsvId aMailbox ) = 0; |
|
137 }; |
|
138 |
|
139 #endif // MMRUTILSUISERVICES_H |
|
140 |
|
141 // End of File |