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
|
/*
* libnotification
*
* Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
*
* Contact: Seungtaek Chung <seungtaek.chung@samsung.com>, Mi-Ju Lee <miju52.lee@samsung.com>, Xi Zhichan <zhichan.xi@samsung.com>, Youngsub Ko <ys4610.ko@samsung.com>
*
* 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 <notification.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @ingroup NOTIFICATION_LIBRARY
* @defgroup NOTIFICATION_LIST notification list
* @brief Notification List API
*/
/**
* @addtogroup NOTIFICATION_LIST
* @{
*/
/**
* @breief Notification list handle
*/
typedef struct _notification_list *notification_list_h;
/**
* @brief This function get head pointer of the notification list.
* @details
* @remarks
* @param[in] list notification list handle
* @return notification list handle if success, NULL if failure.
* @retval notification list handle(#notification_list_h) - success
* @retval NULL - failure
* @pre
* @post
* @see #notification_list_h
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_list_h noti_list = NULL;
notification_error_e 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 This function get tail pointer of the notification list.
* @details
* @remarks
* @param[in] list notification list handle
* @return notification list handle if success, NULL if failure.
* @retval notification list handle(#notification_list_h) - success
* @retval NULL - failure
* @pre
* @post
* @see #notification_list_h
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_list_h noti_list = NULL;
notification_error_e 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 This function get previous pointer of the current notification list.
* @details
* @remarks
* @param[in] list notification list handle
* @return notification list handle if success, NULL if failure.
* @retval notification list handle(#notification_list_h) - success
* @retval NULL - failure
* @pre
* @post
* @see #notification_list_h
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_list_h noti_list = NULL;
notification_error_e 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 This function get next pointer of the current notification list.
* @details
* @remarks
* @param[in] list notification list handle
* @return notification list handle if success, NULL if failure.
* @retval notification list handle(#notification_list_h) - success
* @retval NULL - failure
* @pre
* @post
* @see #notification_list_h
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_list_h noti_list = NULL;
notification_error_e 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 This function get notification handle that list has.
* @details
* @remarks
* @param[in] list notification list handle
* @return notification handle if success, NULL if failure.
* @retval notification handle(#notification_h) - success
* @retval NULL - failure
* @pre
* @post
* @see #notification_list_h
* @see #notification_h
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
notification_list_h noti_list = NULL;
notification_error_e 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 This function append notification data in notification list.
* @details
* @remarks
* @param[in] list notification list handle
* @param[in] noti notification handle
* @return notification handle if success, NULL if failure.
* @retval notification handle(#notification_h) - success
* @retval NULL - failure
* @pre
* @post
* @see #notification_list_h
* @see #notification_h
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
notification_list_h noti_list = NULL;
notification_error_e 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 This function remove notification data from notification list.
* @details
* @remarks
* @param[in] list notification list handle
* @param[in] noti notification handle
* @return notification handle if success, NULL if failure.
* @retval notification handle(#notification_h) - success
* @retval NULL - failure
* @pre
* @post
* @see #notification_list_h
* @see #notification_h
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
notification_list_h noti_list = NULL;
notification_error_e 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__ */
|
