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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
/*
* 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_CALENDAR_CALENDAR_ATTENDEE_H__
#define __TIZEN_SOCIAL_CALENDAR_CALENDAR_ATTENDEE_H__
#include <tizen.h>
#include <time.h>
#include "calendar_types.h"
#ifdef __cplusplus
extern "C"
{
#endif
/**
* @addtogroup CAPI_SOCIAL_CALENDAR_ATTENDEE_MODULE
* @{
*/
/**
* @brief Gets the name of the attendee.
*
* @remarks @a name must be released with free() by you.
*
* @param [in] attendee The attendee handle
* @param [out] name The name of the attendee \n If the name does not exist, it is NULL
*
* @return 0 on success, otherwise a negative error value.
* @retval #CALENDAR_ERROR_NONE Successful
* @retval #CALENDAR_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see calendar_attendee_set_name()
*/
int calendar_attendee_get_name(calendar_attendee_h attendee, char **name);
/**
* @brief Sets a name of the attendee.
*
* @param[in] attendee The attendee handle
* @param[in] name The name of the attendee
*
* @return 0 on success, otherwise a negative error value.
* @retval #CALENDAR_ERROR_NONE Successful
* @retval #CALENDAR_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see calendar_attendee_get_name()
*/
int calendar_attendee_set_name(calendar_attendee_h attendee, const char *name);
/**
* @brief Gets the email of the attendee.
*
* @remarks @a email must be released with free() by you.
*
* @param [in] attendee The attendee handle
* @param [out] email The email of the attendee \n If the email does not exist, it is NULL
*
* @return 0 on success, otherwise a negative error value.
* @retval #CALENDAR_ERROR_NONE Successful
* @retval #CALENDAR_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see calendar_attendee_set_email()
*/
int calendar_attendee_get_email(calendar_attendee_h attendee, char **email);
/**
* @brief Sets a email of the attendee.
*
* @param[in] attendee The attendee handle
* @param[in] email The email of the attendee
*
* @return 0 on success, otherwise a negative error value.
* @retval #CALENDAR_ERROR_NONE Successful
* @retval #CALENDAR_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see calendar_attendee_get_email()
*/
int calendar_attendee_set_email(calendar_attendee_h attendee, const char *email);
/**
* @brief Gets the phone number of the attendee.
*
* @remarks @a phone_number must be released with free() by you.
*
* @param [in] attendee The attendee handle
* @param [out] phone_number The phone number of the attendee \n If the phone number does not exist, it is NULL
*
* @return 0 on success, otherwise a negative error value.
* @retval #CALENDAR_ERROR_NONE Successful
* @retval #CALENDAR_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see calendar_attendee_set_phone_number()
*/
int calendar_attendee_get_phone_number(calendar_attendee_h attendee, char **phone_number);
/**
* @brief Sets a phone number of the attendee.
*
* @param[in] attendee The attendee handle
* @param[in] phone_number The phone number of the attendee
*
* @return 0 on success, otherwise a negative error value.
* @retval #CALENDAR_ERROR_NONE Successful
* @retval #CALENDAR_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see calendar_attendee_get_phone_number()
*/
int calendar_attendee_set_phone_number(calendar_attendee_h attendee, const char *phone_number);
/**
* @brief Gets the contact database ID associated with the given attendee handle.
*
* @param[in] attendee The calendar attendee handle
* @param[out] contact_db_id The contact database ID \n
* If the contact database ID has never set, @a contact_db_id is -1
*
* @return 0 on success, otherwise a negative error value.
* @retval #CALENDAR_ERROR_NONE Successful
* @retval #CALENDAR_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see calendar_attendee_set_contact_db_id()
* @see calendar_event_add_attendee_with_contact()
* @see contact_get_db_id()
* @see contact_get_from_db()
*/
int calendar_attendee_get_contact_db_id(calendar_attendee_h attendee, int *contact_db_id);
/**
* @brief Sets a contact database ID for the given attendee handle.
*
* @param[in] attendee The calendar attendee handle
* @param[in] contact_db_id The contact database ID
*
* @return 0 on success, otherwise a negative error value.
* @retval #CALENDAR_ERROR_NONE Successful
* @retval #CALENDAR_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see calendar_attendee_get_contact_db_id()
* @see contact_get_db_id()
* @see contact_get_from_db()
*/
int calendar_attendee_set_contact_db_id(calendar_attendee_h attendee, int contact_db_id);
/**
* @brief Gets the status for the given calendar attendee handle.
*
* @param[in] attendee The calendar attendee handle
* @param[out] status The status of the attendee \n (default : #CALENDAR_ATTENDEE_STATUS_PENDING)
*
* @return 0 on success, otherwise a negative error value.
* @retval #CALENDAR_ERROR_NONE Successful
* @retval #CALENDAR_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see calendar_attendee_set_status()
*/
int calendar_attendee_get_status(calendar_attendee_h attendee, calendar_attendee_status_e *status);
/**
* @brief Sets a status for the given calendar attendee handle.
*
* @param[in] attendee The calendar attendee handle
* @param[in] status The status of the attendee
*
* @return 0 on success, otherwise a negative error value.
* @retval #CALENDAR_ERROR_NONE Successful
* @retval #CALENDAR_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see calendar_attendee_get_status()
*/
int calendar_attendee_set_status(calendar_attendee_h attendee, calendar_attendee_status_e status);
/**
* @brief Gets the role for the given calendar attendee handle.
*
* @param[in] attendee The calendar attendee handle
* @param[out] role The role of the attendee \n (default : #CALENDAR_ATTENDEE_ROLE_REQ_PARTICIPANT)
*
* @return 0 on success, otherwise a negative error value.
* @retval #CALENDAR_ERROR_NONE Successful
* @retval #CALENDAR_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see calendar_attendee_set_role()
*/
int calendar_attendee_get_role(calendar_attendee_h attendee, calendar_attendee_role_e *role);
/**
* @brief Sets a role for the given calendar attendee handle.
*
* @param[in] attendee The calendar attendee handle
* @param[in] role The role of the attendee
*
* @return 0 on success, otherwise a negative error value.
* @retval #CALENDAR_ERROR_NONE Successful
* @retval #CALENDAR_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see calendar_attendee_get_role()
*/
int calendar_attendee_set_role(calendar_attendee_h attendee, calendar_attendee_role_e role);
/**
* @brief Checks whether there is a next attendee handle on the list.
*
* @param [in] iterator The attendee iterator handle
* @return @c true If the next element exists or @c false If the next element doesn't exist
*
* @see calendar_event_get_attendee_iterator()
* @see calendar_attendee_iterator_next()
*/
bool calendar_attendee_iterator_has_next(calendar_attendee_iterator_h iterator);
/**
* @brief Moves attendee list iterator to the next position and gets attendee handle.
* @details If the next element for the current attendee list exists, then the iterator is moved to
* the next position on the list and the attendee handle for this position is returned.
* When the iterator reaches the last element of the list, all further calls will return
* #CALENDAR_ERROR_ITERATOR_END and @a attendee will remain unchanged.
*
* @param [in] iterator The attendee iterator handle
* @param [out] attendee The attendee handle
*
* @return 0 on success, otherwise a negative error value.
* @retval #CALENDAR_ERROR_NONE Successful
* @retval #CALENDAR_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CALENDAR_ERROR_ITERATOR_END Iterator is on last position
*
* @see calendar_event_get_attendee_iterator()
* @see calendar_attendee_iterator_has_next()
*/
int calendar_attendee_iterator_next(calendar_attendee_iterator_h *iterator, calendar_attendee_h *attendee);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif /* __TIZEN_SOCIAL_CALENDAR_CALENDAR_ATTENDEE_H__ */
|
