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
|
/*
* 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_EVENT_H__
#define __TIZEN_SOCIAL_CONTACTS_EVENT_H__
#include <contacts_types.h>
#ifdef __cplusplus
extern "C"
{
#endif
/**
* @addtogroup CAPI_SOCIAL_CONTACTS_BIRTHDAY_MODULE
* @{
*/
/**
* @brief Creates a handle to contacts birthday.
*
* @remarks @a birthday must be released with contact_birthday_destroy() by you. \n
* @a birthday is not added to contacts database until contact_insert_to_db() is called.
*
* @param[out] birthday A new contacts birthday handle
*
* @return 0 on success, otherwise a negative error value.
* @retval #CONTACTS_ERROR_NONE Successful
* @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CONTACTS_ERROR_OUT_OF_MEMORY Out of memory
*
* @see contact_birthday_destroy()
*/
int contact_birthday_create(contact_birthday_h *birthday);
/**
* @brief Destroys the handle to contacts birthday.
*
* @param[in] birthday The contacts birthday handle
*
* @return 0 on success, otherwise a negative error value.
* @retval #CONTACTS_ERROR_NONE Successful
* @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see contact_birthday_create()
*/
int contact_birthday_destroy(contact_birthday_h birthday);
/**
* @brief Gets the birthday date from the contacts birthday handle.
*
* @param[in] birthday The contacts birthday handle
* @param[out] year The year of birthday date
* @param[out] month The month of birthday date
* @param[out] day The day of birthday date
*
* @return 0 on success, otherwise a negative error value.
* @retval #CONTACTS_ERROR_NONE Successful
* @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see contact_birthday_set_date()
*/
int contact_birthday_get_date(contact_birthday_h birthday, int *year, int *month, int *day);
/**
* @brief Sets the birthday date to the contacts birthday handle.
*
* @param[in] birthday The contacts birthday handle
* @param[in] year The year of birthday date
* @param[in] month The month of birthday date
* @param[in] day The day of birthday date
*
* @return 0 on success, otherwise a negative error value.
* @retval #CONTACTS_ERROR_NONE Successful
* @retval #CONTACTS_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see contact_birthday_get_date()
*/
int contact_birthday_set_date(contact_birthday_h birthday, int year, int month, int day);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif /* __TIZEN_SOCIAL_CONTACTS_EVENT_H__ */
|
