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
|
/*
* Copyright (c) 2011 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_H__
#define __TIZEN_SOCIAL_CONTACTS_H__
#include <contacts_address.h>
#include <contacts_company.h>
#include <contacts_email.h>
#include <contacts_event.h>
#include <contacts_group.h>
#include <contacts_messenger.h>
#include <contacts_name.h>
#include <contacts_nickname.h>
#include <contacts_number.h>
#include <contacts_contact.h>
#include <contacts_relatedgroup.h>
#include <contacts_search.h>
#include <contacts_types.h>
#include <contacts_web.h>
#ifdef __cplusplus
extern "C"
{
#endif
/**
* @addtogroup CAPI_SOCIAL_CONTACTS_MODULE
* @{
*/
/**
* @brief Connects to the contacts service.
*
* @remarks Connection opening is necessary to access the contacts database such as fetching, inserting, or updating contacts.\n
* The execution of contacts_connect() and contacts_disconnect() 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_FAILED Database operation failure
*
* @see contacts_disconnect()
*
*/
int contacts_connect(void);
/**
* @brief Disconnects the contacts service.
*
* @remarks If there is no opened connection, this function returns #CONTACTS_ERROR_DB_FAILED.
*
* @return 0 on success, otherwise a negative error value.
* @retval #CONTACTS_ERROR_NONE Successful
* @retval #CONTACTS_ERROR_DB_FAILED Database operation failure
*
* @see contacts_connect()
*
*/
int contacts_disconnect(void);
/**
* @brief Gets the contacts database version.
*
* @return 0 on success, otherwise a negative error value.
* @retval #CONTACTS_ERROR_NONE Successful
* @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTACTS_ERROR_DB_FAILED Database operation failure
*
* @see contacts_connect()
* @see contact_query_contact_by_version()
*/
int contacts_get_db_version(int* contacts_db_version);
/**
* @brief Registers a callback function to be invoked when the contacts changes.
*
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #CONTACTS_ERROR_NONE Successful
* @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter
*
* @pre This function requires an open connection to the contacts service by contacts_connect().
* @post contacts_db_changed_cb() will be invoked when a contact changes.
*
* @see contacts_db_changed_cb()
* @see contact_query_contact_by_version()
* @see contacts_remove_contact_db_changed_cb()
* @see contact_insert_to_db()
* @see contact_update_to_db()
* @see contact_delete_from_db()
*/
int contacts_add_contact_db_changed_cb(contacts_db_changed_cb callback, void *user_data);
/**
* @brief Unregisters the callback function.
*
* @param[in] callback The callback function to unregister
*
* @return 0 on success, otherwise a negative error value.
* @retval #CONTACTS_ERROR_NONE Successful
* @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see contacts_db_changed_cb()
* @see contacts_add_contact_db_changed_cb()
*/
int contacts_remove_contact_db_changed_cb(contacts_db_changed_cb callback);
/**
* @brief Registers a callback function to be invoked when the favorite contacts changes.
*
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #CONTACTS_ERROR_NONE Successful
* @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter
*
* @pre This function requires an open connection to the contacts service by contacts_connect().
* @post contacts_db_changed_cb() will be invoked when a contact changes.
*
* @see contacts_db_changed_cb()
* @see contact_query_contact_by_version()
* @see contacts_remove_favorite_db_changed_cb()
* @see contact_set_favorite_to_db()
* @see contact_insert_to_db()
* @see contact_update_to_db()
* @see contact_delete_from_db()
* @see contact_set_favorite()
*/
int contacts_add_favorite_db_changed_cb(contacts_db_changed_cb callback, void *user_data);
/**
* @brief Unregisters the callback function.
*
* @param[in] callback The callback function to unregister
*
* @return 0 on success, otherwise a negative error value.
* @retval #CONTACTS_ERROR_NONE Successful
* @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see contacts_db_changed_cb()
* @see contacts_add_favorite_db_changed_cb()
*/
int contacts_remove_favorite_db_changed_cb(contacts_db_changed_cb callback);
/**
* @brief Registers a callback function to be invoked when the favorite contacts changes.
*
* @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
* @retval #CONTACTS_ERROR_NONE Successful
* @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter
*
* @pre This function requires an open connection to the contacts service by contacts_connect().
* @post contacts_db_changed_cb() will be invoked when a contact changes.
*
* @see contacts_db_changed_cb()
* @see contacts_remove_group_db_changed_cb()
* @see contacts_group_insert_to_db()
* @see contacts_group_update_to_db()
* @see contacts_group_delete_from_db()
*/
int contacts_add_group_db_changed_cb(contacts_db_changed_cb callback, void *user_data);
/**
* @brief Unregisters the callback function.
*
* @param[in] callback The callback function to unregister
*
* @return 0 on success, otherwise a negative error value.
* @retval #CONTACTS_ERROR_NONE Successful
* @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see contacts_db_changed_cb()
* @see contacts_add_group_db_changed_cb()
*/
int contacts_remove_group_db_changed_cb(contacts_db_changed_cb callback);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif /* __TIZEN_SOCIAL_CONTACTS_H__ */
|
