|
1 /* |
|
2 * Copyright (c) 2007-2009 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 definition for ESMR task factory |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef MESMRTASKEXTENSION_H |
|
20 #define MESMRTASKEXTENSION_H |
|
21 |
|
22 #include <e32base.h> |
|
23 //<cmail> |
|
24 #include "esmrdef.h" |
|
25 //</cmail> |
|
26 |
|
27 class MESMRMeetingRequestEntry; |
|
28 |
|
29 /** |
|
30 * MESMRTaskExtension is extension API for CMRUtils. |
|
31 * MESMRTaskExtension defines methods for executing ES MR MR related |
|
32 * functionality. |
|
33 * |
|
34 * Usage (assuming you have CMRUtils* iUtils): |
|
35 * MESMRTaskExtension* ext = ExtensionApiL<MESMRTaskExtension>( iUtils ); |
|
36 * |
|
37 * @lib esmrtasks.lib |
|
38 */ |
|
39 class MESMRTaskExtension |
|
40 { |
|
41 public: // Inline implementation |
|
42 /** |
|
43 * Fetches task extension uid. |
|
44 * @return task extension uid |
|
45 */ |
|
46 inline static TUid ExtensionUid(); |
|
47 |
|
48 public: // Destruction |
|
49 /** |
|
50 * Virtual C++ destructor. |
|
51 */ |
|
52 virtual ~MESMRTaskExtension() { } |
|
53 |
|
54 public: // Interface |
|
55 /** |
|
56 * Sends and stores MR response. Command needs to be one of the |
|
57 * following: |
|
58 * - EESMRCmdAcceptMR |
|
59 * - EESMRCmdTentativeMR |
|
60 * - EESMRCmdDeclineMR |
|
61 * |
|
62 * Phone owner's attendee status needs to match MR response command. |
|
63 * |
|
64 * @param aCommand Command to be executed |
|
65 * @param aEntry Reference to entry |
|
66 * @see TESMRCommand |
|
67 */ |
|
68 virtual void SendAndStoreResponseL( |
|
69 TESMRCommand aCommand, |
|
70 MESMRMeetingRequestEntry& aEntry ) = 0; |
|
71 |
|
72 /** |
|
73 * Sends and stores MR . Command needs to be one of the |
|
74 * following: |
|
75 * - EESMRCmdSendMR |
|
76 * - EESMRCmdSendMRUpdate |
|
77 * |
|
78 * Phone owner needs to be meeting organizer. |
|
79 * |
|
80 * @param aCommand Command to be executed |
|
81 * @param aEntry Reference to entry |
|
82 * @see TESMRCommand |
|
83 */ |
|
84 virtual void SendAndStoreMRL( |
|
85 TESMRCommand aCommand, |
|
86 MESMRMeetingRequestEntry& aEntry ) = 0; |
|
87 |
|
88 /** |
|
89 * Delete MR from local calendar DB. Command needs to be one of the |
|
90 * following: |
|
91 * - EESMRCmdDeleteMR |
|
92 * |
|
93 * @param aCommand Command to be executed |
|
94 * @param aEntry Reference to entry |
|
95 * @see TESMRCommand |
|
96 */ |
|
97 virtual void DeleteMRFromLocalDBL( |
|
98 TESMRCommand aCommand, |
|
99 MESMRMeetingRequestEntry& aEntry ) = 0; |
|
100 |
|
101 /** |
|
102 * Deletes MR from local calendar DB. Method also sends either cancellation |
|
103 * or decline message. |
|
104 * |
|
105 * Command needs to be one of the following: |
|
106 * - EESMRCmdDeleteMR |
|
107 * |
|
108 * @param aCommand Command to be executed |
|
109 * @param aEntry Reference to entry |
|
110 * @see TESMRCommand |
|
111 */ |
|
112 virtual void DeleteAndSendMRL( |
|
113 TESMRCommand aCommand, |
|
114 MESMRMeetingRequestEntry& aEntry ) = 0; |
|
115 |
|
116 /** |
|
117 * Stores MR to local calendar DB. |
|
118 * |
|
119 * Command needs to be one of the following: |
|
120 * - EESMRCmdSaveMR |
|
121 * |
|
122 * @param aCommand Command to be executed |
|
123 * @param aEntry Reference to entry |
|
124 * @see TESMRCommand |
|
125 */ |
|
126 virtual void StoreMRToLocalDBL( |
|
127 TESMRCommand aCommand, |
|
128 MESMRMeetingRequestEntry& aEntry ) = 0; |
|
129 |
|
130 /** |
|
131 * Forwards MR as email. Email editor is launched with pre-filled |
|
132 * email message. |
|
133 * |
|
134 * Command needs to be one of the following: |
|
135 * - EESMRCmdForwardAsMail |
|
136 * |
|
137 * @param aCommand Command to be executed |
|
138 * @param aEntry Reference to entry |
|
139 * @see TESMRCommand |
|
140 */ |
|
141 virtual void ForwardMRAsEmailL( |
|
142 TESMRCommand aCommand, |
|
143 MESMRMeetingRequestEntry& aEntry ) = 0; |
|
144 |
|
145 /** |
|
146 * Creates email reply for meeting request. |
|
147 * Email editor is launched with pre-filled |
|
148 * email message. |
|
149 * |
|
150 * Command needs to be one of the following: |
|
151 * - EESMRCmdReply or EESMRCmdReplyAll |
|
152 * |
|
153 * @param aCommand Command to be executed |
|
154 * @param aEntry Reference to entry |
|
155 * @see TESMRCommand |
|
156 */ |
|
157 virtual void ReplyAsEmailL( |
|
158 TESMRCommand aCommand, |
|
159 MESMRMeetingRequestEntry& aEntry ) = 0; |
|
160 }; |
|
161 |
|
162 #include "mesmrtaskextension.inl" |
|
163 |
|
164 #endif // MESMRTASKEXTENSION_H |