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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
|
/*
* Copyright (c) 2000 - 2016 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 __NOTIFICATION_LIST_H__
#define __NOTIFICATION_LIST_H__
#include <sys/types.h>
#include <notification.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @file notification_list.h
* @brief This file contains the notification list APIs.
*/
/**
* @internal
* @addtogroup NOTIFICATION_LIST
* @{
*/
/**
* @brief Notification list handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef struct _notification_list *notification_list_h;
/**
* @brief Returns the notification list handle.
* @details If count is equal to @c -1, all notifications are returned.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] type The notification type
* @param[in] count The returned notification data number
* @param[out] #NOTIFICATION_ERROR_NONE on success, other value on failure
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NOTIFICATION_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @see #notification_list_h
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_list_h noti_list = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti_err = notification_get_list(NOTIFICATION_TYPE_NONE, -1, ¬i_list);
if (noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_get_list(notification_type_e type,
int count,
notification_list_h *list);
int notification_get_list_for_uid(notification_type_e type,
int count,
notification_list_h *list, uid_t uid);
/**
* @brief Returns the notification detail list handle of grouping data.
* @details If count is equal to c -1, all notifications are returned.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] pkgname The caller application package name
* @param[in] group_id The group ID
* @param[in] priv_id The private ID
* @param[in] count The returned notification data number
* @param[out] list The notification list handle
* @return #NOTIFICATION_ERROR_NONE if success,
* other value if failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval NOTIFICATION_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @see #notification_list_h
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_list_h noti_list = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti_err = notification_get_detail_list(pkgname, group_id, priv_id, -1, ¬i_list);
if (noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_get_detail_list(const char *pkgname,
int group_id,
int priv_id,
int count,
notification_list_h *list);
int notification_get_detail_list_for_uid(const char *pkgname,
int group_id,
int priv_id,
int count,
notification_list_h *list,
uid_t uid);
/**
* @brief Frees a notification list.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] list The notification list handle
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval NOTIFICATION_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @pre notification_get_grouping_list() or notification_get_detail_list().
* @see #notification_list_h
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_list_h noti_list = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
...
noti_err = notification_free_list(noti_list);
if (noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_free_list(notification_list_h list);
/**
* @brief Gets the head pointer of the notification list.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
* @param[in] list Notification list handle
* @return Notification list handle on success, NULL on failure
* @retval #notification_list_h Success
* @retval NULL Failure
* @exception #NOTIFICATION_ERROR_NONE Success
* @exception #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @see #notification_list_h
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_list_h noti_list = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti_err = notification_get_grouping_list(NOTIFICATION_TYPE_NONE, -1, ¬i_list);
if (noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
noti_list = notification_list_get_head(noti_list);
}
* @endcode
*/
notification_list_h notification_list_get_head(notification_list_h list);
/**
* @brief Gets the tail pointer to the notification list.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
* @param[in] list Notification list handle
* @return Notification list handle on success, NULL on failure
* @retval #notification_list_h Success
* @retval NULL Failure
* @exception #NOTIFICATION_ERROR_NONE Success
* @exception #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @see #notification_list_h
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_list_h noti_list = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti_err = notification_get_grouping_list(NOTIFICATION_TYPE_NONE, -1, ¬i_list);
if (noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
noti_list = notification_list_get_tail(noti_list);
}
* @endcode
*/
notification_list_h notification_list_get_tail(notification_list_h list);
/**
* @brief Gets the previous pointer of the current notification list.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
* @param[in] list Notification list handle
* @return Notification list handle on success, NULL on failure
* @retval #notification_list_h Success
* @retval NULL Failure
* @exception #NOTIFICATION_ERROR_NONE Success
* @exception #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @see #notification_list_h
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_list_h noti_list = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti_err = notification_get_grouping_list(NOTIFICATION_TYPE_NONE, -1, ¬i_list);
if (noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
noti_list = notification_list_get_prev(noti_list);
}
* @endcode
*/
notification_list_h notification_list_get_prev(notification_list_h list);
/**
* @brief Gets the next pointer of the current notification list.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
* @param[in] list Notification list handle
* @return Notification list handle on success, NULL on failure
* @retval #notification_list_h Success
* @retval NULL Failure
* @exception #NOTIFICATION_ERROR_NONE Success
* @exception #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @see #notification_list_h
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_list_h noti_list = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti_err = notification_get_grouping_list(NOTIFICATION_TYPE_NONE, -1, ¬i_list);
if (noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
noti_list = notification_list_get_next(noti_list);
}
* @endcode
*/
notification_list_h notification_list_get_next(notification_list_h list);
/**
* @brief Gets the notification handle that the list has.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
* @param[in] list Notification list handle
* @return Notification handle on success, NULL on failure
* @retval #notification_h Success
* @retval NULL Failure
* @exception #NOTIFICATION_ERROR_NONE Success
* @exception #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @see #notification_list_h
* @see #notification_h
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
notification_list_h noti_list = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti_err = notification_get_grouping_list(NOTIFICATION_TYPE_NONE, -1, ¬i_list);
if (noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
noti = notification_list_get_data(noti_list);
}
* @endcode
*/
notification_h notification_list_get_data(notification_list_h list);
/**
* @brief Gets a number of the notification list.
* @since_tizen 3.0
* @param[in] list Notification list handle
* @return A number of notification list handle on success, 0 on failure
* @exception #NOTIFICATION_ERROR_NONE Success
* @exception #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @see #notification_list_h
* @see #notification_h
* @par Sample code:
* @code
include <notification.h>
...
{
int count = 0;
notification_list_h noti_list = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti_err = notification_get_detail_list(pkgname, group_id, priv_id, -1, ¬i_list);
if (noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
count = notification_list_get_count(noti_list);
}
* @endcode
*/
int notification_list_get_count(notification_list_h list);
/**
* @brief Appends notification data to the notification list.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
* @param[in] list Notification list handle
* @param[in] noti Notification handle
* @return Notification handle on success, NULL on failure
* @retval #notification_h Success
* @retval NULL Failure
* @exception #NOTIFICATION_ERROR_NONE Success
* @exception #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @exception #NOTIFICATION_ERROR_OUT_OF_MEMORY Out of memory
* @see #notification_list_h
* @see #notification_h
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
notification_list_h noti_list = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti = notification_new(NOTIFICATION_TYPE_NOTI, NOTIFICATION_GROUP_ID_NONE, NOTIFICATION_PRIV_ID_NONE);
if (noti == NULL) {
return;
}
noti_list = notification_list_append(noti_list, noti);
}
* @endcode
*/
notification_list_h notification_list_append(notification_list_h list,
notification_h noti);
/**
* @brief Removes notification data from the notification list.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
* @param[in] list The notification list handle
* @param[in] noti The notification handle
* @return Notification handle on success,
* otherwise @c NULL on failure
* @retval #notification_h Success
* @retval NULL Failure
* @exception #NOTIFICATION_ERROR_NONE Success
* @exception #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @see #notification_list_h
* @see #notification_h
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
notification_list_h noti_list = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
...
noti_list = notification_list_remove(noti_list, noti);
}
* @endcode
*/
notification_list_h notification_list_remove(notification_list_h list,
notification_h noti);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif /* __NOTIFICATION_LIST_H__ */
|
