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 */
223 * This struct has date information
226 int year; /**< specifies the year */
227 int month; /**< specifies the month */
228 int day; /**< specifies the day */
229 int hour; /**< specifies the hour */
230 int min; /**< specifies the minute*/
231 int sec; /**< specifies the second*/
235 typedef struct alarm_info_t alarm_entry_t;
240 * This function initializes alarm library. It connects to system bus and registers the application's service name.
242 * @param [in] pkg_name a package of application
244 * @return On success, ALARMMGR_RESULT_SUCCESS is returned. On error, a negative number is returned
249 * @remark An application must call this function before using other alarm APIs.
256 int ret_val = ALARMMGR_RESULT_SUCCESS;
257 const char* pkg_name = "org.tizen.test";
261 ret_val =alarmmgr_init(pkg_name) ;
262 if(ret_val == ALARMMGR_RESULT_SUCCESS)
264 //alarmmgr_init() is successful
268 //alarmmgr_init () failed
274 int alarmmgr_init(const char *appid);
278 * This function de-initializes alarm library. It un-registers the application's service name and dis-connects from system bus.
284 * @pre Alarm manager is initialized
285 * @post Alarm manager is de-initialized
286 * @remark An application must call this function once it is done with alarmmanger usage
293 // Initialize alarmmanager
301 void alarmmgr_fini();
305 * This function registers handler which handles an alarm event. An application should register the alarm handler
306 * before it enters mainloop.
308 * @param [in] handler Callback function
309 * @param [in] user_param User Parameter
311 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
313 * @pre alarmmgr_init().
316 * @remark An application can have only one alarm handler. If an application
317 * calls this function more than one times, the handler regitered during the
318 * last call of this funiction will be called when an alarm event has occured.
324 // Call back function
325 int callback(alarm_id_t alarm_id,void* user_param)
330 printf("Alarm[%d] has expired at %s\n", alarm_id, ctime(¤t_time));
338 int ret_val = ALARMMGR_RESULT_SUCCESS;
339 void *user_param = NULL;
341 ret_val = alarmmgr_set_cb( callback, user_param);
342 if(ret_val == ALARMMGR_RESULT_SUCCESS)
344 //alarmmgr_set_cb() is successful
348 //alarmmgr_set_cb () failed
355 int alarmmgr_set_cb(alarm_cb_t handler, void *user_param);
359 * This function creates a new alarm entry, will not be known to the server until alarmmgr_add_alarm is called.
361 * @return This function returns the pointer of alarm_entry_t
366 * @remark After an application use this object, an application free this pointer through alarmmgr_free_alarm
374 alarm_entry_t* alarm;
376 alarm = alarmmgr_create_alarm() ;
379 //alarmmgr_create_alarm() is successful
383 //alarmmgr_create_alarm () failed
391 alarm_entry_t *alarmmgr_create_alarm(void);
395 * This function frees an alarm entry.
397 * @param [in] alarm alarm entry
399 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
412 int ret_val = ALARMMGR_RESULT_SUCCESS;
413 alarm_entry_t* alarm;
415 alarm = alarmmgr_create_alarm() ;
418 //alarmmgr_create_alarm () failed
423 ret_val = alarmmgr_free_alarm( alarm) ;
424 if(ret_val == ALARMMGR_RESULT_SUCCESS)
426 //alarmmgr_free_alarm() is successful
430 //alarmmgr_free_alarm() failed
438 int alarmmgr_free_alarm(alarm_entry_t *alarm);
442 * This function sets time that alarm should be expried.
444 * @param [in] alarm alarm entry
445 * @param [in] time time the alarm should first go off
447 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
460 int ret_val = ALARMMGR_RESULT_SUCCESS;
461 alarm_entry_t* alarm;
463 struct tm current_tm;
464 alarm_date_t test_time;
468 localtime_r(¤t_time, ¤t_tm);
470 alarm = alarmmgr_create_alarm();
473 //alarmmgr_create_alarm () failed
476 test_time.year = current_tm.tm_year;
477 test_time.month = current_tm.tm_mon;
478 test_time.day = current_tm.tm_mday;
480 test_time.hour = current_tm.tm_hour;
481 test_time.min = current_tm.tm_min+1;
484 ret_val=alarmmgr_set_time(alarm,test_time);
485 if(ret_val == ALARMMGR_RESULT_SUCCESS)
487 //alarmmgr_set_time() is successful
491 //alarmmgr_set_time() failed
493 alarmmgr_free_alarm( alarm) ;
500 int alarmmgr_set_time(alarm_entry_t *alarm, alarm_date_t time);
503 * This function gives an application time that alarm should be expried.
505 * @param [in] alarm alarm entry
506 * @param [out] time time the alarm should first go off
508 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
513 * @remark But an application does not need to specify year, month, and day field of alarm_info. If an application sets
514 * those fields with zero, the function sets them with proper values.
522 int ret_val = ALARMMGR_RESULT_SUCCESS;
523 alarm_entry_t* alarm;
526 struct tm current_tm;
527 alarm_date_t test_time;
528 alarm_date_t new_time;
532 localtime_r(¤t_time, ¤t_tm);
534 alarm = alarmmgr_create_alarm();
536 //alarmmgr_create_alarm () failed
539 test_time.year = current_tm.tm_year;
540 test_time.month = current_tm.tm_mon;
541 test_time.day = current_tm.tm_mday;
543 test_time.hour = current_tm.tm_hour;
544 test_time.min = current_tm.tm_min+1;
547 ret_val = alarmmgr_set_time(alarm,test_time);
548 if(ret_val == ALARMMGR_RESULT_SUCCESS) {
549 //alarmmgr_set_time() is successful
552 //alarmmgr_set_time() failed
555 ret_val = alarmmgr_get_time(alarm, &new_time);
556 if(ret_val == ALARMMGR_RESULT_SUCCESS) {
557 //alarmmgr_get_time() is successful
560 //alarmmgr_get_time() failed
562 alarmmgr_free_alarm( alarm) ;
569 int alarmmgr_get_time(const alarm_entry_t *alarm, alarm_date_t *time);
572 * This function sets an alarm repeat mode
574 * @param [in] alarm alarm entry
575 * @param [in] repeat_mode one of ALARM_REPEAT_MODE_ONCE, ALARM_REPEAT_MODE_REPEAT,
576 * ALARM_REPEAT_MODE_WEEKLY, ALARM_REPEAT_MODE_MONTHLY or ALARM_REPEAT_MODE_ANNUALLY.
577 * @param [in] repeat_value the ALARM_REPEAT_MODE_REPEAT mode : interval between subsequent repeats of the alarm.
578 * the ALARM_REPEAT_MODE_WEEKLY mode : days of a week
579 * (ALARM_WDAY_SUNDAY, ALARM_WDAY_MONDAY, ALARM_WDAY_TUESDAY, ALARM_WDAY_WEDNESDAY,
580 * ALARM_WDAY_THURSDAY, ALARM_WDAY_FRIDAY, ALARM_WDAY_SATURDAY)
581 * the others : this parameter is ignored.
583 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
596 int ret_val = ALARMMGR_RESULT_SUCCESS;
597 alarm_entry_t* alarm;
598 alarm_repeat_mode_t repeat_mode =ALARM_REPEAT_MODE_WEEKLY;
599 int interval = ALARM_WDAY_MONDAY; //| ALARM_WDAY_TUESDAY|
600 ALARM_WDAY_WEDNESDAY| ALARM_WDAY_THURSDAY|ALARM_WDAY_FRIDAY ;
603 alarm = alarmmgr_create_alarm();
606 //alarmmgr_create_alarm () failed
610 ret_val = alarmmgr_set_repeat_mode
611 (alarm, repeat_mode,interval);
613 if(ret_val == ALARMMGR_RESULT_SUCCESS)
615 //alarmmgr_set_repeat_mode() is successful
619 //alarmmgr_set_repeat_mode() failed
621 alarmmgr_free_alarm( alarm) ;
628 int alarmmgr_set_repeat_mode(alarm_entry_t *alarm,
629 alarm_repeat_mode_t repeat_mode,
633 * This function gives an application an alarm mode
635 * @param [in] alarm alarm entry
636 * @param [out] repeat_mode one of ALARM_REPEAT_MODE_ONCE, ALARM_REPEAT_MODE_REPEAT,
637 * ALARM_REPEAT_MODE_WEEKLY, ALARM_REPEAT_MODE_MONTHLY or ALARM_REPEAT_MODE_ANNUALLY.
638 * @param [out] repeat_value the ALARM_REPEAT_MODE_REPEAT mode : interval between subsequent repeats of the alarm.
639 * the ALARM_REPEAT_MODE_WEEKLY mode : days of a week
640 * (ALARM_WDAY_SUNDAY, ALARM_WDAY_MONDAY, ALARM_WDAY_TUESDAY, ALARM_WDAY_WEDNESDAY,
641 * ALARM_WDAY_THURSDAY, ALARM_WDAY_FRIDAY, ALARM_WDAY_SATURDAY)
642 * the others : this parameter is ignored.
644 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
657 int ret_val = ALARMMGR_RESULT_SUCCESS;
658 alarm_entry_t* alarm;
659 alarm_repeat_mode_t repeat;
662 alarm = alarmmgr_create_alarm();
665 //alarmmgr_create_alarm () failed
668 ret_val =alarmmgr_get_repeat_mode
669 (alarm, &repeat, &interval) ;
670 if(ret_val == ALARMMGR_RESULT_SUCCESS
671 && repeat == ALARM_REPEAT_MODE_ONCE) {
672 //alarmmgr_get_repeat_mode() is successful
675 //alarmmgr_get_repeat_mode() failed
677 alarmmgr_free_alarm(alarm) ;
684 int alarmmgr_get_repeat_mode(const alarm_entry_t *alarm,
685 alarm_repeat_mode_t *repeat_mode,
689 * This function sets an alarm mode
691 * @param [in] alarm alarm entry
692 * @param [in] alarm_type one of ALARM_TYPE_DEFAULT : After the device reboot, the alarm still works.
693 * ALARM_TYPE_VOLATILE : After the device reboot, the alarm does not work.
695 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
708 int ret_val = ALARMMGR_RESULT_SUCCESS;
709 alarm_entry_t* alarm;
710 int alarm_type = ALARM_TYPE_VOLATILE;
712 alarm = alarmmgr_create_alarm();
715 //alarmmgr_create_alarm () failed
719 ret_val = alarmmgr_set_type(alarm, alarm_type);
720 if(ret_val == ALARMMGR_RESULT_SUCCESS)
722 //alarmmgr_set_type() is successful
726 //alarmmgr_set_type() failed
728 alarmmgr_free_alarm( alarm) ;
735 int alarmmgr_set_type(alarm_entry_t *alarm, int alarm_type);
738 * This function gives an application an alarm mode
740 * @param [in] alarm alarm entry
741 * @param [out] alarm_type one of ALARM_TYPE_DEFAULT, ALARM_TYPE_VOLATILE
743 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
756 int ret_val = ALARMMGR_RESULT_SUCCESS;
757 alarm_entry_t* alarm;
760 alarm = alarmmgr_create_alarm();
762 //alarmmgr_create_alarm () failed
765 ret_val = alarmmgr_get_type( alarm, &alarm_type);
766 if(ret_val == ALARMMGR_RESULT_SUCCESS && alarm_type
767 == ALARM_TYPE_DEFAULT ) {
768 //alarmmgr_get_type() is successful
771 //alarmmgr_get_type() failed
773 alarmmgr_free_alarm( alarm) ;
780 int alarmmgr_get_type(const alarm_entry_t *alarm, int *alarm_type);
783 * This function adds an alarm entry to the server.
784 * Server will remember this entry, and generate alarm events for it when necessary.
785 * Server will call app-svc interface to sent notification to destination application. Destination information
786 * should be available in the input bundle.
787 * Alarm entries registered with the server cannot be changed.
788 * Remove from server before changing.
789 * Before the application calls alarmmgr_add_alarm_appsvc_with_localtime(), the application have to call alarmmgr_set_time().
790 * The time set is localtime.
791 * If the application does not call alarmmgr_set_repeat_mode, the default repeat_mode is ALARM_REPEAT_MODE_ONCE.
792 * If the application does not call alarmmgr_set_type, the default alarm_type is ALARM_TYPE_DEFAULT.
793 * The id of the new alarm will be copied to alarm_id if the fuction successes to create an alarm.
795 * @param [in] alarm the entry of an alarm to be created.
796 * @param [in] bundle_data bundle which contains information about the destination.
797 * @param [out] alarm_id the id of the alarm added.
799 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
803 * @see alarmmgr_add_alarm
813 struct tm current_tm;
814 alarm_entry_t* alarm_info;
817 alarm_date_t test_time;
826 printf("Unable to create bundle!!!\n");
830 appsvc_set_operation(b,APPSVC_OPERATION_DEFAULT);
831 appsvc_set_pkgname(b,"org.tizen.alarm-test");
835 printf("current time: %s\n", ctime(¤t_time));
836 localtime_r(¤t_time, ¤t_tm);
838 alarm_info = alarmmgr_create_alarm();
840 test_time.year = current_tm.tm_year;
841 test_time.month = current_tm.tm_mon;
842 test_time.day = current_tm.tm_mday;
844 test_time.hour = current_tm.tm_hour;
845 test_time.min = current_tm.tm_min+1;
849 alarmmgr_set_time(alarm_info,test_time);
850 alarmmgr_set_repeat_mode(alarm_info,ALARM_REPEAT_MODE_WEEKLY,ALARM_WDAY_MONDAY| \
851 ALARM_WDAY_TUESDAY|ALARM_WDAY_WEDNESDAY| \
852 ALARM_WDAY_THURSDAY|ALARM_WDAY_FRIDAY );
854 alarmmgr_set_type(alarm_info, ALARM_TYPE_DEFAULT);
855 //alarmmgr_set_type(alarm_info,ALARM_TYPE_VOLATILE);
856 if ((result = alarmmgr_add_alarm_appsvc_with_localtime(alarm_info,(void *)b,&alarm_id)) < 0)
858 printf("Alarm creation failed!!! Alrmgr error code is %d\n",result);
862 printf("Alarm created succesfully with alarm id %d\n",alarm_id);
869 int alarmmgr_add_alarm_appsvc_with_localtime(alarm_entry_t *alarm,void *bundle_data, alarm_id_t *alarm_id);
872 * This function adds an alarm entry to the server.
873 * Server will remember this entry, and generate alarm events for it when necessary.
874 * Alarm entries registered with the server cannot be changed.
875 * Remove from server before changing.
876 * Before the application calls alarmmgr_add_alarm_with_localtime(), the application have to call alarmmgr_set_time().
877 * The time set is localtime.
878 * If the application does not call alarmmgr_set_repeat_mode, the default repeat_mode is ALARM_REPEAT_MODE_ONCE.
879 * If the application does not call alarmmgr_set_type, the default alarm_type is ALARM_TYPE_DEFAULT.
880 * The id of the new alarm will be copied to alarm_id if the fuction successes to create an alarm.
882 * @param [in] alarm the entry of an alarm to be created.
883 * @param [in] destination the packname of application that the alarm will be expired.
884 * @param [out] alarm_id the id of the alarm added.
886 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
890 * @see alarmmgr_add_alarm
899 int ret_val = ALARMMGR_RESULT_SUCCESS;
900 alarm_entry_t* alarm;
901 const char* destination = NULL;
905 struct tm current_tm;
906 alarm_date_t test_time;
908 const char* pkg_name = "org.tizen.test";
912 ret_val =alarmmgr_init(pkg_name) ;
913 if(ret_val != ALARMMGR_RESULT_SUCCESS) {
914 //alarmmgr_init () failed
920 printf("current time: %s\n", ctime(¤t_time));
921 localtime_r(¤t_time, ¤t_tm);
923 alarm = alarmmgr_create_alarm();
926 test_time.month = 0;test_time.day = 0;
928 test_time.hour = current_tm.tm_hour;
929 test_time.min = current_tm.tm_min+1;
933 alarmmgr_set_time(alarm,test_time);
934 alarmmgr_set_repeat_mode(alarm,ALARM_REPEAT_MODE_WEEKLY, \
936 alarmmgr_set_type(alarm,ALARM_TYPE_VOLATILE);
939 ret_val=alarmmgr_add_alarm_with_localtime(alarm,destination,&alarm_id);
941 if(ret_val == ALARMMGR_RESULT_SUCCESS)
943 //alarmmgr_add_alarm_with_localtime() is successful
947 //alarmmgr_add_alarm_with_localtime() failed
949 alarmmgr_free_alarm( alarm) ;
954 int alarmmgr_add_alarm_with_localtime(alarm_entry_t *alarm,
955 const char *destination,
956 alarm_id_t *alarm_id);
960 * This function adds an alarm entry to the server.
961 * Server will remember this entry, and generate alarm events for it when necessary.
962 * Server will call app-svc interface to sent notification to destination application. Destination information
963 * should be available in the input bundle.
964 * Alarm entries registered with the server cannot be changed.
965 * Remove from server before changing.
966 * After the trigger_at_time seconds from now, the alarm will be expired.
967 * If the interval is zero, the repeat_mode is ALARM_REPEAT_MODE_ONCE.
968 * If the interval is >0, the repeat_mode is ALARM_REPEAT_MODE_REPEAT.
969 * The id of the new alarm will be copied to alarm_id if the fuction successes to create an alarm.
971 * @param [in] alarm_type one of ALARM_TYPE_DEFAULT, ALARM_TYPE_VOLATILE
972 * @param [in] trigger_at_time time interval to be triggered from now(sec). an alarm also will be expired at triggering time.
973 * @param [in] interval Interval between subsequent repeats of the alarm
974 * @param [in] bundle_data bundle which contains information about the destination.
975 * @param [out] alarm_id the id of the alarm added.
977 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
981 * @see alarmmgr_add_alarm_with_localtime alarmmgr_remove_alarm
999 printf("Unable to create bundle!!!\n");
1003 appsvc_set_pkgname(b,"org.tizen.alarm-test");
1004 //appsvc_set_operation(b,APPSVC_OPERATION_SEND_TEXT);
1005 appsvc_set_operation(b,APPSVC_OPERATION_DEFAULT);
1007 if ((result = alarmmgr_add_alarm_appsvc(ALARM_TYPE_DEFAULT, 10, 0, (void *)b ,&alarm_id)))
1008 printf("Unable to add alarm. Alarmmgr alarm no is %d\n", result);
1010 printf("Alarm added successfully. Alarm Id is %d\n", alarm_id);
1018 int alarmmgr_add_alarm_appsvc(int alarm_type, time_t trigger_at_time,
1019 time_t interval, void *bundle_data,
1020 alarm_id_t *alarm_id);
1024 * This function adds an alarm entry to the server.
1025 * Server will remember this entry, and generate alarm events for it when necessary.
1026 * Alarm entries registered with the server cannot be changed.
1027 * Remove from server before changing.
1028 * After the trigger_at_time seconds from now, the alarm will be expired.
1029 * If the interval is zero, the repeat_mode is ALARM_REPEAT_MODE_ONCE.
1030 * If the interval is >0, the repeat_mode is ALARM_REPEAT_MODE_REPEAT.
1031 * The id of the new alarm will be copied to alarm_id if the fuction successes to create an alarm.
1033 * @param [in] alarm_type one of ALARM_TYPE_DEFAULT, ALARM_TYPE_VOLATILE
1034 * @param [in] trigger_at_time time interval to be triggered from now(sec). an alarm also will be expired at triggering time.
1035 * @param [in] interval Interval between subsequent repeats of the alarm
1036 * @param [in] destination the packname of application that the alarm will be expired.
1037 * @param [out] alarm_id the id of the alarm added.
1039 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
1043 * @see alarmmgr_add_alarm_with_localtime alarmmgr_remove_alarm
1052 int ret_val = ALARMMGR_RESULT_SUCCESS;
1054 int alarm_type = ALARM_TYPE_VOLATILE;
1055 time_t trigger_at_time = 10;
1056 time_t interval = 10;
1057 const char* destination = NULL;
1058 alarm_id_t alarm_id;
1060 const char* pkg_name = "org.tizen.test";
1064 ret_val =alarmmgr_init(pkg_name) ;
1065 if(ret_val != ALARMMGR_RESULT_SUCCESS)
1067 //alarmmgr_init () failed
1071 ret_val = alarmmgr_add_alarm( alarm_type, trigger_at_time, interval,
1072 destination, &alarm_id);
1073 if(ret_val == ALARMMGR_RESULT_SUCCESS)
1075 //alarmmgr_add_alarm() is successful
1079 //alarmmgr_add_alarm() failed
1081 alarmmgr_remove_alarm( alarm_id) ;
1087 int alarmmgr_add_alarm(int alarm_type, time_t trigger_at_time,
1088 time_t interval, const char *destination,
1089 alarm_id_t *alarm_id);
1092 * This function deletes the alarm associated with the given alarm_id.
1094 * @param [in] alarm_id Specifies the ID of the alarm to be deleted.
1096 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
1100 * @see alarmmgr_add_alarm_with_localtime alarmmgr_add_alarm
1109 int ret_val = ALARMMGR_RESULT_SUCCESS;
1110 int alarm_type = ALARM_TYPE_VOLATILE;
1111 time_t trigger_at_time = 10;
1112 time_t interval = 10;
1113 const char* destination = NULL;
1114 alarm_id_t alarm_id;
1116 const char* pkg_name = "org.tizen.test";
1120 ret_val =alarmmgr_init(pkg_name) ;
1121 if(ret_val != ALARMMGR_RESULT_SUCCESS) {
1122 //alarmmgr_init () failed
1126 alarmmgr_add_alarm( alarm_type, trigger_at_time, interval,
1127 destination, &alarm_id);
1129 ret_val =alarmmgr_remove_alarm( alarm_id) ;
1130 if(ret_val == ALARMMGR_RESULT_SUCCESS) {
1131 /alarmmgr_remove_alarm() is successful
1134 //alarmmgr_remove_alarm() failed
1141 int alarmmgr_remove_alarm(alarm_id_t alarm_id);
1144 * This function gives a list of alarm ids that the application adds to the server.
1146 * @param [in] fn a user callback function
1147 * @param [in] user_param user parameter
1149 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
1153 * @see alarm_get_info
1160 int callback_2(alarm_id_t id, void* user_param)
1162 int* n = (int*)user_param;
1163 printf("[%d]alarm id : %d\n",*n,id);
1170 int ret_val = ALARMMGR_RESULT_SUCCESS;
1173 const char* pkg_name = "org.tizen.test";
1177 ret_val =alarmmgr_init(pkg_name) ;
1178 if(ret_val != ALARMMGR_RESULT_SUCCESS)
1180 //alarmmgr_init() failed
1184 ret_val = alarmmgr_enum_alarm_ids( callback_2, (void*)&n) ;
1185 if(ret_val == ALARMMGR_RESULT_SUCCESS)
1187 //alarmmgr_enum_alarm_ids() is successful
1191 //alarmmgr_enum_alarm_ids() failed
1198 int alarmmgr_enum_alarm_ids(alarm_enum_fn_t fn, void *user_param);
1202 * This function gets the information of the alarm assosiated with alarm_id to alarm_info. The application
1203 * must allocate alarm_info before calling this function.
1205 * @param [in] alarm_id the id of the alarm
1206 * @param [out] alarm the buffer alarm informaiton will be copied to
1208 * @return This function returns ALARMMGR_RESULT_SUCCESS on success or a negative number on failure.
1212 * @see alarmmgr_enum_alarm_ids
1221 int ret_val = ALARMMGR_RESULT_SUCCESS;
1222 int alarm_type = ALARM_TYPE_VOLATILE;
1223 time_t trigger_at_time = 10;
1224 time_t interval = ALARM_WDAY_SUNDAY;
1225 const char* destination = NULL;
1226 alarm_id_t alarm_id;
1228 alarm_entry_t *alarm;
1230 const char* pkg_name = "org.tizen.test_get_info1";
1234 ret_val =alarmmgr_init(pkg_name) ;
1235 if(ret_val != ALARMMGR_RESULT_SUCCESS) {
1236 //alarmmgr_init() failed
1239 ret_val = alarmmgr_add_alarm( alarm_type,trigger_at_time,interval,
1240 destination, &alarm_id);
1242 if(ret_val != ALARMMGR_RESULT_SUCCESS) {
1243 //alarmmgr_add_alarm() failed
1246 ret_val = alarmmgr_get_info(alarm_id, alarm);
1247 if(ret_val == ALARMMGR_RESULT_SUCCESS) {
1248 //alarmmgr_get_info() is successful
1251 //alarmmgr_get_info() failed
1253 alarmmgr_remove_alarm( alarm_id) ;
1258 int alarmmgr_get_info(alarm_id_t alarm_id, alarm_entry_t *alarm);
1262 * This function retrieves bundle associated with alarm.
1263 * Server will remember this entry, and pass the bundle information upon alarm expiry.
1264 * Server will call app-svc interface to sent notification to destination application. Destination information
1265 * should be available in the input bundle.
1266 * @param [in] alarm_id alarm id
1267 * @param [out] ALARMMGR_RESULT_SUCCESS on success or negative number on failure.
1269 * @return This function returns bundle on success or NULL on failure.
1282 alarm_id_t alarm_id;
1291 printf("Unable to create bundle!!!\n");
1295 appsvc_set_pkgname(b,"org.tizen.alarm-test");
1296 appsvc_set_operation(b,APPSVC_OPERATION_DEFAULT);
1298 if ((result = alarmmgr_add_alarm_appsvc(ALARM_TYPE_DEFAULT, 10, 0, (void *)b ,&alarm_id)))
1299 printf("Unable to add alarm. Alarmmgr alarm no is %d\n", result);
1301 printf("Alarm added successfully. Alarm Id is %d\n", alarm_id);
1303 int main(int argc,char **argv {
1306 int return_code = 0;
1308 b = alarmmgr_get_alarm_appsvc_info(alarm_id, &return_code);
1310 const char *pkgname = appsvc_get_pkgname(b);
1312 printf("Package name is %s\n",pkgname);
1322 void *alarmmgr_get_alarm_appsvc_info(alarm_id_t alarm_id, int *return_code);
1327 * This function sets power RTC (which can power on the system).
1328 * @param [in] alarm_date_t time
1330 * @return This function returns the result. On success, ALARMMGR_RESULT_SUCCESS will be returned
1331 * else, appropriate error no will be returned.
1343 alarm_date_t alarm_date={2012,04,05,10,10,00};
1345 int main(int argc,char **argv {
1346 int return_code = 0;
1347 return_code = alarmmgr_set_rtc_time(&alarm_date);
1348 if (return_code != ALARMMGR_RESULT_SUCCESS){
1349 printf("Error returned is %d\n",return_code);
1357 int alarmmgr_set_rtc_time(alarm_date_t *time);
1370 int alarmmgr_power_on(bool on_off);
1377 #endif/* ALARM_LIB_H*/