summaryrefslogtreecommitdiff
path: root/include/badge.h
blob: b7b7f6554958996c8dddf2c162f786afc3441109 (plain)
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
/*
 * Copyright (c) 2000 - 2017 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 __BADGE_DEF_H__
#define __BADGE_DEF_H__

#include <tizen.h>

#include <stdbool.h>
#include <badge_error.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/**
 * @file badge.h
 * @brief This file contains the badge APIs.
 */

/**
 * @addtogroup BADGE_MODULE
 * @{
 */

/**
 * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif Use badge_add instead.
 * @brief Creates a badge for the application itself.
 * @details Creates new badge to display.
 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 * @privlevel public
 * @privilege %http://tizen.org/privilege/notification
 * @param[in] writable_app_id The id of application which is authorized to change the badge
 * @return #BADGE_ERROR_NONE if success, other value if failure
 * @retval #BADGE_ERROR_NONE Success
 * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
 * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
 * @retval #BADGE_ERROR_IO_ERROR Error from I/O
 * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready
 * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
 * @see #badge_error_e
 * @par Sample code:
 * @code
#include <badge.h>

{
	int err = BADGE_ERROR_NONE;

	err = badge_new(app_id);
	if (err != BADGE_ERROR_NONE)
		return;

}
 * @endcode
 */
int badge_new(const char *writable_app_id) TIZEN_DEPRECATED_API;


/**
 * @brief Creates a badge for the application specified by the badge_app_id.
 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 * @privlevel public
 * @privilege %http://tizen.org/privilege/notification
 * @remarks Creating and updating a badge of the other application is allowed only when both applications are signed with the same certificate.
 * @param[in] badge_app_id The id of the application for which the badge will be created. This parameter can be null when creating a badge for itself.
 * @return #BADGE_ERROR_NONE If success, other value if failure
 * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
 * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory
 * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
 * @retval #BADGE_ERROR_IO_ERROR Error from I/O
 * @retval #BADGE_ERROR_FROM_DB Error from DB
 * @retval #BADGE_ERROR_ALREADY_EXIST Already exist
 * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready
 * @retval #BADGE_ERROR_INVALID_PACKAGE The caller application is not signed with the certificate of the badge_app_id
 * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
 * @see #badge_error_e
 * @par Sample code:
 * @code
#include <badge.h>

{
	int err = BADGE_ERROR_NONE;

	err = badge_add("org.tizen.email");
	if (err != BADGE_ERROR_NONE)
		return;
}
 * @endcode
 */
int badge_add(const char *badge_app_id);


/**
 * @brief Removes the badge for the designated application.
 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 * @privlevel public
 * @privilege %http://tizen.org/privilege/notification
 * @param[in] app_id The name of the designated application
 * @return #BADGE_ERROR_NONE if success, other value if failure
 * @retval #BADGE_ERROR_NONE Success
 * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
 * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory
 * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
 * @retval #BADGE_ERROR_IO_ERROR Error from I/O
 * @retval #BADGE_ERROR_FROM_DB Error from DB
 * @retval #BADGE_ERROR_NOT_EXIST Not exist
 * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready
 * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
 * @see #badge_error_e
 * @par Sample code:
 * @code
#include <badge.h>

{
	int err = BADGE_ERROR_NONE;

	err = badge_remove(app_id);
	if (err != BADGE_ERROR_NONE)
		return;

}
 * @endcode
 */
int badge_remove(const char *app_id);

/**
 * @brief Sets badge count for the designated application.
 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 * @privlevel public
 * @privilege %http://tizen.org/privilege/notification
 * @param[in] app_id The name of the designated application
 * @param[in] count The count of the badge
 * @return #BADGE_ERROR_NONE if success, other value if failure
 * @retval #BADGE_ERROR_NONE Success
 * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
 * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory
 * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
 * @retval #BADGE_ERROR_IO_ERROR Error from I/O
 * @retval #BADGE_ERROR_FROM_DB Error from DB
 * @retval #BADGE_ERROR_NOT_EXIST Not exist
 * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready
 * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
 * @see #badge_error_e
 * @see badge_new()
 * @par Sample code:
 * @code
#include <badge.h>

{
	int err = BADGE_ERROR_NONE;

	err = badge_set_count(app_id, 1);
	if (err != BADGE_ERROR_NONE)
		return;

}
 * @endcode
 */
int badge_set_count(const char *app_id, unsigned int count);

/**
 * @brief Gets badge count for the designated application.
 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 * @privlevel public
 * @privilege %http://tizen.org/privilege/notification
 * @param[in] app_id The name of the designated application
 * @param[out] count The count of the badge
 * @return #BADGE_ERROR_NONE if success, other value if failure
 * @retval #BADGE_ERROR_NONE Success
 * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
 * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory
 * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
 * @retval #BADGE_ERROR_IO_ERROR Error from I/O
 * @retval #BADGE_ERROR_FROM_DB Error from DB
 * @retval #BADGE_ERROR_NOT_EXIST Not exist
 * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready
 * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
 * @see #badge_error_e
 * @see badge_new()
 * @see badge_set_count()
 * @par Sample code:
 * @code
#include <badge.h>

{
	int err = BADGE_ERROR_NONE;
	int count = 0;

	err = badge_get_count(app_id, &count);
	if (err != BADGE_ERROR_NONE)
		return;

}
 * @endcode
 */
int badge_get_count(const char *app_id, unsigned int *count);

/**
 * @brief Sets the display option for the designated application.
 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 * @privlevel public
 * @privilege %http://tizen.org/privilege/notification
 * @param[in] app_id The name of the designated application
 * @param[in] is_display The display option (1 = display, 0 = not display)
 * @return #BADGE_ERROR_NONE if success, other value if failure
 * @retval #BADGE_ERROR_NONE Success
 * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
 * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory
 * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
 * @retval #BADGE_ERROR_IO_ERROR Error from I/O
 * @retval #BADGE_ERROR_FROM_DB Error from DB
 * @retval #BADGE_ERROR_NOT_EXIST Not exist
 * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready
 * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
 * @see #badge_error_e
 * @see badge_new()
 * @par Sample code:
 * @code
#include <badge.h>

{
	int err = BADGE_ERROR_NONE;

	err = badge_set_display(app_id, 1);
	if (err != BADGE_ERROR_NONE)
		return;

}
 * @endcode
 */
int badge_set_display(const char *app_id, unsigned int is_display);

/**
 * @brief Gets the display option for the designated application.
 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 * @privlevel public
 * @privilege %http://tizen.org/privilege/notification
 * @param[in] app_id The name of the designated application
 * @param[out]  is_display The display option (1 = display, 0 = not display)
 * @return #BADGE_ERROR_NONE if success, other value if failure
 * @retval #BADGE_ERROR_NONE Success
 * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
 * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory
 * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
 * @retval #BADGE_ERROR_IO_ERROR Error from I/O
 * @retval #BADGE_ERROR_FROM_DB Error from DB
 * @retval #BADGE_ERROR_NOT_EXIST Not exist
 * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready
 * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
 * @see #badge_error_e
 * @see badge_new()
 * @see badge_set_count()
 * @par Sample code:
 * @code
#include <badge.h>

{
	int is_display = 0;
	int err = BADGE_ERROR_NONE;

	err = badge_get_display(app_id, &is_display);
	if (err != BADGE_ERROR_NONE)
		return;
}
 * @endcode
 */
int badge_get_display(const char *app_id, unsigned int *is_display);

/**
 * @brief Callback function for getting result of badge_foreach.
 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 * @param[in] app_id The id of the application
 * @param[in] count The count of the badge
 * @param[in] user_data The user data passed from the badge_foreach function
 * @return true to continue with the next iteration of the loop, false to break out of the loop
 * @pre badge_foreach() will invoke this callback.
 * @see badge_foreach()
 */
typedef bool (*badge_foreach_cb)(const char *app_id, unsigned int count, void *user_data);


/**
 * @brief Retrieves all existing badges.
 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 * @privlevel public
 * @privilege %http://tizen.org/privilege/notification
 * @param[in] callback The callback function
 * @param[in] user_data The user data to be passed to the callback function
 * @return #BADGE_ERROR_NONE if success, other value if failure
 * @retval #BADGE_ERROR_NONE Success
 * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
 * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory
 * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
 * @retval #BADGE_ERROR_IO_ERROR Error from I/O
 * @retval #BADGE_ERROR_FROM_DB Error form DB
 * @retval #BADGE_ERROR_NOT_EXIST Not exist
 * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready
 * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
 * @see #badge_error_e
 * @see badge_foreach_cb()
 */
int badge_foreach(badge_foreach_cb callback, void *user_data);

/**
 * @brief Enumeration for Badge Action.
 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 */
enum badge_action {
	BADGE_ACTION_CREATE = 0,	/**< Badge created */
	BADGE_ACTION_REMOVE,	/**< Badge removed */
	BADGE_ACTION_UPDATE,	/**< Badge updated */
	BADGE_ACTION_CHANGED_DISPLAY,	/**< The display option of the badge changed  */
	BADGE_ACTION_SERVICE_READY,	/**< The badge service is ready */
};

/**
 * @brief Called when the badge information is changed.
 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 * @param[in] action The type of the change. Refer #badge_action
 * @param[in] app_id The name of the application
 * @param[in] count The count of the badge
 * @param[in] user_data The user data passed from the callback register function
 * @pre badge_register_changed_cb() will invoke this callback.
 * @see badge_unregister_changed_cb()
 */
typedef void (*badge_change_cb)(unsigned int action, const char *app_id,
			unsigned int count, void *user_data);
/**
 * @brief Registers a callback function to receive badge change event.
 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 * @privlevel public
 * @privilege %http://tizen.org/privilege/notification
 * @remarks Should be used in the homescreen.\n
 * Prospective Clients : Homescreen.
 * @param[in] callback The callback function
 * @param[in] user_data The user data to be passed to the callback function
 * @return #BADGE_ERROR_NONE if success, other value if failure
 * @retval #BADGE_ERROR_NONE Success
 * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
 * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
 * @retval #BADGE_ERROR_IO_ERROR Error from I/O
 * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory
 * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready
 * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
 * @see #badge_error_e
 * @see badge_new()
 * @see badge_remove()
 * @see badge_set_count()
 */
int badge_register_changed_cb(badge_change_cb callback, void *user_data);

/**
 * @brief Unregisters a callback function to receive badge change event.
 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 * @privlevel public
 * @privilege %http://tizen.org/privilege/notification
 * @param[in] callback The callback function
 * @return #BADGE_ERROR_NONE if success, other value if failure
 * @retval #BADGE_ERROR_NONE Success
 * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter
 * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
 * @retval #BADGE_ERROR_NOT_EXIST Not exist
 * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported
 * @see #badge_error_e
 * @see badge_register_changed_cb()
 */
int badge_unregister_changed_cb(badge_change_cb callback);

/**
 * @}
 */

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* __BADGE_DEF_H__ */