|
1 /* |
|
2 * Copyright (c) 2006 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 base class for contact identifier. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef CPHCNTCONTACTID_H |
|
20 #define CPHCNTCONTACTID_H |
|
21 |
|
22 #include <e32base.h> |
|
23 #include <cntdef.h> |
|
24 |
|
25 /** |
|
26 * Abstract base class for identifying a single contact |
|
27 * in contact stores. |
|
28 * |
|
29 * @lib PhoneCntFinder |
|
30 * @since S60 v3.1 |
|
31 */ |
|
32 class CPhCntContactId : public CBase |
|
33 { |
|
34 public: |
|
35 |
|
36 /** |
|
37 * Clones contact id. |
|
38 * |
|
39 * @since S60 v3.1 |
|
40 * @return New cloned instance of contact id. |
|
41 */ |
|
42 virtual CPhCntContactId* CloneL() const = 0; |
|
43 |
|
44 /** |
|
45 * Invalidates this contact id. After this call, |
|
46 * IsValid call will return false. |
|
47 * @since S60 v3.1 |
|
48 */ |
|
49 virtual void Invalidate() = 0; |
|
50 |
|
51 /** |
|
52 * Is contact id valid. |
|
53 * |
|
54 * @since S60 v3.1 |
|
55 * @return ETrue if contact id is valid. |
|
56 */ |
|
57 virtual TBool IsValid() const = 0; |
|
58 |
|
59 /** |
|
60 * Gives contact item id. If this id is not valid, then |
|
61 * contact item id given is not valid. |
|
62 * |
|
63 * @since S60 v3.1 |
|
64 * @return Contact item id. |
|
65 */ |
|
66 virtual TContactItemId ContactId() const = 0; |
|
67 |
|
68 /** |
|
69 * Packs Virtual phonebook contact link to descriptor. |
|
70 * If this link is not valid, then packed data is not valid. |
|
71 * |
|
72 * @since S60 v3.1 |
|
73 * @return Packed virtual phonebook contact link. |
|
74 */ |
|
75 virtual HBufC8* PackLC() const = 0; |
|
76 |
|
77 virtual ~CPhCntContactId() {}; |
|
78 }; |
|
79 |
|
80 #endif // CPHCNTCONTACTID_H |