Git init

1 files changed, 206 insertions, 0 deletions

diff --git a/include/contacts.h b/include/contacts.h
new file mode 100755
index 0000000..2f299ff
--- /dev/null
+++ b/include/contacts.h
@@ -0,0 +1,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__ */
+