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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
|
/*
* 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>
*
* 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_H__
#define __NOTIFICATION_H__
#include <time.h>
#include <bundle.h>
#include <app.h>
#include <notification_error.h>
#include <notification_type.h>
#include <notification_status.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @file notification.h
* @brief This file contains the notification API.
*/
/**
* @addtogroup NOTIFICATION_MODULE
* @{
*/
/**
* @brief Sets an absolute path for an image file to display on the notification view.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] type The notification image type
* @param[in] image_path The image file full path
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @pre Notification handle should be created by notification_create().
* @see #notification_image_type_e
* @see notification_create()
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
if(noti == NULL) {
return;
}
noti_err = notification_set_image(noti, NOTIFICATION_IMAGE_TYPE_ICON, APP_IMAGE_FULL_PATH);
if(noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
}
}
* @endcode
*/
int notification_set_image(notification_h noti,
notification_image_type_e type,
const char *image_path);
/**
* @brief Gets the absolute path of an image file.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @remarks Do not free @a image_path. It will be freed when notification_free() is called.
* @param[in] noti Notification handle
* @param[in] type Notification image type
* @param[out] image_path image file full path
* @return NOTIFICATION_ERROR_NONE on success, other value on failure
* @retval NOTIFICATION_ERROR_NONE Success
* @retval NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @pre Notification handle should be created by notification_create().
* @see #notification_image_type_e
* @see notification_create()
* @par Sample code:
* @code
#include <notification.h>
...
{
char *image_path = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti_err = notification_get_image(noti, NOTIFICATION_IMAGE_TYPE_ICON, &image_path);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_get_image(notification_h noti,
notification_image_type_e type,
char **image_path);
/**
* @brief Sets a timestamp.
* @details If input_time is @c 0, time information is taken from the current time.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] input_time The input time
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @pre Notification handle should be created by notification_create().
* @see notification_create()
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
if(noti == NULL) {
return;
}
noti_err = notification_set_time(noti, time(NULL));
if(noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
}
}
* @endcode
*/
int notification_set_time(notification_h noti,
time_t input_time);
/**
* @brief Gets a timestamp.
* @details If ret_time is @c 0, time information is not set before.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] ret_time The return time value
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @pre Notification handle should be created by notification_create().
* @see notification_create()
* @par Sample code:
* @code
#include <notification.h>
...
{
time_t ret_time;
int noti_err = NOTIFICATION_ERROR_NONE;
noti_err = notification_get_time(noti, &ret_time);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_get_time(notification_h noti,
time_t * ret_time);
/**
* @brief Gets an insertion timestamp of the notification.
* @details If ret_time is @c 0, this notification data is not inserted before.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] ret_time The return time value
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
...
{
time_t ret_time;
int noti_err = NOTIFICATION_ERROR_NONE;
noti_err = notification_get_insert_time(noti, &ret_time);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_get_insert_time(notification_h noti,
time_t * ret_time);
/**
* @brief Sets the text to display on the notification view.
* @details Sets title, content string. If the text is formatted data (only %d, %f, %s are supported), type - value pair should be set.
* If %d, the type #NOTIFICATION_VARIABLE_TYPE_INT and the value is an integer.
* If %f, the type #NOTIFICATION_VARIABLE_TYPE_DOUBLE and the value is a double.
* If %s, the type #NOTIFICATION_VARIABLE_TYPE_STRING and the value is a string.
* If the type is #NOTIFICATION_VARIABLE_TYPE_COUNT, notification count is displaying with text.
* If the value is #NOTIFICATION_COUNT_POS_LEFT, count is displayed at the left of the text.
* If the value is #NOTIFICATION_COUNT_POS_IN, count is displayed in the text when text has %d format.
* If the value is #NOTIFICATION_COUNT_POS_RIGHT, count is displayed at the right of the text.
* Variable parameters should be terminated #NOTIFICATION_VARIABLE_TYPE_NONE.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] type The notification text type
* @param[in] text The basic text
* @param[in] key The text key for localization
* @param[in] args_type The variable parameter that type - value pair
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @pre notification handle should be created by notification_create().
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
if(noti == NULL) {
return;
}
noti_err = notification_set_text(noti, NOTIFICATION_TEXT_TYPE_TITLE, "I'm Title", "IDS_APP_BODY_IM_TITLE", NOTIFICATION_VARIABLE_TYPE_NONE);
if(noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
}
}
* @endcode
*/
int notification_set_text(notification_h noti,
notification_text_type_e type,
const char *text,
const char *key,
int args_type, ...);
/**
* @brief Gets the text from the notification handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] type The notification text type
* @param[out] text The notification text
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
char *text = NULL;
noti_err = notification_get_text(noti, NOTIFICATION_TEXT_TYPE_TITLE, &text);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_get_text(notification_h noti,
notification_text_type_e type,
char **text);
/**
* @brief Sets the timestamp to display on the notification view.
* @details The timestamp will be converted to a formatted string and it will be displayed on the set text area.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] type The notification text type
* @param[in] time The timestamp
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @pre Notification handle should be created by notification_create().
*/
int notification_set_time_to_text(notification_h noti, notification_text_type_e type,
time_t time);
/**
* @brief Gets the timestamp from the notification handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] type The notification text type
* @param[in] time The pointer of time stamp
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @pre Notification handle should be created by notification_create().
*/
int notification_get_time_from_text(notification_h noti, notification_text_type_e type,
time_t *time);
/**
* @brief Sets the sound type for the notification.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] type The notification sound type
* @param[in] path The user sound file path
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti_err = notification_set_sound(noti, NOTIFICATION_SOUND_TYPE_DEFAULT, NULL);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_set_sound(notification_h noti,
notification_sound_type_e type,
const char *path);
/**
* @brief Gets the sound type from the notification handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] type The notification sound type
* @param[out] path The user sound file path
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
notification_sound_type_e type = NOTIFICATION_SOUND_TYPE_NONE;
noti_err = notification_get_sound(noti, &type, NULL);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_get_sound(notification_h noti,
notification_sound_type_e *type,
const char **path);
/**
* @brief Sets the vibration type for the notification.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] type The notification vibration type
* @param[in] path The user vibration file path
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti_err = notification_set_vibration(noti, NOTIFICATION_VIBRATION_TYPE_DEFAULT, NULL);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_set_vibration(notification_h noti,
notification_vibration_type_e type,
const char *path);
/**
* @brief Gets the vibrate type from the notification handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] type The notification sound type
* @param[out] path The user vibration file path
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
notification_vibration_type_e type = NOTIFICATION_VIBRATION_TYPE_NONE;
noti_err = notification_get_vibration(noti, &type, NULL);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_get_vibration(notification_h noti,
notification_vibration_type_e *type,
const char **path);
/**
* @brief Sets the LED displaying option.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] operation The LED notification operation
* @param[in] led_argb The notification led color
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti_err = notification_set_led(noti, NOTIFICATION_LED_TYPE_DEFAULT, NULL);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_set_led(notification_h noti,
notification_led_op_e operation,
int led_argb);
/**
* @brief Gets the LED displaying option from the notification handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] operation The LED notification operation
* @param[out] led_argb The notification LED color
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
notification_led_type_e type = NOTIFICATION_LED_TYPE_NONE;
noti_err = notification_get_led(noti, &type, NULL);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_get_led(notification_h noti,
notification_led_op_e *operation,
int *led_argb);
/**
* @brief Sets the time period of flashing the LED.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] on_ms The time for turning on the LED
* @param[in] off_ms The time for turning off the LED
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti_err = notification_set_led_time_period(noti, 100, 100);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_set_led_time_period(notification_h noti,
int on_ms, int off_ms);
/**
* @brief Gets the time period of flashing the LED from the notification handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] on_ms The time for turning on the LED
* @param[out] off_ms The time for turning on the LED
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
int led_on_ms = 0;
int led_off_ms = 0;
noti_err = notification_get_led_time_period(noti, &led_on_ms, &led_off_ms);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_get_led_time_period(notification_h noti,
int *on_ms, int *off_ms);
/**
* @brief Sets the launch option for a notification.
* @details When notification data selected in display application, application launched by app_control_send_launch_request with app_control handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] type Launching option type
* @param[in] option App Control handler
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
app_control_h app_control = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
...
app_control_create(&app_control);
app_control_set_app_id(app_control, "org.tizen.app");
...
noti_err = notification_set_launch_option(noti, NOTIFICATION_LAUNCH_OPTION_APP_CONTROL, (void *)app_control);
if(noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
}
app_control_destroy(app_control);
}
* @endcode
*/
int notification_set_launch_option(notification_h noti,
notification_launch_option_type type, void *option);
/**
* @brief Gets the launch option from the notification handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @remarks You must release @a app_control using app_control_destroy().
* @param[in] noti The notification handle
* @param[in] type Launching option type
* @param[out] option The pointer of App Control handler
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
...
{
app_control_h app_control = NULL;
app_control_create(&app_control);
...
noti_err = notification_get_launch_option(noti, NOTIFICATION_LAUNCH_OPTION_APP_CONTROL, (void *)&app_control);
if(noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
}
}
* @endcode
*/
int notification_get_launch_option(notification_h noti,
notification_launch_option_type type, void *option);
/**
* @brief Sets the handler for a specific event.
* @details When some event occurs on notification, application launched by app_control_send_launch_request with app_control handle.\n
* Setting event handler of a button means that the notification will show the button.
* @since_tizen 2.4
* @param[in] noti The notification handle
* @param[in] event_type event type
* @param[in] event_handler app control 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
* @see #notification_event_type_e
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
app_control_h app_control = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
...
app_control_create(&app_control);
app_control_set_app_id(app_control, "org.tizen.app");
...
noti_err = notification_set_event_handler(noti, NOTIFICATION_EVENT_TYPE_CLICK_ON_BUTTON_1, app_control);
if(noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
}
app_control_destroy(app_control);
}
* @endcode
*/
int notification_set_event_handler(notification_h noti, notification_event_type_e event_type, app_control_h event_handler);
/**
* @brief Gets the event handler of a specific event.
* @remarks You must release @a app_control using app_control_destroy().
* @since_tizen 2.4
* @param[in] noti The notification handle
* @param[in] event_type Launching option type
* @param[out] option The pointer of App Control handler
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @see #notification_event_type_e
* @par Sample code:
* @code
#include <notification.h>
...
{
app_control_h app_control = NULL;
app_control_create(&app_control);
...
noti_err = notification_get_event_handler(noti, NOTIFICATION_EVENT_TYPE_CLICK_ON_BUTTON_1, &app_control);
if(noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
}
}
* @endcode
*/
int notification_get_event_handler(notification_h noti, notification_event_type_e event_type, app_control_h *event_handler);
/**
* @brief Sets the property of the notification.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] flags The property with | operation
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
bundle *b = NULL;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
if(noti == NULL) {
return;
}
noti_err = notification_set_property(noti, NOTIFICATION_PROP_DISPLAY_ONLY_SIMMODE | NOTIFICATION_PROP_DISABLE_APP_LAUNCH);
if(noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
}
}
* @endcode
*/
int notification_set_property(notification_h noti,
int flags);
/**
* @brief Gets the property of the notification from the notification handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] flags The notification property
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
int flags = 0;
noti_err = notification_get_property(noti, &flags);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_get_property(notification_h noti,
int *flags);
/**
* @brief Sets applications to display the notification.
* @details All display application is enable(NOTIFICATION_DISPLAY_APP_ALL) if you are not call this API.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] applist The with | operation
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
bundle *b = NULL;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
if(noti == NULL) {
return;
}
noti_err = notification_set_display_applist(noti, NOTIFICATION_DISPLAY_APP_NOTIFICATION_TRAY | NOTIFICATION_DISPLAY_APP_TICKER | NOTIFICATION_DISPLAY_APP_INDICATOR);
if(noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
}
}
}
* @endcode
*/
int notification_set_display_applist(notification_h noti,
int applist);
/**
* @brief Gets the application list displaying the notification from the notification handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] applist The display application list
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
int applist = 0;
noti_err = notification_get_display_applist(noti, &applist);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_get_display_applist(notification_h noti,
int *applist);
/**
* @brief Sets the initial size for the ongoing type.
* @details After notification_post() call, the size is not updated.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] size The double type size
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
if(noti == NULL) {
return;
}
noti_err = notification_set_size(noti, 0.0);
if(noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
}
}
* @endcode
*/
int notification_set_size(notification_h noti,
double size);
/**
* @brief Gets the progress size.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] size The progress size
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
double size = 0.0;
noti_err = notification_get_size(noti, &size);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_get_size(notification_h noti,
double *size);
/**
* @brief Sets the initial progress for the ongoing type.
* @details After the notification_post() call, the progress is not updated.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] percentage The progress percentage
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
if(noti == NULL) {
return;
}
noti_err = notification_set_progress(noti, 0.0);
if(noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
}
}
* @endcode
*/
int notification_set_progress(notification_h noti,
double percentage);
/**
* @brief Gets the progress from the notification handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @remarks At the end of the operation, the progress should be @c 1.0.
* @param[in] noti The notification handle
* @param[out] percentage The progress percentage
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
double percentage = 0.0;
noti_err = notification_get_progress(noti, &percentage);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_get_progress(notification_h noti,
double *percentage);
/**
* @brief Sets the layout of the notification view.
* @details Caller can set displaying layout of notification.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] layout The type of layout
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @see #notification_ly_type_e
*/
int notification_set_layout(notification_h noti,
notification_ly_type_e layout);
/**
* @brief Gets the layout of the notification view from the notification handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] layout The type of layout
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @see #notification_ly_type_e
*/
int notification_get_layout(notification_h noti,
notification_ly_type_e *layout);
/**
* @brief Gets the type of a notification.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] type The notification type
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
...
{
int noti_err = NOTIFICATION_ERROR_NONE;
notification_type_e type;
noti_err = notification_get_type(noti, &type);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_get_type(notification_h noti,
notification_type_e * type);
/**
* @brief Updates notification data.
* @details The updated notification will appear in the notification area.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] noti The notification handle that is created by notification_create()
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @retval #NOTIFICATION_ERROR_NOT_EXIST_ID Priv ID does not exist
* @retval #NOTIFICATION_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @par Sample code:
* @code
#include <notification.h>
...
{
int noti_err = NOTIFICATION_ERROR_NONE;
noti_err = notification_update(NULL);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_update(notification_h noti);
/**
* @brief Deletes a notification with the given handle.
* @details notification_delete() removes notification data from database and notification_free() releases memory of notification data.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] noti The notification handle
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @retval NOTIFICATION_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @par Sample code:
* @code
#include <notification.h>
...
{
notificaton_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
...
noti_err = notification_delete(noti);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_delete(notification_h noti);
/**
* @brief Creates internal structure data and returns a notification handle.
* @details Available type is #NOTIFICATION_TYPE_NOTI and #NOTIFICATION_TYPE_ONGOING.
* #NOTIFICATION_TYPE_NOTI is remaining notification data even if device is restarted.
* #NOTIFICATION_TYPE_ONGOING can display progressive feather, but notification data is removed after device is restarted.
* @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] type The notification type
* @return Notification handle(notification_h) 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
* @exception #NOTIFICATION_ERROR_OUT_OF_MEMORY Out of memory
* @see #notification_type_e
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
if(noti == NULL) {
return;
}
...
}
* @endcode
*/
notification_h notification_create(notification_type_e type);
/**
* @brief Creates a notification clone.
* @details Newly created notification handle is returned.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @remarks This cloned notification handle should be freed using notification_free().
* @param[in] noti The notification handle
* @param[out] clone The newly created notification handle that has same with input @a noti
* @return #NOTIFICATION_ERROR_NONE if success,
* otherwise any other value if failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @see #notification_type_e
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = notification_create(NOTIFICATION_TYPE_NOTI);
notification_h clone = NULL;
notification_clone(noti, &clone);
...
}
* @endcode
*/
int notification_clone(notification_h noti, notification_h *clone);
/**
* @brief Frees the internal structure data of a notification handle.
* @details Internal data of a notification handle is released. Data of the inserted notification is not deleted.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification 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
* @pre Notification handle should be created by notification_create().
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
if(noti == NULL) {
return;
}
...
noti_err = notification_free(noti);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_free(notification_h noti);
/**
* @}
*/
/**
* @addtogroup NOTIFICATION_MODULE
* @{
*/
/**
* @brief Sets the tag of the notification handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti Notification handle
* @param[in] tag tag for loading notification handle
* @return #NOTIFICATION_ERROR_NONE on success, 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_get_tag()
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
if(noti == NULL) {
return;
}
...
noti_err = notification_set_tag(noti, tag);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_set_tag(notification_h noti, const char *tag);
/**
* @brief Gets the tag of the notification handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti Notification handle
* @param[out] tag tag for loading notification handle
* @return #NOTIFICATION_ERROR_NONE on success, 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_set_tag()
* @par Sample code:
* @code
#include <notification.h>
...
{
int noti_err = NOTIFICATION_ERROR_NONE;
const char *tag = NULL;
...
noti_err = notification_get_tag(noti, &tag);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_get_tag(notification_h noti, const char **tag);
/**
* @brief Loads a notification from the notification's database with the tag.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
* @param[in] tag tag for loading notification handle
* @return Notification handle(notification_h) 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
* @exception #NOTIFICATION_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @see #notification_type_e
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
noti = notification_load_by_tag(tag);
if(noti == NULL) {
return;
}
...
}
* @endcode
*/
notification_h notification_load_by_tag(const char *tag);
/**
* @brief Deletes all notifications of the given type.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] type Notification type
* @return #NOTIFICATION_ERROR_NONE if success, other value if failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @retval #NOTIFICATION_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @par Sample code:
* @code
#include <notification.h>
...
{
int noti_err = NOTIFICATION_ERROR_NONE;
noti_err = notification_delete_all(NOTIFICATION_TYPE_NOTI);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_delete_all(notification_type_e type);
/**
* @brief Posts a notification.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] noti Notification 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
* @pre Notification handle should be created by notification_create().
* @post notification_free().
* @par Sample code:
* @code
#include <notification.h>
...
{
int noti_err = NOTIFICATION_ERROR_NONE;
noti_err = notification_post(noti);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_post(notification_h noti);
/**
* @brief Gets the package name of the notification
* @since_tizen 2.4
* @param[in] noti Notification handle
* @param[out] pkgname The package name of the notification
* @return #NOTIFICATION_ERROR_NONE on success, otherwise a negative error value
* @retval NOTIFICATION_ERROR_NONE Success
* @retval NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
char *pkgname = NULL;
...
noti_err = notification_get_pkgname(noti, &pkgname);
if(noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
}
}
* @endcode
*/
int notification_get_pkgname(notification_h noti, char **pkgname);
/**
* @brief Adds a button on the notification
* @since_tizen 2.4
* @param[in] noti Notification handle
* @param[in] button_index Button index
* @return #NOTIFICATION_ERROR_NONE on success, otherwise a negative error value
* @retval NOTIFICATION_ERROR_NONE Success
* @retval NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
char *pkgname = NULL;
...
noti_err = notification_add_button(noti, NOTIFICATION_BUTTON_1);
if(noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
}
}
* @endcode
*/
int notification_add_button(notification_h noti, notification_button_index_e button_index);
/**
* @brief Removes a button on the notification
* @since_tizen 2.4
* @param[in] noti Notification handle
* @param[in] button_index Button index
* @return #NOTIFICATION_ERROR_NONE on success, otherwise a negative error value
* @retval NOTIFICATION_ERROR_NONE Success
* @retval NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
char *pkgname = NULL;
...
noti_err = notification_remove_button(noti, NOTIFICATION_BUTTON_1);
if(noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
}
}
* @endcode
*/
int notification_remove_button(notification_h noti, notification_button_index_e button_index);
/**
* @brief Sets the 'auto remove' option of the active notification
* @details The 'auto remove' option let the active notification be removed in several seconds after it shows. Default value is true.
* @remarks When 'auto_remove' is set as false, the active notification will not be removed
as long as the user removes the active notification or the app which posted the active notification removes the active notification.
* @since_tizen 2.4
* @param[in] noti Notification handle
* @param[in] auto_remove Auto remove option
* @return #NOTIFICATION_ERROR_NONE On success, other value if failure
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @see #notification_h
* @see #notification_get_auto_remove
* @par Sample code:
* @code
#include <notification.h>
...
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
...
noti_err = notification_set_auto_remove(noti, false);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_set_auto_remove(notification_h noti, bool auto_remove);
/**
* @brief Gets the 'auto remove' option of the active notification
* @details The 'auto remove' option let the active notification be removed in several seconds after it shows. Default value is true.
* @since_tizen 2.4
* @param[in] noti Notification handle
* @param[out] auto_remove Auto remove option
* @return #NOTIFICATION_ERROR_NONE On success, other value on failure
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @see #notification_h
* @see #notification_get_auto_remove
* @par Sample code:
* @code
#include <notification.h>
...
{
int noti_err = NOTIFICATION_ERROR_NONE;
bool auto_remove;
...
noti_err = notification_get_auto_remove(noti, &auto_remove);
if(noti_err != NOTIFICATION_ERROR_NONE) {
return;
}
}
* @endcode
*/
int notification_get_auto_remove(notification_h noti, bool *auto_remove);
/* For backward compatibility */
/**
* @brief Wait for a response coming for this notification
* @details The notification should have the EXECUTE_TYPE_RESPONDING flag
* @remarks
* @param[in] noti notification handle
* @param[in] timeout in seconds - 0 for infinite
* @param[out] integer response
* @param[out] text response
* @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_OUT_OF_MEMORY - not enough memory
* @pre notification handle should be created by notification_new().
* @post
* @see
*/
int notification_wait_response(notification_h noti,
int timeout,
int *respi,
char **respc);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif /* __NOTIFICATION_H__ */
|