|
1 /* |
|
2 * Copyright (c) 2007-2008 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: message handler interface |
|
15 * |
|
16 */ |
|
17 |
|
18 #ifndef MIMCVENGINEMESSAGEHANDLER_H |
|
19 #define MIMCVENGINEMESSAGEHANDLER_H |
|
20 |
|
21 // INCLUDES |
|
22 #include <e32def.h> |
|
23 #include "mimcvenginemessagehandlerobserver.h" |
|
24 // FORWARD CLASS DECLERATIONS |
|
25 class MIMCVEngineMessage; |
|
26 class MIMCVEngineMessageCreator; |
|
27 |
|
28 // CLASS DECLARATION |
|
29 |
|
30 /** |
|
31 * Observer interface to handle message container changes. |
|
32 * |
|
33 * @lib imcvengine.dll |
|
34 * @since 5.0 |
|
35 */ |
|
36 class MIMCVEngineMessageHandler |
|
37 { |
|
38 |
|
39 public: // Definitions |
|
40 |
|
41 /** |
|
42 * @see message creator class |
|
43 */ |
|
44 virtual MIMCVEngineMessageCreator& MessageCreator() const = 0 ; |
|
45 |
|
46 /** SendMessageL |
|
47 * api to send the message to below layer |
|
48 * @param aMessage, message to be send |
|
49 */ |
|
50 virtual void SendMessageL(MIMCVEngineMessage& aMessage) = 0 ; |
|
51 |
|
52 /** append to cache |
|
53 * api to send the message to below layer |
|
54 * @param aBuddyId, aBuddyId to be saved |
|
55 * @param aTextMessage, message to be saved |
|
56 */ |
|
57 virtual void AppendToCacheL(const TDesC& aBuddyId , const TDesC& aTextMessage ) = 0 ; |
|
58 |
|
59 |
|
60 /** |
|
61 * @see MIMCVEngineMessageHandler |
|
62 */ |
|
63 virtual void StartNewConversationL(const TDesC& aRecipientId )= 0; |
|
64 |
|
65 |
|
66 /** |
|
67 * @see MIMCVEngineMessageHandler |
|
68 */ |
|
69 virtual TInt CloseConversationL(const TDesC& aBuddyId) = 0 ; |
|
70 |
|
71 |
|
72 /** |
|
73 * @see MIMCVEngineMessageHandler |
|
74 */ |
|
75 virtual void CloseAllConversationL() = 0 ; |
|
76 |
|
77 |
|
78 /** |
|
79 * @see MIMCVEngineMessageHandler |
|
80 */ |
|
81 virtual TInt DeactivateConversationL() = 0; |
|
82 |
|
83 virtual void UnSubscribePresenceL(const TDesC& aRecipientId) = 0; |
|
84 /** |
|
85 * @see MIMCVEngineMessageHandler |
|
86 */ |
|
87 virtual void SubscribePresenceL(const TDesC& aWVID) = 0 ; |
|
88 |
|
89 /** |
|
90 * @see MIMCVEngineMessageHandler |
|
91 */ |
|
92 virtual void SetObserver( MIMCVEngineMessageHandlerObserver* aObserver ) = 0; |
|
93 |
|
94 /** |
|
95 * @see MIMCVEngineMessageHandler |
|
96 */ |
|
97 virtual void RemoveObserver() = 0; |
|
98 |
|
99 /** |
|
100 * @see MIMCVEngineMessageHandler |
|
101 */ |
|
102 virtual TIMCVOnlineStatus GetPresenceStatus() = 0 ; |
|
103 |
|
104 virtual TInt ServiceId() const = 0 ; |
|
105 |
|
106 public: // For protection. |
|
107 |
|
108 /** |
|
109 * Destructor for protection |
|
110 */ |
|
111 virtual ~MIMCVEngineMessageHandler(){} |
|
112 }; |
|
113 |
|
114 #endif // MIMCVENGINEMESSAGEHANDLER_H |
|
115 |
|
116 // End of File |