|
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 instant messaging services (RImpsIMClient) |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef MCAIMPSIMCLIENT_H |
|
21 #define MCAIMPSIMCLIENT_H |
|
22 |
|
23 // INCLUDES |
|
24 #include "MCAImpsClient.h" |
|
25 #include <ImpsImCli.h> |
|
26 |
|
27 // CLASS DECLARATION |
|
28 |
|
29 /** |
|
30 * Interface for instant messaging services. |
|
31 * Same interface as RImpsImClient. |
|
32 * Comments are copied from RImpsImClient. |
|
33 * |
|
34 * @lib CAAdapter.dll |
|
35 * @since 3.0 |
|
36 */ |
|
37 class MCAImpsImClient : public MCAImpsClient |
|
38 { |
|
39 public: // New functions |
|
40 |
|
41 /** |
|
42 * @see RImpsImClient2 |
|
43 */ |
|
44 virtual void RegisterL( |
|
45 MImpsImHandler2* aImpsObserver, |
|
46 MImpsBlockingHandler2* aBlockingHandler, |
|
47 TUid aApplicationId, |
|
48 TInt aPriority = 0 ) = 0; |
|
49 |
|
50 /** |
|
51 * @see RImpsImClient2 |
|
52 */ |
|
53 virtual void Unregister() = 0; |
|
54 |
|
55 // MESSAGING |
|
56 |
|
57 /** |
|
58 * @see RImpsImClient2 |
|
59 */ |
|
60 // This is an adapter to IMPS Engine API, we cannot |
|
61 // influence the const descriptor pointer parameter passing |
|
62 // in the API. |
|
63 virtual TInt SendTextMessageL( const TDesC* aSenderSn, // CSI: 17 # See description |
|
64 const MDesCArray* aUserIds, |
|
65 const TDesC* aGroupId, // CSI: 17 # See description |
|
66 const MDesCArray* aScreenNames, |
|
67 const TDesC& aContent, |
|
68 TBool aDeliveryReportWanted ) = 0; |
|
69 |
|
70 /** |
|
71 * @see RImpsImClient2 |
|
72 */ |
|
73 // This is an adapter to IMPS Engine API, we cannot |
|
74 // influence the const descriptor pointer parameter passing |
|
75 // in the API. |
|
76 virtual TInt SendContentMessageL( const TDesC* aSenderSn, // CSI: 17 # See description |
|
77 const MDesCArray* aUserIds, |
|
78 const TDesC* aGroupId, // CSI: 17 # See description |
|
79 const MDesCArray* aScreenNames, |
|
80 const TDesC& aContentType, |
|
81 const TDesC8& aContent, |
|
82 TBool aDeliveryReportWanted ) = 0; |
|
83 |
|
84 |
|
85 /** |
|
86 * @see RImpsImClient2 |
|
87 */ |
|
88 virtual TInt BlockEntityRequestL( |
|
89 const CDesCArray* aBlockEntity, |
|
90 const CDesCArray* aUnBlockEntity, |
|
91 TBool aBlockedListInUse, |
|
92 const CDesCArray* aGrantedEntityList, |
|
93 const CDesCArray* aUnGrantEntity, |
|
94 TBool aGrantedListInUse ) = 0; |
|
95 |
|
96 /** |
|
97 * @see RImpsImClient2 |
|
98 */ |
|
99 virtual TInt GetBlockedListRequestL() = 0; |
|
100 |
|
101 /** |
|
102 * Returns actual WV Engine interface class pointer which is registered. |
|
103 * @since 3.0 |
|
104 * @return RImpsImClient pointer which is registered and can be used. |
|
105 * Ownership NOT transferred. |
|
106 */ |
|
107 virtual RImpsImClient2* InterfaceL() = 0; |
|
108 |
|
109 /** |
|
110 * Get the maximum TransactionContent size that WV engine |
|
111 * and WV server can handle, related to ParserSize. |
|
112 * Note that if service negotiation is not finished, this |
|
113 * method returns 0. |
|
114 * |
|
115 * @return size or zero |
|
116 * @since 3.0 |
|
117 */ |
|
118 virtual TInt MaxTransactionContentLengthL( ) = 0; |
|
119 |
|
120 protected: // New functions |
|
121 |
|
122 /** |
|
123 * Destructor. |
|
124 */ |
|
125 virtual ~MCAImpsImClient() { }; |
|
126 }; |
|
127 |
|
128 #endif // MCAIMPSIMCLIENT_H |
|
129 |
|
130 // End of File |