|
1 /* |
|
2 * Copyright (c) 2005 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: Contains functions that are exported from AspSyncUtil for |
|
15 * performing data synchronization. |
|
16 * |
|
17 */ |
|
18 |
|
19 |
|
20 #ifndef ASPSYNCUTILAPI_H |
|
21 #define ASPSYNCUTILAPI_H |
|
22 |
|
23 |
|
24 // INCLUDES |
|
25 #include <e32base.h> |
|
26 #include <s32file.h> |
|
27 |
|
28 |
|
29 // FORWARD DECLARATIONS |
|
30 class CAspSyncUtil; |
|
31 |
|
32 |
|
33 |
|
34 // CLASS DECLARATION |
|
35 |
|
36 /** |
|
37 * Public API for executing sync ui library functions. |
|
38 * |
|
39 * @lib aspsyncutil.lib |
|
40 * @since Series60_3.0 |
|
41 * |
|
42 */ |
|
43 class CSyncUtilApi : public CBase |
|
44 { |
|
45 |
|
46 public: |
|
47 /** |
|
48 * Two-phased constructor. |
|
49 */ |
|
50 IMPORT_C static CSyncUtilApi* NewL(); |
|
51 |
|
52 /** |
|
53 * Destructor. |
|
54 */ |
|
55 virtual ~CSyncUtilApi(); |
|
56 |
|
57 private: |
|
58 /** |
|
59 * By default Symbian 2nd phase constructor is private. |
|
60 */ |
|
61 void ConstructL(); |
|
62 |
|
63 /** |
|
64 * C++ default constructor. |
|
65 */ |
|
66 CSyncUtilApi(); |
|
67 |
|
68 public: |
|
69 |
|
70 /** |
|
71 * Shows UI for editing data synchronization settings. |
|
72 * @since Series60_3.0 |
|
73 * @param aAppId Calling application id from AiwGenericParam.hrh. |
|
74 * @param aInfo1 Extra information, KErrNotFound if not used. |
|
75 * @param aInfo2 Extra information, KNullDesC if not used. |
|
76 * @return None. |
|
77 */ |
|
78 IMPORT_C void ShowSettingsL(TInt aAppId, TInt aInfo1, TDes& aInfo2); |
|
79 |
|
80 |
|
81 /** |
|
82 * Performs data synchronization. Creates necessary UI. |
|
83 * @since Series60_3.0 |
|
84 * @param aAppId Calling application id from AiwGenericParam.hrh. |
|
85 * @param aJobId Sync job id, KErrNotFound if not used. |
|
86 * @param aInfo1 Extra information, KErrNotFound if not used. |
|
87 * @param aInfo2 Extra information, KNullDesC if not used. |
|
88 * @return None. |
|
89 */ |
|
90 IMPORT_C void SynchronizeL(TInt aAppId, TInt aJobId, TInt aInfo1, TDes& aInfo2); |
|
91 |
|
92 |
|
93 /** |
|
94 * Performs automatic (scheduled) data synchronization. Does not create |
|
95 * any UI.Gets synchronization data from central repository. |
|
96 * @since Series60_3.0 |
|
97 * @param aScheduleTaskFile File that contains sync scheduling task. |
|
98 * @return None. |
|
99 */ |
|
100 IMPORT_C void SynchronizeL(RFile& aScheduleTaskFile); |
|
101 |
|
102 private: |
|
103 CAspSyncUtil* iSyncUtil; |
|
104 }; |
|
105 |
|
106 |
|
107 #endif // ASPSYNCUTILAPI_H |
|
108 |
|
109 |
|
110 // End of file |