4 * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
6 * Contact: Venkatesha Sarpangala <sarpangala.v@samsung.com>, Jayoun Lee <airjany@samsung.com>,
7 * Sewook Park <sewook7.park@samsung.com>, Jaeho Lee <jaeho81.lee@samsung.com>
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
31 * @addtogroup APPLICATION_FRAMEWORK
34 * @defgroup Alarm Alarm
38 * Alarm supports APIs that add, delete, and update an alarm.
39 * @n An application can use alarm APIs by including @c alarm.h. The definitions
40 * of APIs are defined as follows:
42 * @li @c #alarmmgr_init initialize alarm library
43 * @li @c #alarmmgr_set_cb set the callback for an alarm event
44 * @li @c #alarmmgr_create_alarm create an alarm entry
45 * @li @c #alarmmgr_free_alarm free an alarm entry
46 * @li @c #alarmmgr_set_time set a time will be expired
47 * @li @c #alarmmgr_get_time get a time will be expired
48 * @li @c #alarmmgr_set_repeat_mode set repeat mode
49 * @li @c #alarmmgr_get_repeat_mode get repeat mode
50 * @li @c #alarmmgr_set_type set type
51 * @li @c #alarmmgr_get_type get type
52 * @li @c #alarmmgr_add_alarm_with_localtime add an alarm with localtime
53 * @li @c #alarmmgr_add_alarm add an alarm
54 * @li @c #alarmmgr_remove_alarm remove an alarm from alarm server
55 * @li @c #alarmmgr_enum_alarm_ids get the list of alarm ids
56 * @li @c #alarmmgr_get_info get the information of an alarm
59 * The following code shows how to initialize alarm library, how to register the alarm handler, and how to add an alarm. It first calls alarm_init to initialize the alarm library and sets the callback to handle an alarm event it received. In create_test fucnction, the application add an alarm which will be expired in one minute from it execute and will expire everyday at same time.
69 int callback(alarm_id_t alarm_id, void *user_param)
75 printf("Alarm[%d] has expired at %s\n", alarm_id, ctime(¤t_time));
83 alarm_entry_t* alarm_info;
86 alarm_date_t test_time;
90 printf("current time: %s\n", ctime(¤t_time));
91 localtime_r(¤t_time, ¤t_tm);
93 alarm_info = alarmmgr_create_alarm();
95 test_time.year = current_tm.tm_year+1900;
96 test_time.month = current_tm.tm_mon+1;
97 test_time.day = current_tm.tm_mday;
98 test_time.hour = current_tm.tm_hour;
99 test_time.min = current_tm.tm_min+1;
102 alarmmgr_set_time(alarm_info,test_time);
103 alarmmgr_set_repeat_mode(alarm_info,ALARM_REPEAT_MODE_WEEKLY,
105 ALARM_WDAY_TUESDAY|ALARM_WDAY_WEDNESDAY| \
106 ALARM_WDAY_THURSDAY|ALARM_WDAY_FRIDAY );
108 alarmmgr_set_type(alarm_info,ALARM_TYPE_VOLATILE);
109 alarmmgr_add_alarm_with_localtime(alarm_info,NULL,&alarm_id);
111 if(result != ALARMMGR_RESULT_SUCCESS)
112 printf("fail to alarmmgr_create : error_code : %d\n",result);
116 int main(int argc, char** argv)
123 mainloop = g_main_loop_new(NULL, FALSE);
124 result = alarmmgr_init("org.tizen.test");
126 if(result != ALARMMGR_RESULT_SUCCESS) {
127 printf("fail to alarmmgr_init : error_code : %d\n",result);
130 result = alarmmgr_set_cb(callback,NULL);
131 if(result != ALARMMGR_RESULT_SUCCESS) {
132 printf("fail to alarmmgr_set_cb : error_code :
139 g_main_loop_run(mainloop);
151 #include<sys/types.h>
159 * Type of an alarm id
161 typedef int alarm_id_t;
163 * The prototype of alarm handler.
164 * param [in] alarm_id the id of expired alarm
166 typedef int (*alarm_cb_t) (alarm_id_t alarm_id, void *user_param);
168 typedef int (*alarm_enum_fn_t) (alarm_id_t alarm_id, void *user_param);
171 * This enumeration has day of a week of alarm
174 ALARM_WDAY_SUNDAY = 0x01, /**< enalbe alarm on Sunday*/
175 ALARM_WDAY_MONDAY = 0x02, /**< enalbe alarm on Monday*/
176 ALARM_WDAY_TUESDAY = 0x04, /**< enable alarm on Tuesday*/
177 ALARM_WDAY_WEDNESDAY = 0x08, /**< enalbe alarm on Wednesday*/
178 ALARM_WDAY_THURSDAY = 0x10, /**< enable alarm on Thursday*/
179 ALARM_WDAY_FRIDAY = 0x20, /**< enable alarm on Friday*/
180 ALARM_WDAY_SATURDAY = 0x40,/**< enable alarm on Saturday*/
181 } alarm_day_of_week_t;
184 * This enumeration has error codes of alarm
187 ERR_ALARM_INVALID_PARAM = -10,
188 /**<Invalid parameter*/
189 ERR_ALARM_INVALID_ID, /**<Invalid id*/
190 ERR_ALARM_INVALID_REPEAT,
191 /**<Invalid repeat mode*/
192 ERR_ALARM_INVALID_TIME, /**<Invalid time. */
193 ERR_ALARM_INVALID_DATE, /**<Invalid date. */
194 ERR_ALARM_NO_SERVICE_NAME,
195 /**<there is no alarm service
196 for this applicaation. */
197 ERR_ALARM_INVALID_TYPE, /*Invalid type*/
198 ERR_ALARM_NO_PERMISSION, /*No permission*/
199 ERR_ALARM_SYSTEM_FAIL = -1,
200 ALARMMGR_RESULT_SUCCESS = 0,
204 * This enumeration has repeat mode of alarm
207 ALARM_REPEAT_MODE_ONCE = 0, /**<once : the alarm will be expired
209 ALARM_REPEAT_MODE_REPEAT, /**<repeat : the alarm will be expired
211 ALARM_REPEAT_MODE_WEEKLY, /**<weekly*/
212 ALARM_REPEAT_MODE_MONTHLY, /**< monthly*/
213 ALARM_REPEAT_MODE_ANNUALLY, /**< annually*/
214 ALARM_REPEAT_MODE_MAX,
215 } alarm_repeat_mode_t;
218 #define ALARM_TYPE_DEFAULT 0x0 /*< non volatile */
219 #define ALARM_TYPE_VOLATILE 0x02 /*< volatile */
220 #define ALARM_TYPE_NOLAUNCH 0x04 /*<without launch */
224 * This struct has date information
227 int year; /**< specifies the year */
228 int month; /**< specifies the month */
229 int day; /**< specifies the day */
230 int hour; /**< specifies the hour */
231 int min; /**< specifies the minute*/
232 int sec; /**< specifies the second*/
236 typedef struct alarm_info_t alarm_entry_t;
241 * This function initializes alarm library. It connects to system bus and registers the application's service name.
243 * @param [in] pkg_name a package of application
245 * @return On success, ALARMMGR_RESULT_SUCCESS is returned. On error, a negative number is returned
250 * @remark An application must call this function before using other alarm APIs.
257 int ret_val = ALARMMGR_RESULT_SUCCESS;
258 const char* pkg_name = "org.tizen.test";
262 ret_val =alarmmgr_init(pkg_name) ;
263 if(ret_val == ALARMMGR_RESULT_SUCCESS)
265 //alarmmgr_init() is successful
269 //alarmmgr_init () failed
275 int alarmmgr_init(const char *appid);
279 * This function de-initializes alarm library. It un-registers the application's service name and dis-connects from system bus.
285 * @pre Alarm manager is initialized
286 * @post Alarm manager is de-initialized
287 * @remark An application must call this function once it is done with alarmmanger usage
294 // Initialize alarmmanager
302 void alarmmgr_fini();
306 * This function registers handler which handles an alarm event. An application should register the alarm handler
307 * before it enters mainloop.
309 * @param [in] handler Callback function
310 * @param [in] user_param User Parameter
312 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
314 * @pre alarmmgr_init().
317 * @remark An application can have only one alarm handler. If an application
318 * calls this function more than one times, the handler regitered during the
319 * last call of this funiction will be called when an alarm event has occured.
325 // Call back function
326 int callback(alarm_id_t alarm_id,void* user_param)
331 printf("Alarm[%d] has expired at %s\n", alarm_id, ctime(¤t_time));
339 int ret_val = ALARMMGR_RESULT_SUCCESS;
340 void *user_param = NULL;
342 ret_val = alarmmgr_set_cb( callback, user_param);
343 if(ret_val == ALARMMGR_RESULT_SUCCESS)
345 //alarmmgr_set_cb() is successful
349 //alarmmgr_set_cb () failed
356 int alarmmgr_set_cb(alarm_cb_t handler, void *user_param);
360 * This function creates a new alarm entry, will not be known to the server until alarmmgr_add_alarm is called.
362 * @return This function returns the pointer of alarm_entry_t
367 * @remark After an application use this object, an application free this pointer through alarmmgr_free_alarm
375 alarm_entry_t* alarm;
377 alarm = alarmmgr_create_alarm() ;
380 //alarmmgr_create_alarm() is successful
384 //alarmmgr_create_alarm () failed
392 alarm_entry_t *alarmmgr_create_alarm(void);
396 * This function frees an alarm entry.
398 * @param [in] alarm alarm entry
400 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
413 int ret_val = ALARMMGR_RESULT_SUCCESS;
414 alarm_entry_t* alarm;
416 alarm = alarmmgr_create_alarm() ;
419 //alarmmgr_create_alarm () failed
424 ret_val = alarmmgr_free_alarm( alarm) ;
425 if(ret_val == ALARMMGR_RESULT_SUCCESS)
427 //alarmmgr_free_alarm() is successful
431 //alarmmgr_free_alarm() failed
439 int alarmmgr_free_alarm(alarm_entry_t *alarm);
443 * This function sets time that alarm should be expried.
445 * @param [in] alarm alarm entry
446 * @param [in] time time the alarm should first go off
448 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
461 int ret_val = ALARMMGR_RESULT_SUCCESS;
462 alarm_entry_t* alarm;
464 struct tm current_tm;
465 alarm_date_t test_time;
469 localtime_r(¤t_time, ¤t_tm);
471 alarm = alarmmgr_create_alarm();
474 //alarmmgr_create_alarm () failed
477 test_time.year = current_tm.tm_year;
478 test_time.month = current_tm.tm_mon;
479 test_time.day = current_tm.tm_mday;
481 test_time.hour = current_tm.tm_hour;
482 test_time.min = current_tm.tm_min+1;
485 ret_val=alarmmgr_set_time(alarm,test_time);
486 if(ret_val == ALARMMGR_RESULT_SUCCESS)
488 //alarmmgr_set_time() is successful
492 //alarmmgr_set_time() failed
494 alarmmgr_free_alarm( alarm) ;
501 int alarmmgr_set_time(alarm_entry_t *alarm, alarm_date_t time);
504 * This function gives an application time that alarm should be expried.
506 * @param [in] alarm alarm entry
507 * @param [out] time time the alarm should first go off
509 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
514 * @remark But an application does not need to specify year, month, and day field of alarm_info. If an application sets
515 * those fields with zero, the function sets them with proper values.
523 int ret_val = ALARMMGR_RESULT_SUCCESS;
524 alarm_entry_t* alarm;
527 struct tm current_tm;
528 alarm_date_t test_time;
529 alarm_date_t new_time;
533 localtime_r(¤t_time, ¤t_tm);
535 alarm = alarmmgr_create_alarm();
537 //alarmmgr_create_alarm () failed
540 test_time.year = current_tm.tm_year;
541 test_time.month = current_tm.tm_mon;
542 test_time.day = current_tm.tm_mday;
544 test_time.hour = current_tm.tm_hour;
545 test_time.min = current_tm.tm_min+1;
548 ret_val = alarmmgr_set_time(alarm,test_time);
549 if(ret_val == ALARMMGR_RESULT_SUCCESS) {
550 //alarmmgr_set_time() is successful
553 //alarmmgr_set_time() failed
556 ret_val = alarmmgr_get_time(alarm, &new_time);
557 if(ret_val == ALARMMGR_RESULT_SUCCESS) {
558 //alarmmgr_get_time() is successful
561 //alarmmgr_get_time() failed
563 alarmmgr_free_alarm( alarm) ;
570 int alarmmgr_get_time(const alarm_entry_t *alarm, alarm_date_t *time);
573 * This function sets an alarm repeat mode
575 * @param [in] alarm alarm entry
576 * @param [in] repeat_mode one of ALARM_REPEAT_MODE_ONCE, ALARM_REPEAT_MODE_REPEAT,
577 * ALARM_REPEAT_MODE_WEEKLY, ALARM_REPEAT_MODE_MONTHLY or ALARM_REPEAT_MODE_ANNUALLY.
578 * @param [in] repeat_value the ALARM_REPEAT_MODE_REPEAT mode : interval between subsequent repeats of the alarm.
579 * the ALARM_REPEAT_MODE_WEEKLY mode : days of a week
580 * (ALARM_WDAY_SUNDAY, ALARM_WDAY_MONDAY, ALARM_WDAY_TUESDAY, ALARM_WDAY_WEDNESDAY,
581 * ALARM_WDAY_THURSDAY, ALARM_WDAY_FRIDAY, ALARM_WDAY_SATURDAY)
582 * the others : this parameter is ignored.
584 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
597 int ret_val = ALARMMGR_RESULT_SUCCESS;
598 alarm_entry_t* alarm;
599 alarm_repeat_mode_t repeat_mode =ALARM_REPEAT_MODE_WEEKLY;
600 int interval = ALARM_WDAY_MONDAY; //| ALARM_WDAY_TUESDAY|
601 ALARM_WDAY_WEDNESDAY| ALARM_WDAY_THURSDAY|ALARM_WDAY_FRIDAY ;
604 alarm = alarmmgr_create_alarm();
607 //alarmmgr_create_alarm () failed
611 ret_val = alarmmgr_set_repeat_mode
612 (alarm, repeat_mode,interval);
614 if(ret_val == ALARMMGR_RESULT_SUCCESS)
616 //alarmmgr_set_repeat_mode() is successful
620 //alarmmgr_set_repeat_mode() failed
622 alarmmgr_free_alarm( alarm) ;
629 int alarmmgr_set_repeat_mode(alarm_entry_t *alarm,
630 alarm_repeat_mode_t repeat_mode,
634 * This function gives an application an alarm mode
636 * @param [in] alarm alarm entry
637 * @param [out] repeat_mode one of ALARM_REPEAT_MODE_ONCE, ALARM_REPEAT_MODE_REPEAT,
638 * ALARM_REPEAT_MODE_WEEKLY, ALARM_REPEAT_MODE_MONTHLY or ALARM_REPEAT_MODE_ANNUALLY.
639 * @param [out] repeat_value the ALARM_REPEAT_MODE_REPEAT mode : interval between subsequent repeats of the alarm.
640 * the ALARM_REPEAT_MODE_WEEKLY mode : days of a week
641 * (ALARM_WDAY_SUNDAY, ALARM_WDAY_MONDAY, ALARM_WDAY_TUESDAY, ALARM_WDAY_WEDNESDAY,
642 * ALARM_WDAY_THURSDAY, ALARM_WDAY_FRIDAY, ALARM_WDAY_SATURDAY)
643 * the others : this parameter is ignored.
645 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
658 int ret_val = ALARMMGR_RESULT_SUCCESS;
659 alarm_entry_t* alarm;
660 alarm_repeat_mode_t repeat;
663 alarm = alarmmgr_create_alarm();
666 //alarmmgr_create_alarm () failed
669 ret_val =alarmmgr_get_repeat_mode
670 (alarm, &repeat, &interval) ;
671 if(ret_val == ALARMMGR_RESULT_SUCCESS
672 && repeat == ALARM_REPEAT_MODE_ONCE) {
673 //alarmmgr_get_repeat_mode() is successful
676 //alarmmgr_get_repeat_mode() failed
678 alarmmgr_free_alarm(alarm) ;
685 int alarmmgr_get_repeat_mode(const alarm_entry_t *alarm,
686 alarm_repeat_mode_t *repeat_mode,
690 * This function sets an alarm mode
692 * @param [in] alarm alarm entry
693 * @param [in] alarm_type one of ALARM_TYPE_DEFAULT : After the device reboot, the alarm still works.
694 * ALARM_TYPE_VOLATILE : After the device reboot, the alarm does not work.
696 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
709 int ret_val = ALARMMGR_RESULT_SUCCESS;
710 alarm_entry_t* alarm;
711 int alarm_type = ALARM_TYPE_VOLATILE;
713 alarm = alarmmgr_create_alarm();
716 //alarmmgr_create_alarm () failed
720 ret_val = alarmmgr_set_type(alarm, alarm_type);
721 if(ret_val == ALARMMGR_RESULT_SUCCESS)
723 //alarmmgr_set_type() is successful
727 //alarmmgr_set_type() failed
729 alarmmgr_free_alarm( alarm) ;
736 int alarmmgr_set_type(alarm_entry_t *alarm, int alarm_type);
739 * This function gives an application an alarm mode
741 * @param [in] alarm alarm entry
742 * @param [out] alarm_type one of ALARM_TYPE_DEFAULT, ALARM_TYPE_VOLATILE
744 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
757 int ret_val = ALARMMGR_RESULT_SUCCESS;
758 alarm_entry_t* alarm;
761 alarm = alarmmgr_create_alarm();
763 //alarmmgr_create_alarm () failed
766 ret_val = alarmmgr_get_type( alarm, &alarm_type);
767 if(ret_val == ALARMMGR_RESULT_SUCCESS && alarm_type
768 == ALARM_TYPE_DEFAULT ) {
769 //alarmmgr_get_type() is successful
772 //alarmmgr_get_type() failed
774 alarmmgr_free_alarm( alarm) ;
781 int alarmmgr_get_type(const alarm_entry_t *alarm, int *alarm_type);
784 * This function adds an alarm entry to the server.
785 * Server will remember this entry, and generate alarm events for it when necessary.
786 * Server will call app-svc interface to sent notification to destination application. Destination information
787 * should be available in the input bundle.
788 * Alarm entries registered with the server cannot be changed.
789 * Remove from server before changing.
790 * Before the application calls alarmmgr_add_alarm_appsvc_with_localtime(), the application have to call alarmmgr_set_time().
791 * The time set is localtime.
792 * If the application does not call alarmmgr_set_repeat_mode, the default repeat_mode is ALARM_REPEAT_MODE_ONCE.
793 * If the application does not call alarmmgr_set_type, the default alarm_type is ALARM_TYPE_DEFAULT.
794 * The id of the new alarm will be copied to alarm_id if the fuction successes to create an alarm.
796 * @param [in] alarm the entry of an alarm to be created.
797 * @param [in] bundle_data bundle which contains information about the destination.
798 * @param [out] alarm_id the id of the alarm added.
800 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
804 * @see alarmmgr_add_alarm
814 struct tm current_tm;
815 alarm_entry_t* alarm_info;
818 alarm_date_t test_time;
827 printf("Unable to create bundle!!!\n");
831 appsvc_set_operation(b,APPSVC_OPERATION_DEFAULT);
832 appsvc_set_pkgname(b,"org.tizen.alarm-test");
836 printf("current time: %s\n", ctime(¤t_time));
837 localtime_r(¤t_time, ¤t_tm);
839 alarm_info = alarmmgr_create_alarm();
841 test_time.year = current_tm.tm_year;
842 test_time.month = current_tm.tm_mon;
843 test_time.day = current_tm.tm_mday;
845 test_time.hour = current_tm.tm_hour;
846 test_time.min = current_tm.tm_min+1;
850 alarmmgr_set_time(alarm_info,test_time);
851 alarmmgr_set_repeat_mode(alarm_info,ALARM_REPEAT_MODE_WEEKLY,ALARM_WDAY_MONDAY| \
852 ALARM_WDAY_TUESDAY|ALARM_WDAY_WEDNESDAY| \
853 ALARM_WDAY_THURSDAY|ALARM_WDAY_FRIDAY );
855 alarmmgr_set_type(alarm_info, ALARM_TYPE_DEFAULT);
856 //alarmmgr_set_type(alarm_info,ALARM_TYPE_VOLATILE);
857 if ((result = alarmmgr_add_alarm_appsvc_with_localtime(alarm_info,(void *)b,&alarm_id)) < 0)
859 printf("Alarm creation failed!!! Alrmgr error code is %d\n",result);
863 printf("Alarm created succesfully with alarm id %d\n",alarm_id);
870 int alarmmgr_add_alarm_appsvc_with_localtime(alarm_entry_t *alarm,void *bundle_data, alarm_id_t *alarm_id);
873 * This function adds an alarm entry to the server.
874 * Server will remember this entry, and generate alarm events for it when necessary.
875 * Alarm entries registered with the server cannot be changed.
876 * Remove from server before changing.
877 * Before the application calls alarmmgr_add_alarm_with_localtime(), the application have to call alarmmgr_set_time().
878 * The time set is localtime.
879 * If the application does not call alarmmgr_set_repeat_mode, the default repeat_mode is ALARM_REPEAT_MODE_ONCE.
880 * If the application does not call alarmmgr_set_type, the default alarm_type is ALARM_TYPE_DEFAULT.
881 * The id of the new alarm will be copied to alarm_id if the fuction successes to create an alarm.
883 * @param [in] alarm the entry of an alarm to be created.
884 * @param [in] destination the packname of application that the alarm will be expired.
885 * @param [out] alarm_id the id of the alarm added.
887 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
891 * @see alarmmgr_add_alarm
900 int ret_val = ALARMMGR_RESULT_SUCCESS;
901 alarm_entry_t* alarm;
902 const char* destination = NULL;
906 struct tm current_tm;
907 alarm_date_t test_time;
909 const char* pkg_name = "org.tizen.test";
913 ret_val =alarmmgr_init(pkg_name) ;
914 if(ret_val != ALARMMGR_RESULT_SUCCESS) {
915 //alarmmgr_init () failed
921 printf("current time: %s\n", ctime(¤t_time));
922 localtime_r(¤t_time, ¤t_tm);
924 alarm = alarmmgr_create_alarm();
927 test_time.month = 0;test_time.day = 0;
929 test_time.hour = current_tm.tm_hour;
930 test_time.min = current_tm.tm_min+1;
934 alarmmgr_set_time(alarm,test_time);
935 alarmmgr_set_repeat_mode(alarm,ALARM_REPEAT_MODE_WEEKLY, \
937 alarmmgr_set_type(alarm,ALARM_TYPE_VOLATILE);
940 ret_val=alarmmgr_add_alarm_with_localtime(alarm,destination,&alarm_id);
942 if(ret_val == ALARMMGR_RESULT_SUCCESS)
944 //alarmmgr_add_alarm_with_localtime() is successful
948 //alarmmgr_add_alarm_with_localtime() failed
950 alarmmgr_free_alarm( alarm) ;
955 int alarmmgr_add_alarm_with_localtime(alarm_entry_t *alarm,
956 const char *destination,
957 alarm_id_t *alarm_id);
961 * This function adds an alarm entry to the server.
962 * Server will remember this entry, and generate alarm events for it when necessary.
963 * Server will call app-svc interface to sent notification to destination application. Destination information
964 * should be available in the input bundle.
965 * Alarm entries registered with the server cannot be changed.
966 * Remove from server before changing.
967 * After the trigger_at_time seconds from now, the alarm will be expired.
968 * If the interval is zero, the repeat_mode is ALARM_REPEAT_MODE_ONCE.
969 * If the interval is >0, the repeat_mode is ALARM_REPEAT_MODE_REPEAT.
970 * The id of the new alarm will be copied to alarm_id if the fuction successes to create an alarm.
972 * @param [in] alarm_type one of ALARM_TYPE_DEFAULT, ALARM_TYPE_VOLATILE
973 * @param [in] trigger_at_time time interval to be triggered from now(sec). an alarm also will be expired at triggering time.
974 * @param [in] interval Interval between subsequent repeats of the alarm
975 * @param [in] bundle_data bundle which contains information about the destination.
976 * @param [out] alarm_id the id of the alarm added.
978 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
982 * @see alarmmgr_add_alarm_with_localtime alarmmgr_remove_alarm
1000 printf("Unable to create bundle!!!\n");
1004 appsvc_set_pkgname(b,"org.tizen.alarm-test");
1005 //appsvc_set_operation(b,APPSVC_OPERATION_SEND_TEXT);
1006 appsvc_set_operation(b,APPSVC_OPERATION_DEFAULT);
1008 if ((result = alarmmgr_add_alarm_appsvc(ALARM_TYPE_DEFAULT, 10, 0, (void *)b ,&alarm_id)))
1009 printf("Unable to add alarm. Alarmmgr alarm no is %d\n", result);
1011 printf("Alarm added successfully. Alarm Id is %d\n", alarm_id);
1019 int alarmmgr_add_alarm_appsvc(int alarm_type, time_t trigger_at_time,
1020 time_t interval, void *bundle_data,
1021 alarm_id_t *alarm_id);
1025 * This function adds an alarm entry to the server.
1026 * Server will remember this entry, and generate alarm events for it when necessary.
1027 * Alarm entries registered with the server cannot be changed.
1028 * Remove from server before changing.
1029 * After the trigger_at_time seconds from now, the alarm will be expired.
1030 * If the interval is zero, the repeat_mode is ALARM_REPEAT_MODE_ONCE.
1031 * If the interval is >0, the repeat_mode is ALARM_REPEAT_MODE_REPEAT.
1032 * The id of the new alarm will be copied to alarm_id if the fuction successes to create an alarm.
1034 * @param [in] alarm_type one of ALARM_TYPE_DEFAULT, ALARM_TYPE_VOLATILE
1035 * @param [in] trigger_at_time time interval to be triggered from now(sec). an alarm also will be expired at triggering time.
1036 * @param [in] interval Interval between subsequent repeats of the alarm
1037 * @param [in] destination the packname of application that the alarm will be expired.
1038 * @param [out] alarm_id the id of the alarm added.
1040 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
1044 * @see alarmmgr_add_alarm_with_localtime alarmmgr_remove_alarm
1053 int ret_val = ALARMMGR_RESULT_SUCCESS;
1055 int alarm_type = ALARM_TYPE_VOLATILE;
1056 time_t trigger_at_time = 10;
1057 time_t interval = 10;
1058 const char* destination = NULL;
1059 alarm_id_t alarm_id;
1061 const char* pkg_name = "org.tizen.test";
1065 ret_val =alarmmgr_init(pkg_name) ;
1066 if(ret_val != ALARMMGR_RESULT_SUCCESS)
1068 //alarmmgr_init () failed
1072 ret_val = alarmmgr_add_alarm( alarm_type, trigger_at_time, interval,
1073 destination, &alarm_id);
1074 if(ret_val == ALARMMGR_RESULT_SUCCESS)
1076 //alarmmgr_add_alarm() is successful
1080 //alarmmgr_add_alarm() failed
1082 alarmmgr_remove_alarm( alarm_id) ;
1088 int alarmmgr_add_alarm(int alarm_type, time_t trigger_at_time,
1089 time_t interval, const char *destination,
1090 alarm_id_t *alarm_id);
1093 * This function deletes the alarm associated with the given alarm_id.
1095 * @param [in] alarm_id Specifies the ID of the alarm to be deleted.
1097 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
1101 * @see alarmmgr_add_alarm_with_localtime alarmmgr_add_alarm
1110 int ret_val = ALARMMGR_RESULT_SUCCESS;
1111 int alarm_type = ALARM_TYPE_VOLATILE;
1112 time_t trigger_at_time = 10;
1113 time_t interval = 10;
1114 const char* destination = NULL;
1115 alarm_id_t alarm_id;
1117 const char* pkg_name = "org.tizen.test";
1121 ret_val =alarmmgr_init(pkg_name) ;
1122 if(ret_val != ALARMMGR_RESULT_SUCCESS) {
1123 //alarmmgr_init () failed
1127 alarmmgr_add_alarm( alarm_type, trigger_at_time, interval,
1128 destination, &alarm_id);
1130 ret_val =alarmmgr_remove_alarm( alarm_id) ;
1131 if(ret_val == ALARMMGR_RESULT_SUCCESS) {
1132 /alarmmgr_remove_alarm() is successful
1135 //alarmmgr_remove_alarm() failed
1142 int alarmmgr_remove_alarm(alarm_id_t alarm_id);
1145 * This function gives a list of alarm ids that the application adds to the server.
1147 * @param [in] fn a user callback function
1148 * @param [in] user_param user parameter
1150 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
1154 * @see alarm_get_info
1161 int callback_2(alarm_id_t id, void* user_param)
1163 int* n = (int*)user_param;
1164 printf("[%d]alarm id : %d\n",*n,id);
1171 int ret_val = ALARMMGR_RESULT_SUCCESS;
1174 const char* pkg_name = "org.tizen.test";
1178 ret_val =alarmmgr_init(pkg_name) ;
1179 if(ret_val != ALARMMGR_RESULT_SUCCESS)
1181 //alarmmgr_init() failed
1185 ret_val = alarmmgr_enum_alarm_ids( callback_2, (void*)&n) ;
1186 if(ret_val == ALARMMGR_RESULT_SUCCESS)
1188 //alarmmgr_enum_alarm_ids() is successful
1192 //alarmmgr_enum_alarm_ids() failed
1199 int alarmmgr_enum_alarm_ids(alarm_enum_fn_t fn, void *user_param);
1203 * This function gets the information of the alarm assosiated with alarm_id to alarm_info. The application
1204 * must allocate alarm_info before calling this function.
1206 * @param [in] alarm_id the id of the alarm
1207 * @param [out] alarm the buffer alarm informaiton will be copied to
1209 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
1213 * @see alarmmgr_enum_alarm_ids
1222 int ret_val = ALARMMGR_RESULT_SUCCESS;
1223 int alarm_type = ALARM_TYPE_VOLATILE;
1224 time_t trigger_at_time = 10;
1225 time_t interval = ALARM_WDAY_SUNDAY;
1226 const char* destination = NULL;
1227 alarm_id_t alarm_id;
1229 alarm_entry_t *alarm;
1231 const char* pkg_name = "org.tizen.test_get_info1";
1235 ret_val =alarmmgr_init(pkg_name) ;
1236 if(ret_val != ALARMMGR_RESULT_SUCCESS) {
1237 //alarmmgr_init() failed
1240 ret_val = alarmmgr_add_alarm( alarm_type,trigger_at_time,interval,
1241 destination, &alarm_id);
1243 if(ret_val != ALARMMGR_RESULT_SUCCESS) {
1244 //alarmmgr_add_alarm() failed
1247 ret_val = alarmmgr_get_info(alarm_id, alarm);
1248 if(ret_val == ALARMMGR_RESULT_SUCCESS) {
1249 //alarmmgr_get_info() is successful
1252 //alarmmgr_get_info() failed
1254 alarmmgr_remove_alarm( alarm_id) ;
1259 int alarmmgr_get_info(alarm_id_t alarm_id, alarm_entry_t *alarm);
1263 * This function retrieves bundle associated with alarm.
1264 * Server will remember this entry, and pass the bundle information upon alarm expiry.
1265 * Server will call app-svc interface to sent notification to destination application. Destination information
1266 * should be available in the input bundle.
1267 * @param [in] alarm_id alarm id
1268 * @param [out] ALARMMGR_RESULT_SUCCESS on success or negative number on failure.
1270 * @return This function returns bundle on success or NULL on failure.
1283 alarm_id_t alarm_id;
1292 printf("Unable to create bundle!!!\n");
1296 appsvc_set_pkgname(b,"org.tizen.alarm-test");
1297 appsvc_set_operation(b,APPSVC_OPERATION_DEFAULT);
1299 if ((result = alarmmgr_add_alarm_appsvc(ALARM_TYPE_DEFAULT, 10, 0, (void *)b ,&alarm_id)))
1300 printf("Unable to add alarm. Alarmmgr alarm no is %d\n", result);
1302 printf("Alarm added successfully. Alarm Id is %d\n", alarm_id);
1304 int main(int argc,char **argv {
1307 int return_code = 0;
1309 b = alarmmgr_get_alarm_appsvc_info(alarm_id, &return_code);
1311 const char *pkgname = appsvc_get_pkgname(b);
1313 printf("Package name is %s\n",pkgname);
1323 void *alarmmgr_get_alarm_appsvc_info(alarm_id_t alarm_id, int *return_code);
1328 * This function sets power RTC (which can power on the system).
1329 * @param [in] alarm_date_t time
1331 * @return This function returns the result. On success, ALARMMGR_RESULT_SUCCESS will be returned
1332 * else, appropriate error no will be returned.
1344 alarm_date_t alarm_date={2012,04,05,10,10,00};
1346 int main(int argc,char **argv {
1347 int return_code = 0;
1348 return_code = alarmmgr_set_rtc_time(&alarm_date);
1349 if (return_code != ALARMMGR_RESULT_SUCCESS){
1350 printf("Error returned is %d\n",return_code);
1358 int alarmmgr_set_rtc_time(alarm_date_t *time);
1360 int alarmmgr_add_alarm_withcb(int alarm_type, time_t trigger_at_time,
1361 time_t interval, alarm_cb_t handler, void *user_param, alarm_id_t *alarm_id);
1373 int alarmmgr_power_on(bool on_off);
1380 #endif/* ALARM_LIB_H*/