|
1 /* |
|
2 * Copyright (c) 2006, 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: Presentity group handling interface for clients use. |
|
15 * |
|
16 */ |
|
17 |
|
18 #ifndef MyPresentityGroupsStub_H |
|
19 #define MyPresentityGroupsStub_H |
|
20 |
|
21 #include <e32std.h> |
|
22 #include <ximpbase.h> |
|
23 #include <presentitygroups.h> |
|
24 |
|
25 class MXIMPIdentity; |
|
26 |
|
27 |
|
28 /** |
|
29 * Presentity group handling interface for clients use. |
|
30 * Interface is implemented by the XIMP Framework. |
|
31 * |
|
32 * MPresentityGroups provides services for |
|
33 * XIMP Framework clients to manage presentity groups |
|
34 * and presentity group members. It provides also services |
|
35 * to subscribe notifications from presentity group list changes |
|
36 * and from individual presentity group changes. |
|
37 * |
|
38 * Client can retrieve MPresentityGroups interface from |
|
39 * MXIMPContext interface. |
|
40 * |
|
41 * @ingroup ximppresmanagementapi |
|
42 * @since S60 v3.2 |
|
43 */ |
|
44 class MyPresentityGroupsStub : public MPresentityGroups, public CBase |
|
45 { |
|
46 |
|
47 public: |
|
48 /** |
|
49 * Protected destructor. |
|
50 * Object instancies can't be deleted via this interface. |
|
51 */ |
|
52 ~MyPresentityGroupsStub(); |
|
53 |
|
54 |
|
55 /** |
|
56 * Subscribes presentity group list notifications. |
|
57 * |
|
58 * @return The request ID identifying the issued request. |
|
59 */ |
|
60 TXIMPRequestId SubscribePresentityGroupListL() ; |
|
61 |
|
62 |
|
63 |
|
64 /** |
|
65 * Unsubscribes presentity group list notifications. |
|
66 * |
|
67 * @return The request ID identifying the issued request. |
|
68 */ |
|
69 TXIMPRequestId UnsubscribePresentityGroupListL() ; |
|
70 |
|
71 |
|
72 |
|
73 /** |
|
74 * Creates presentity group. |
|
75 * |
|
76 * Note: Remote service may alter given presentity group ID and |
|
77 * display name. Altered ID and display names are signalled back |
|
78 * to client through MXIMPRequestCompleteEvent. |
|
79 * |
|
80 * @param [in] aGroupId |
|
81 * Identification for presentity group. |
|
82 * |
|
83 * @param [in] aDisplayName |
|
84 * Presentity group display name. |
|
85 * |
|
86 * |
|
87 * @return The request ID identifying the issued request. |
|
88 */ |
|
89 TXIMPRequestId CreatePresentityGroupL( |
|
90 const MXIMPIdentity& aGroupId, |
|
91 const TDesC16& aDisplayName ) ; |
|
92 |
|
93 |
|
94 /** |
|
95 * Deletes presentity group. |
|
96 * |
|
97 * @param [in] aGroupId |
|
98 * Identification for presentity group. |
|
99 * |
|
100 * @return The request ID identifying the issued request. |
|
101 */ |
|
102 TXIMPRequestId DeletePresentityGroupL( |
|
103 const MXIMPIdentity& aGroupId ) ; |
|
104 |
|
105 |
|
106 |
|
107 /** |
|
108 * Updates presentity group display name. |
|
109 * |
|
110 * Note: Remote service may alter given presentity group display name. |
|
111 * Altered display name is signalled back to client through |
|
112 * MXIMPRequestCompleteEvent. |
|
113 * |
|
114 * @param [in] aGroupId |
|
115 * Identification for presentity group. |
|
116 * |
|
117 * @param [in] aDisplayName |
|
118 * New display name for the presentity group. |
|
119 * |
|
120 * @return The request ID identifying the issued request. |
|
121 */ |
|
122 TXIMPRequestId UpdatePresentityGroupDisplayNameL( |
|
123 const MXIMPIdentity& aGroupId, |
|
124 const TDesC16& aDisplayName ) ; |
|
125 |
|
126 |
|
127 |
|
128 public: //Prototypes for presentity group member management requests |
|
129 |
|
130 |
|
131 /** |
|
132 * Subscribes presentity group content notifications. |
|
133 * |
|
134 * @param [in] aGroupId |
|
135 * Identification for presentity group for which |
|
136 * to subscribe content notifications. |
|
137 * |
|
138 * @return The request ID identifying the issued request. |
|
139 */ |
|
140 TXIMPRequestId SubscribePresentityGroupContentL( |
|
141 const MXIMPIdentity& aGroupId ) ; |
|
142 |
|
143 |
|
144 /** |
|
145 * Unsubscribes presentity group content notifications. |
|
146 * |
|
147 * @param [in] aGroupId |
|
148 * Identification for presentity group for which |
|
149 * content notification subscription to terminate. |
|
150 * |
|
151 * @return The request ID identifying the issued request. |
|
152 */ |
|
153 TXIMPRequestId UnsubscribePresentityGroupContentL( |
|
154 const MXIMPIdentity& aGroupId ) ; |
|
155 |
|
156 |
|
157 /** |
|
158 * Requests the protocol to add new member to |
|
159 * identified presentity group. |
|
160 * |
|
161 * |
|
162 * Note: Remote service may alter given member and |
|
163 * display name. Altered ID and display names |
|
164 * are signalled back to client through MXIMPRequestCompleteEvent. |
|
165 * |
|
166 * @param [in] aGroupId |
|
167 * Identification of the presentity group where to |
|
168 * add new member. |
|
169 * |
|
170 * @param [in] aMemberId |
|
171 * Identification of the new member. |
|
172 * |
|
173 * @param [in] aMemberDisplayName |
|
174 * Display name for the added member. |
|
175 * |
|
176 * @return The request ID identifying the issued request. |
|
177 */ |
|
178 TXIMPRequestId AddPresentityGroupMemberL( |
|
179 const MXIMPIdentity& aGroupId, |
|
180 const MXIMPIdentity& aMemberId, |
|
181 const TDesC16& aMemberDisplayName ) ; |
|
182 |
|
183 |
|
184 /** |
|
185 * Requests the XIMPFw to remove member from |
|
186 * identified presentity group. |
|
187 * |
|
188 * @param [in] aGroupId |
|
189 * Identification of the presentity group from |
|
190 * where to remove member. |
|
191 * |
|
192 * @param [in] aMemberId |
|
193 * Identification of the member to remove. |
|
194 * |
|
195 * @return The request ID identifying the issued request. |
|
196 */ |
|
197 TXIMPRequestId RemovePresentityGroupMemberL( |
|
198 const MXIMPIdentity& aGroupId, |
|
199 const MXIMPIdentity& aMemberId ) ; |
|
200 |
|
201 |
|
202 |
|
203 /** |
|
204 * Requests the XIMPFw to update presentity group |
|
205 * member display name. |
|
206 * |
|
207 * Note: Remote service may alter given presentity group member |
|
208 * display name. Altered display name is signalled back |
|
209 * to client through MXIMPRequestCompleteEvent. |
|
210 * |
|
211 * @param [in] aGroupId |
|
212 * Identification for presentity group. |
|
213 * |
|
214 * @param [in] aMemberId |
|
215 * Identification of the member which display |
|
216 * name to update. |
|
217 * |
|
218 * @param [in] aMemberDisplayName |
|
219 * New display name for the member. |
|
220 * |
|
221 * @return The request ID identifying the issued request. |
|
222 */ |
|
223 TXIMPRequestId UpdatePresentityGroupMemberDisplayNameL( |
|
224 const MXIMPIdentity& aGroupId, |
|
225 const MXIMPIdentity& aMemberId, |
|
226 const TDesC16& aMemberDisplayName ) ; |
|
227 |
|
228 const TAny* GetInterface( |
|
229 TInt32 aInterfaceId, |
|
230 TIfGetOps aOps ) const; |
|
231 |
|
232 TAny* GetInterface( |
|
233 TInt32 aInterfaceId, |
|
234 TIfGetOps aOps ); |
|
235 |
|
236 TInt32 GetInterfaceId() const; |
|
237 |
|
238 }; |
|
239 |
|
240 |
|
241 |
|
242 #endif // MyPresentityGroupsStub_H |
|
243 |
|
244 |
|
245 |