|
1 /* |
|
2 * Copyright (c) 2007-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: |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef C_VOIPERRORENTRY_H |
|
21 #define C_VOIPERRORENTRY_H |
|
22 |
|
23 #include <e32base.h> |
|
24 |
|
25 /** |
|
26 * VoIP error entry. |
|
27 * Container class for VoIP error information |
|
28 * |
|
29 * @lib voipeventlog.lib |
|
30 * @since S60 V3.2 |
|
31 */ |
|
32 NONSHARABLE_CLASS( CVoipErrorEntry ): public CBase |
|
33 { |
|
34 |
|
35 public: // Constructors and destructor |
|
36 /** |
|
37 * Two-phased constructor. |
|
38 */ |
|
39 IMPORT_C static CVoipErrorEntry* NewL(); |
|
40 |
|
41 /** |
|
42 * Two-phased constructor. |
|
43 */ |
|
44 IMPORT_C static CVoipErrorEntry* NewLC(); |
|
45 |
|
46 /** |
|
47 * Two-phased constructor. |
|
48 */ |
|
49 IMPORT_C static CVoipErrorEntry* NewLC( TInt aErrorCode, const TDesC& aErrorText ); |
|
50 |
|
51 /** |
|
52 * Destructors. |
|
53 */ |
|
54 IMPORT_C virtual ~CVoipErrorEntry(); |
|
55 |
|
56 public: // Member functions |
|
57 |
|
58 /** |
|
59 * Returns error VoIP code. |
|
60 * |
|
61 * @since S60 V3.2 |
|
62 * @return error code of VoIP |
|
63 */ |
|
64 IMPORT_C TInt ErrorCode() const; |
|
65 |
|
66 /** |
|
67 * Sets VoIP error code. |
|
68 * |
|
69 * @since S60 V3.2 |
|
70 * @param aErrorCode VoIP error code |
|
71 */ |
|
72 IMPORT_C void SetErrorCode( TInt aErrorCode ); |
|
73 |
|
74 /** |
|
75 * Returns error text |
|
76 * |
|
77 * @since S60 V3.2 |
|
78 * @return error text |
|
79 */ |
|
80 IMPORT_C const TDesC& ErrorText() const; |
|
81 |
|
82 /** |
|
83 * Sets error text |
|
84 * |
|
85 * @since S60 V3.2 |
|
86 * @param aErrorText error text to be set |
|
87 */ |
|
88 IMPORT_C TInt SetErrorText( const TDesC& aErrorText ); |
|
89 |
|
90 /** |
|
91 * Returns time stamp |
|
92 * |
|
93 * @since S60 V3.2 |
|
94 * @return time stamp |
|
95 */ |
|
96 IMPORT_C const TDesC& TimeStamp() const; |
|
97 |
|
98 /** |
|
99 * Sets time stamp |
|
100 * this function is not exported, time stamp is set inside of |
|
101 * voipeventlog component |
|
102 * |
|
103 * @since S60 V3.2 |
|
104 * @param aTimeStamp time stamp to be set |
|
105 */ |
|
106 TInt SetTimeStamp( const TDesC& aTimeStamp ); |
|
107 |
|
108 |
|
109 private: |
|
110 |
|
111 /** |
|
112 * C++ default constructor. |
|
113 */ |
|
114 CVoipErrorEntry(); |
|
115 |
|
116 /** |
|
117 * By default Symbian 2nd phase constructor is private. |
|
118 */ |
|
119 void ConstructL(); |
|
120 |
|
121 private: // data |
|
122 |
|
123 /** |
|
124 * VoIP error code |
|
125 */ |
|
126 TInt iErrorCode; |
|
127 |
|
128 /** |
|
129 * VoIP error text |
|
130 */ |
|
131 RBuf iErrorText; |
|
132 |
|
133 /** |
|
134 * VoIP error stamp |
|
135 */ |
|
136 RBuf iTimeStamp; |
|
137 }; |
|
138 |
|
139 |
|
140 #endif // C_VOIPERRORENTRY_H |