|
1 /* |
|
2 * Copyright (c) 2009 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: External, CVoiceMailboxEntry |
|
15 * |
|
16 */ |
|
17 |
|
18 #ifndef C_VOICEMAILBOXENTRY_H |
|
19 #define C_VOICEMAILBOXENTRY_H |
|
20 |
|
21 #include <e32base.h> |
|
22 #include <voicemailboxdefs.h> |
|
23 |
|
24 /** |
|
25 * Container class for Voice Mailbox info. |
|
26 * @lib vmbxengine.lib |
|
27 * @since S60 v5.2 |
|
28 */ |
|
29 |
|
30 class CVoiceMailboxEntry : public CBase |
|
31 { |
|
32 public: |
|
33 |
|
34 /** |
|
35 * Static constructor. |
|
36 * @return New instance of the object. Ownership transferred. |
|
37 */ |
|
38 IMPORT_C static CVoiceMailboxEntry* NewL(); |
|
39 |
|
40 /** |
|
41 * Static constructor. |
|
42 * @return New instance of the object. Ownership transferred. |
|
43 */ |
|
44 IMPORT_C static CVoiceMailboxEntry* NewLC(); |
|
45 |
|
46 /** |
|
47 * Destructor |
|
48 * @since S60 v5.2 |
|
49 * |
|
50 */ |
|
51 virtual ~CVoiceMailboxEntry(); |
|
52 |
|
53 /** |
|
54 * Gets the Voice Mailbox service. |
|
55 * |
|
56 * @since S60 v5.2 |
|
57 * @return Mailbox service. |
|
58 */ |
|
59 IMPORT_C virtual TServiceId ServiceId() const; |
|
60 |
|
61 /** |
|
62 * Sets the Voice Mailbox service to container. |
|
63 * |
|
64 * @since S60 v5.2 |
|
65 * @param in aVmbxServiceId Voice Mailbox service. |
|
66 */ |
|
67 virtual void SetServiceId( |
|
68 const TServiceId& aVmbxServiceId ); |
|
69 |
|
70 /** |
|
71 * Gets the Voice Mailbox type. |
|
72 * |
|
73 * @since S60 v5.2 |
|
74 * @return Mailbox type. |
|
75 */ |
|
76 IMPORT_C virtual TVmbxType VoiceMailboxType() const; |
|
77 |
|
78 /** |
|
79 * Sets the Voice Mailbox type to container. |
|
80 * |
|
81 * @since S60 v5.2 |
|
82 * @param in aVmbxType Voice Mailbox type. |
|
83 */ |
|
84 IMPORT_C virtual void SetVoiceMailboxType( |
|
85 const TVmbxType& aVmbxType ); |
|
86 |
|
87 /** |
|
88 * Gets the Voice Mailbox line type. |
|
89 * |
|
90 * @since S60 v5.2 |
|
91 * @return Mailbox line type. |
|
92 * EVmbxAlsLineDefault is returned if mailbox does not |
|
93 * support several lines. |
|
94 */ |
|
95 IMPORT_C virtual TVmbxAlsLineType VmbxAlsLineType() const; |
|
96 |
|
97 /** |
|
98 * Sets the Voice Mailbox line type to container. |
|
99 * EVmbxAlsLineDefault is used by default. |
|
100 * |
|
101 * @since S60 v5.2 |
|
102 * @param in aLine Selected Voice Mailbox line type. |
|
103 */ |
|
104 virtual void SetVmbxAlsLineType( |
|
105 const TVmbxAlsLineType& aLine ); |
|
106 |
|
107 /** |
|
108 * Gets the Voice Mailbox number or address. |
|
109 * |
|
110 * @since S60 v5.2 |
|
111 * @param out aVmbxNumber If successful, contains the returned |
|
112 * mailbox number or address. |
|
113 * @return One of the system wide error codes. |
|
114 */ |
|
115 IMPORT_C virtual TInt GetVmbxNumber( TPtrC& aVmbxNumber ) const; |
|
116 |
|
117 /** |
|
118 * Sets the Voice Mailbox number or address to container. |
|
119 * |
|
120 * @since S60 v5.2 |
|
121 * @param in aVmbxNumber New Voice Mailbox number or address. |
|
122 * @return One of the system wide error codes. |
|
123 */ |
|
124 IMPORT_C virtual TInt SetVmbxNumber( const TDesC& aVmbxNumber ); |
|
125 |
|
126 /** |
|
127 * Gets the Voice Mailbox brand id. |
|
128 * |
|
129 * @since S60 v5.2 |
|
130 * @param out aBrandId If successful, contains the returned Brand id. |
|
131 * @return One of the system wide error codes. |
|
132 */ |
|
133 IMPORT_C virtual TInt GetBrandId( TPtrC8& aBrandId ) const; |
|
134 |
|
135 /** |
|
136 * Sets the Voice Mailbox Brand Id to container. |
|
137 * |
|
138 * @since S60 v5.2 |
|
139 * @param in aBrandId New Brand Id. |
|
140 * @return One of the system wide error codes. |
|
141 */ |
|
142 virtual TInt SetBrandId( |
|
143 const TDesC8& aBrandId ); |
|
144 |
|
145 /** |
|
146 * Gets the VoIp name. |
|
147 * |
|
148 * @since S60 v5.2 |
|
149 * @param out aVmbxName If successful, contains the returned mailbox name. |
|
150 * @return One of the system wide error codes. |
|
151 */ |
|
152 IMPORT_C virtual TInt GetVmbxName( TPtrC& aVmbxName ) const; |
|
153 |
|
154 /** |
|
155 * Sets the VoIp name to container. |
|
156 * |
|
157 * @since S60 v5.2 |
|
158 * @param in aVmbxName New Voice Mailbox name. |
|
159 * @return One of the system wide error codes. |
|
160 */ |
|
161 IMPORT_C virtual TInt SetVmbxName( const TDesC& aVmbxName ); |
|
162 |
|
163 /** |
|
164 * Gets the type of memory location. |
|
165 * |
|
166 * @since S60 v5.2 |
|
167 * @return Memory location type. |
|
168 */ |
|
169 IMPORT_C virtual TVmbxMemoryLocation UsingMemoryLocation( ) const; |
|
170 |
|
171 /** |
|
172 * Resets the container to initial state. |
|
173 * |
|
174 * @since S60 v5.2 |
|
175 */ |
|
176 IMPORT_C virtual void Reset(); |
|
177 |
|
178 /** |
|
179 * Sets the using memory location to entry. |
|
180 * |
|
181 * @since S60 v5.2 |
|
182 * @param in aType Memory location type. |
|
183 */ |
|
184 virtual void SetUsingMemoryLocation( |
|
185 const TVmbxMemoryLocation& aType ); |
|
186 |
|
187 protected: |
|
188 |
|
189 /** |
|
190 * Second phase constructor. |
|
191 * |
|
192 * @since S60 v5.2 |
|
193 */ |
|
194 void ConstructL(); |
|
195 |
|
196 private: |
|
197 |
|
198 /** |
|
199 * Default constructor. |
|
200 * |
|
201 * @since S60 v5.2 |
|
202 */ |
|
203 |
|
204 CVoiceMailboxEntry(); |
|
205 |
|
206 private: // data |
|
207 |
|
208 /** |
|
209 * Mailbox service id. |
|
210 */ |
|
211 TServiceId iVmbxServiceId; |
|
212 |
|
213 /** |
|
214 * Mailbox type. |
|
215 */ |
|
216 TVmbxType iVmbxType; |
|
217 |
|
218 /** |
|
219 * Mailbox als line type. |
|
220 */ |
|
221 TVmbxAlsLineType iVmbxLineType; |
|
222 |
|
223 /** |
|
224 * Number of vmbx. |
|
225 * Own. |
|
226 */ |
|
227 HBufC* ivmbxNumber; |
|
228 |
|
229 /** |
|
230 * Brand id of vmbx. |
|
231 * Own. |
|
232 */ |
|
233 HBufC8* iVmbxBrandId; |
|
234 |
|
235 /** |
|
236 * Name of vmbx. |
|
237 * Own. |
|
238 */ |
|
239 HBufC* ivmbxName; |
|
240 |
|
241 /** |
|
242 * Mailbox Memory location. |
|
243 */ |
|
244 TVmbxMemoryLocation iUsingMemory; |
|
245 |
|
246 }; |
|
247 |
|
248 #endif // C_VOICEMAILBOXENTRY_H |