summaryrefslogtreecommitdiff
path: root/include/contacts_service.h
blob: 032db2060ce5a9c3b47ae9bc69f8f013498517a5 (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
/*
 * Contacts Service
 *
 * Copyright (c) 2010 - 2012 Samsung Electronics Co., Ltd. All rights reserved.
 *
 * 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.
 *
 */
#ifndef __TIZEN_SOCIAL_CONTACTS_SERVICE_H__
#define __TIZEN_SOCIAL_CONTACTS_SERVICE_H__

#ifndef API
#define API __attribute__ ((visibility("default")))
#endif

#ifdef __cplusplus
extern "C"
{
#endif

/**
 * @addtogroup CAPI_SOCIAL_CONTACTS_SVC_DATABASE_MODULE
 * @{
 */

/**
 * @brief	Connects to the contacts service.
 *
 * @remarks Connection opening is necessary to access the contacts database such as fetching, inserting, or updating records.\n
 * The execution of contacts_connect2() and contacts_disconnect2() could slow down your application so you are recommended not to call them frequently.
 *
 * @return  0 on success, otherwise a negative error value.
 * @retval  #CONTACTS_ERROR_NONE	Successful
 * @retval  #CONTACTS_ERROR_DB	Database operation failure
 *
 * @see  contacts_disconnect2()
 */
API int contacts_connect2(void);

/**
 * @brief	Disconnects from the contacts service.
 *
 * @remarks	If there is no opened connection, this function returns #CONTACTS_ERROR_DB.
 *
 * @return  0 on success, otherwise a negative error value.
 * @retval  #CONTACTS_ERROR_NONE	Successful
 * @retval  #CONTACTS_ERROR_DB	Database operation failure
 *
 * @see contacts_connect2()
 */
API int contacts_disconnect2(void);



/**
 * @brief	Connects to the contacts service with another connection for thread.
 *
 * @remarks
 *
 * @return  0 on success, otherwise a negative error value.
 * @retval  #CONTACTS_ERROR_NONE	Successful
 * @retval  #CONTACTS_ERROR_DB	Database operation failure
 *
 * @see  contacts_disconnect_on_thread()
 */
API int contacts_connect_on_thread(void);

/**
 * @brief	Disconnects from the contacts service.
 *
 * @remarks
 *
 * @return  0 on success, otherwise a negative error value.
 * @retval  #CONTACTS_ERROR_NONE	Successful
 * @retval  #CONTACTS_ERROR_DB	Database operation failure
 *
 * @see contacts_connect_on_thread()
 */
API int contacts_disconnect_on_thread(void);


#define CONTACTS_CONNECT_FLAG_RETRY	0x00000001
#define CONTACTS_CONNECT_FLAG_NONE	0

/**
 * @brief	Connects to the contacts service. If connection is failed because contacts-service is not running, it will retry for several seconds
 *
 * @remarks Connection opening is necessary to access the contacts database such as fetching, inserting, or updating records.\n
 * The execution of contacts_connect2() and contacts_disconnect2() could slow down your application so you are recommended not to call them frequently.
 *
 * @return  0 on success, otherwise a negative error value.
 * @retval  #CONTACTS_ERROR_NONE	Successful
 * @retval  #CONTACTS_ERROR_DB	Database operation failure
 *
 * @see  contacts_disconnect2()
 */
API int contacts_connect_with_flags(unsigned int flags);



/**
 * @}
 */

#ifdef __cplusplus
}
#endif


#endif //__TIZEN_SOCIAL_CONTACTS_SERVICE_H__