include/contacts_phone_log_internal.h

   1 /*
   2  * Contacts Service
   3  *
   4  * Copyright (c) 2010 - 2015 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  */
  19 #ifndef __TIZEN_SOCIAL_CONTACTS_PHONELOG_INTERNAL_H__
  20 #define __TIZEN_SOCIAL_CONTACTS_PHONELOG_INTERNAL_H__
  21
  22
  23 #ifdef __cplusplus
  24 extern "C"
  25 {
  26 #endif
  27
  28 /**
  29  * @file contacts_phone_log_internal.h
  30  */
  31
  32 /**
  33  * @brief Enumeration for Contacts phone log delete flags.
  34  */
  35 typedef enum {
  36         CONTACTS_PHONE_LOG_DELETE_BY_ADDRESS,           /**< Delete by address */
  37         CONTACTS_PHONE_LOG_DELETE_BY_MESSAGE_EXTRA_DATA1,       /**< Delete by message extra_data1 */
  38         CONTACTS_PHONE_LOG_DELETE_BY_EMAIL_EXTRA_DATA1, /**< Delete by email extra_data1  */
  39 } contacts_phone_log_delete_e;
  40
  41 /**
  42  * @brief Deletes a phone log with extra_data1.
  43  *
  44  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.4 @endif
  45  * @privlevel public
  46  * @privilege %http://tizen.org/privilege/callhistory.write
  47  *
  48  * @param[in]   op                              Operation #contacts_phone_log_delete_e
  49  * @param[in]   address (optional)      Address to delete (number, email,  etc)
  50  * @param[in]   extra_data1 (optional)  Extra_data1 to delete
  51  *
  52  * @return  @c 0 on sucess,
  53  *          otherwise a negative error value (#contacts_error_e)
  54  *
  55  * @retval  #CONTACTS_ERROR_NONE                Successful
  56  * @retval  #CONTACTS_ERROR_INVALID_PARAMETER   Invalid parameter
  57  * @retval  #CONTACTS_ERROR_FILE_NO_SPACE       FS Full
  58  * @retval  #CONTACTS_ERROR_OUT_OF_MEMORY             Out of memory
  59  * @retval  #CONTACTS_ERROR_PERMISSION_DENIED   Permission denied. This application does not have the privilege to call this method.
  60  * @retval  #CONTACTS_ERROR_NOT_SUPPORTED       Not supported
  61  * @retval  #CONTACTS_ERROR_IPC                IPC error * @par example
  62  * @code
  63  contacts_phone_log_delete(CONTACTS_PHONE_LOG_DELETE_BY_ADDRESS, "0123456789");
  64  contacts_phone_log_delete(CONTACTS_PHONE_LOG_DELETE_BY_MESSAGE_EXTRA_DATA1,  2);
  65  contacts_phone_log_delete(CONTACTS_PHONE_LOG_DELETE_BY_EMAIL_EXTRA_DATA1,  1);
  66  * @endcode
  67  */
  68 int contacts_phone_log_delete(contacts_phone_log_delete_e op, ...);
  69
  70 #ifdef __cplusplus
  71 }
  72 #endif
  73
  74
  75 #endif /* __TIZEN_SOCIAL_CONTACTS_PHONELOG_INTERNAL_H__ */