|
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: This file defines class MFSNotificationHandlerMgr. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef M_FSNOTIFICATIONHANDLERMGR_H |
|
21 #define M_FSNOTIFICATIONHANDLERMGR_H |
|
22 |
|
23 #include "fsmailserverconst.h" |
|
24 |
|
25 |
|
26 class CFSMailClient; |
|
27 class CFSNotificationHandlerHSConnection; |
|
28 class CFsEmailGlobalDialogsAppUi; |
|
29 |
|
30 /** |
|
31 * ?one_line_short_description |
|
32 * |
|
33 * ?more_complete_description |
|
34 * @code |
|
35 * ?good_class_usage_example(s) |
|
36 * @endcode |
|
37 * |
|
38 * @lib ?library |
|
39 * @since S60 ?S60_version *** for example, S60 v3.0 |
|
40 */ |
|
41 class MFSNotificationHandlerMgr |
|
42 { |
|
43 |
|
44 public: |
|
45 |
|
46 /** |
|
47 * Function that returns a reference to the mail client which |
|
48 * is used to access email framework. |
|
49 * |
|
50 * @since S60 ?S60_version |
|
51 * @return Pointer to framework object. |
|
52 */ |
|
53 virtual CFSMailClient& MailClient() const = 0; |
|
54 |
|
55 /** |
|
56 * Gets pointer to object that provides information |
|
57 * about the current Home Screen status. NULL is returned |
|
58 * if the software is not a preinstalled version. |
|
59 * |
|
60 * Ownership IS NOT transferred. |
|
61 * |
|
62 * Notice that UpdateStatusL() is called on the HS |
|
63 * connection object in case notification handler manager |
|
64 * has just received an event of type TFSEventNewMail from |
|
65 * FSEmailFramework. In that case it is not necessary |
|
66 * to update the status again. |
|
67 * |
|
68 * |
|
69 * @since S60 ?S60_version |
|
70 * @return Pointer to HS connection object. NULL if this |
|
71 * software is a postinstalled version. Ownership is |
|
72 * not transferred. |
|
73 */ |
|
74 virtual CFSNotificationHandlerHSConnection* HSConnection() const = 0; |
|
75 |
|
76 virtual void MessageQueryL( TDesC& aMailboxName, |
|
77 TRequestStatus& aStatus, |
|
78 const TDesC& aCustomMessageText, |
|
79 TFsEmailNotifierSystemMessageType aMessageType ) = 0; |
|
80 |
|
81 virtual TInt AuthenticateL( TDes& aPassword, |
|
82 TDesC& aMailboxName, |
|
83 TRequestStatus& aStatus ) = 0; |
|
84 |
|
85 /** |
|
86 * Gets cached folder type |
|
87 * @param TODO SK |
|
88 */ |
|
89 virtual TFSFolderType GetFolderTypeL( TFSMailMsgId& aMailbox, TFSMailMsgId* parentFolderId ) = 0; |
|
90 |
|
91 /** |
|
92 * Increases the active dialog count. |
|
93 */ |
|
94 virtual void IncreaseDialogCount() = 0; |
|
95 |
|
96 /** |
|
97 * Decreases the active dialog count. |
|
98 */ |
|
99 virtual void DecreaseDialogCount() = 0; |
|
100 |
|
101 /** |
|
102 * Gets the active dialog count. |
|
103 * |
|
104 * @return Number of active dialogs. |
|
105 */ |
|
106 virtual TInt GetDialogCount() = 0; |
|
107 |
|
108 //<cmail> |
|
109 /** |
|
110 * If AppUi pointer is available, send app ui to background |
|
111 * |
|
112 * @since S60 5.0 |
|
113 */ |
|
114 virtual void SendAppUiToBackground() = 0; |
|
115 |
|
116 /** |
|
117 * If AppUi pointer is available, bring app ui to foreground |
|
118 * |
|
119 * @since S60 5.0 |
|
120 */ |
|
121 virtual void BringAppUiToForeground() = 0; |
|
122 //</cmail> |
|
123 |
|
124 protected: |
|
125 }; |
|
126 |
|
127 |
|
128 #endif // M_FSNOTIFICATIONHANDLERMGR_H |