summaryrefslogtreecommitdiff
path: root/include/service-engine/se_account.h
blob: bae30a255dd0a192861f8c636126d32598e08eca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
/*
 * oma-ds-agent
 * Copyright (c) 2012 Samsung Electronics Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the License);
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 *   @SE_Account.h
 *   @version									0.1
 *   @brief										This file is the header file of interface of account
 */

#ifndef SE_ACCOUNT_H_
#define SE_ACCOUNT_H_

#include <glib.h>
#include <stdbool.h>
#include "common/common_define.h"

/**
 * @par Description: API to add profile API
 * This API can be used to add profile
 * This API is part of API for UI
 *
 * @par Purpose:
 * @par Typical use case:
 * @par Method of function operation:
 * @par Important notes:
 * @param[in]		string type, profile_dir_name(identify profile in UI)
 * @param[in]		string type, profile name
 * @param[in]		string type, server ip
 * @param[in]		string type, id
 * @param[in]		string type, password
 * @param[in]		int type, sync mode
 * @param[in]		int type, sync type
 * @param[in]		int type, interval(for periodic)
 * @param[in]		GList type, list of sync_service_s structure
 * @param[out]		int type, account id
 *
 * @return				true on success
 *							false on error
 *
 * @par Errors:
 *
 * @pre None.
 * @post
 * @see
 * @remarks None.
 *
 * @par Sample Code:
 * @code
 * @endcode
 */
bool add_profile(char *profile_name, char *addr, char *id, char *password, int sync_mode, int sync_type, int interval, GList * categories, int *account_id);

/**
 * @par Description: API to add profile from csc
 * This API can be used to add profile from csc(vconf)
 *
 * @par Purpose:
 * @par Typical use case:
 * @par Method of function operation:
 * @par Important notes:
 * @param[in]		int type, index of profile
 *
 * @return				1 on success
 *							0 on error
 *
 * @par Errors:
 *
 * @pre None.
 * @post
 * @see
 * @remarks None.
 *
 * @par Sample Code:
 * @code
 * @endcode
 */
bool add_profile_csc(int index);

/**
 * @par Description: API to add profile API
 * This API can be used to add profile
 * This API is part of API for UI
 *
 * @par Purpose:
 * @par Typical use case:
 * @par Method of function operation:
 * @par Important notes:
 * @param[in]		string type, profile name
 * @param[in]		string type, server ip
 * @param[in]		string type, id
 * @param[in]		string type, password
 * @param[in]		GList type, list of resource_cp structure
 * @param[out]		int type, account id
 *
 * @return				true on success
 *							false on error
 *
 * @par Errors:
 *
 * @pre None.
 * @post
 * @see
 * @remarks None.
 *
 * @par Sample Code:
 * @code
 * @endcode
 */
bool add_profile_cp(char *profile_name, char *addr, char *id, char *password, GList * categories, int *account_id);

/**
 * @par Description: API to add profile for call log sync
 * This API can be used to add profile
 * This API is part of API for call log sync
 *
 * @par Purpose:
 * @par Typical use case:
 * @par Method of function operation:
 * @par Important notes:
 * @param[out]		int type, account_id
 *
 * @return				true on success
 *							false on error
 *
 * @par Errors:
 *
 * @pre None.
 * @post
 * @see
 * @remarks None.
 *
 * @par Sample Code:
 * @code
 * @endcode
 */
bool add_profile_dive(int *account_id);

/**
 * @par Description: API to edit profile API
 * This API can be used to edit profile
 * This API is part of API for UI
 *
 * @par Purpose:
 * @par Typical use case:
 * @par Method of function operation:
 * @par Important notes:
 * @param[in]		int type, account id
 * @param[in]		string type, profile name
 * @param[in]		string type, server ip
 * @param[in]		string type, id
 * @param[in]		string type, password
 * @param[in]		int type, sync mode
 * @param[in]		int type, sync type
 * @param[in]		int type, interval(for periodic)
 * @param[in]		GList type, list of sync_service_s structure
 *
 * @return				true on success
 *							false on error
 *
 * @par Errors:
 *
 * @pre None.
 * @post
 * @see
 * @remarks None.
 *
 * @par Sample Code:
 * @code
 * @endcode
 */
bool edit_profile(int account_id, char *profile_name, char *addr, char *id, char *password, int sync_mode, int sync_type, int interval, GList * categories);

/**
 * @par Description: API to delete profile API
 * This API can be used to delete profile
 * This API is part of API for UI
 *
 * @par Purpose:
 * @par Typical use case:
 * @par Method of function operation:
 * @par Important notes:
 * @param[in]		GList type, list of account id
 *
 * @return				true on success
 *							false on error
 *
 * @par Errors:
 *
 * @pre None.
 * @post
 * @see
 * @remarks None.
 *
 * @par Sample Code:
 * @code
 * @endcode
 */
bool delete_profiles(GList * profiles);

/**
 * @par Description: API to delete profile for call log sync
 * This API can be used to delete profile
 * This API is part of API for call log sync
 *
 * @par Purpose:
 * @par Typical use case:
 * @par Method of function operation:
 * @par Important notes:
 *
 * @return				true on success
 *							false on error
 *
 * @par Errors:
 *
 * @pre None.
 * @post
 * @see
 * @remarks None.
 *
 * @par Sample Code:
 * @code
 * @endcode
 */
bool delete_profile_dive();

/**
 * @par Description: API to delete profile
 * This API can be used to delete profile
 *
 * @par Purpose:
 * @par Typical use case:
 * @par Method of function operation:
 * @par Important notes:
 *
 * @return				true on success
 *							false on error
 *
 * @par Errors:
 *
 * @pre None.
 * @post
 * @see
 * @remarks None.
 *
 * @par Sample Code:
 * @code
 * @endcode
 */
bool delete_profile(char *access_name);

/**
 * @par Description: API to delete all profiles
 * This API can be used to delete all profiles
 *
 * @par Purpose:
 * @par Typical use case:
 * @par Method of function operation:
 * @par Important notes:
 *
 * @return				true on success
 *							false on error
 *
 * @par Errors:
 *
 * @pre None.
 * @post
 * @see
 * @remarks None.
 *
 * @par Sample Code:
 * @code
 * @endcode
 */
bool delete_all_profiles();

/**
 * @par Description: API to get profile directory name of synchronizing account
 * This API can be used to get profile directory name
 *
 * @par Purpose:
 * @par Typical use case:
 * @par Method of function operation:
 * @par Important notes:
 * @param[out]		string type, profile_dir_name(identify profile in UI)
 * @param[out]		string type, sync_type(determined by server)
 *
 * @return				true on success
 *							false on error
 *
 * @par Errors:
 *
 * @pre None.
 * @post
 * @see
 * @remarks None.
 *
 * @par Sample Code:
 * @code
 * @endcode
 */
bool get_synchronising_profile(char **profile_dir_name, char **sync_type);

/**
 * @par Description: API to delete all agent default table(except id_provider_tbl, id_page_tbl)
 * This API can be used to delete all agent default table
 *
 * @par Purpose:
 * @par Typical use case:
 * @par Method of function operation:
 * @par Important notes:
 *
 * @return				true on success
 *							false on error
 *
 * @par Errors:
 *
 * @pre None.
 * @post
 * @see
 * @remarks None.
 *
 * @par Sample Code:
 * @code
 * @endcode
 */
bool delete_all_agent_default_table();

#endif				/* SE_ACCOUNT_H_ */