|
1 /* |
|
2 * Copyright (c) 2002 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: Abstract interface for fundamental services (RImpsFundClient) |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef MCAIMPSFUNDCLIENT_H |
|
21 #define MCAIMPSFUNDCLIENT_H |
|
22 |
|
23 // INCLUDES |
|
24 #include "MCAImpsClient.h" |
|
25 #include <ImpsFundCli.h> |
|
26 |
|
27 // CLASS DECLARATION |
|
28 |
|
29 /** |
|
30 * Interface class for Wireless Village fundamental services. |
|
31 * Same interface as RImpsFundClient. |
|
32 * Comments are copied from RImpsFundClient. |
|
33 * |
|
34 * @lib CAAdapter.dll |
|
35 * @since 1.2 |
|
36 */ |
|
37 class MCAImpsFundClient : public MCAImpsClient |
|
38 { |
|
39 public: // New functions |
|
40 |
|
41 // INITILIZATION AND CONNECT |
|
42 |
|
43 /** |
|
44 * Registers the listener objects for Fundamental events. |
|
45 * @since 1.2 |
|
46 * @param aSearchObs search result observer. May be NULL. |
|
47 * @param aInviteObs invite observer. May be NULL. Future option. |
|
48 * @param aPriority Observer priority. Refer to CActive priority. |
|
49 */ |
|
50 virtual void RegisterL( MImpsSearchHandler2* aSearchObs, |
|
51 MImpsInviteHandler2* aInviteObs, |
|
52 TInt aPriority = 0 ) = 0; |
|
53 |
|
54 /** |
|
55 * Unregisters the listener objects and disconnects from the server. |
|
56 * @since 1.2 |
|
57 */ |
|
58 virtual void Unregister() = 0; |
|
59 |
|
60 |
|
61 // Fundamental SERVICES |
|
62 |
|
63 /** |
|
64 * Start search |
|
65 * @since 1.2 |
|
66 * @param aPairs defines what is to be searched |
|
67 * @param aSearchLimit how many results you want |
|
68 * @return oparation-id (positive) |
|
69 */ |
|
70 virtual TInt SearchFirstL( const CSearchPairs& aPairs, |
|
71 TInt aSearchLimit ) = 0; |
|
72 |
|
73 /** |
|
74 * Continue search |
|
75 * @since 1.2 |
|
76 * @param aSearchID which search is to be continued |
|
77 * @param aIndex from which index the search is continued |
|
78 * @return oparation-id (positive) |
|
79 */ |
|
80 virtual TInt SearchNextL( TInt aSearchID, TInt aIndex ) = 0; |
|
81 |
|
82 |
|
83 /** |
|
84 * Stop search |
|
85 * @param aSearchID which search is to be continued |
|
86 * @since 1.2 |
|
87 * @return oparation-id (positive) |
|
88 */ |
|
89 virtual TInt StopSearchL( TInt aSearchID ) = 0; |
|
90 |
|
91 /** |
|
92 * Send group invite request |
|
93 * InviteGroupRequest |
|
94 * @since 1.2 |
|
95 * @param aInviteId Generated invite id |
|
96 * @param aUserId IDs of the users to be invited |
|
97 * @param aScreenName Screen names (<SName>) of the users to be invited |
|
98 * @param aGroupName The group (<GroupID>) in which the screen name is unique |
|
99 * @param aInviteGroup ID of the group to which the users are invited to join |
|
100 * @param aOwnScreenName Screen name of the inviter |
|
101 * @param aOwnGroupName Group name of the inviter |
|
102 * @param aInviteReason A short text describing the reason of the invite |
|
103 * @param aValidityPeriod How long the invitation is valid |
|
104 * @return oparation-id (positive) |
|
105 */ |
|
106 virtual TInt InviteGroupRequestL( const TDesC& aInviteId, |
|
107 const MDesCArray* aUserId, |
|
108 const MDesCArray* aScreenName, |
|
109 const MDesCArray* aGroupName, |
|
110 const TDesC& aInviteGroup, |
|
111 const TDesC& aOwnScreenName, |
|
112 const TDesC& aOwnGroupName, |
|
113 const TDesC& aInviteReason, |
|
114 const TInt aValidityPeriod ) = 0; |
|
115 |
|
116 /** |
|
117 * Cancel a group invite request |
|
118 * CancelGroupInviteRequest |
|
119 * @since 1.2 |
|
120 * @param aInviteId Invite to be cancelled |
|
121 * @param aUserId IDs of the users |
|
122 * @param aScreenName ID of the group (<GroupID>) in which the screen name is unique |
|
123 * @param aGroupName Name of the group |
|
124 * @param aCancelReason A short text describing the reason for the cancelling. |
|
125 * @param aOwnScreenName Screen name of the canceller |
|
126 * @param aOwnGroupName Group name of the canceller. |
|
127 * @return oparation-id (positive) |
|
128 */ |
|
129 virtual TInt CancelGroupInviteRequestL( const TDesC& aInviteId, |
|
130 const MDesCArray* aUserId, |
|
131 const MDesCArray* aScreenName, |
|
132 const MDesCArray* aGroupName, |
|
133 const TDesC& aCancelReason, |
|
134 const TDesC& aOwnScreenName, |
|
135 const TDesC& aOwnGroupName ) = 0; |
|
136 |
|
137 /** |
|
138 * Send response to invite |
|
139 * InviteUserResponse |
|
140 * @since 1.2 |
|
141 * @param aInviteId = ID of the invite response |
|
142 * @param aAcceptance = Do we meet the claim? |
|
143 * @param aInviteResponse = Textual description of the response |
|
144 * @param aOwnScreenName = Screen name of the responding user |
|
145 * @param aOwnGroupName = Group name of the responding user |
|
146 * @return oparation-id (positive) |
|
147 */ |
|
148 virtual TInt GroupInviteUserResponseL( const TDesC& aInviteId, |
|
149 TBool aAcceptance, |
|
150 const TDesC& aInviteResponse, |
|
151 const TDesC& aOwnScreenName, |
|
152 const TDesC& aOwnGroupName ) = 0; |
|
153 |
|
154 protected: // New functions |
|
155 |
|
156 /** |
|
157 * Destructor. |
|
158 */ |
|
159 virtual ~MCAImpsFundClient() { }; |
|
160 |
|
161 }; |
|
162 |
|
163 #endif // MCAIMPSFUNDCLIENT_H |
|
164 |
|
165 // End of File |