The Alarm API provides functionality for scheduling the system alarm. It allows you to run other applications and have them perform operations at a specific time. You can schedule an alarm to go off once or to repeat at specific intervals.
Each application has its own individual alarm storage, that is, applications cannot view or edit alarms set by other applications.
Once an alarm goes off, it will be removed from the alarm storage automatically. AlarmManager provides methods to manage alarms such as adding and removing. For more information on the Alarm features, see Alarm Guide.
The AlarmManagerObject interface defines what is instantiated by the Tizen object from the Tizen Platform. The tizen.alarm object allows access to the functionality of the Alarm API.
Sets an alarm with the application ID to be run. You should definitely provide the application ID to run and the application control information if it is necessary. For more information about the application control, see The Application API.
Privilege level: public
Privilege: http://tizen.org/privilege/alarm
Parameters:
alarm: An alarm to add. It can be either AlarmRelative or AlarmAbsolute.
applicationId: The application ID to run when the alarm is triggered.
appControl optionalnullable: The data structure describing application control details.
Exceptions:
WebAPIException
with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.
with error type InvalidValuesError, if any input parameter does not contain a valid value.
with error type SecurityError, if the application does not have the privilege to call this method.
with error type UnknownError, if any other error occurs.
Code example:
// Triggers an alarm on a given date/time
var alarm = new tizen.AlarmAbsolute(new Date(2014, 10, 4, 8, 0));
var appControl = new tizen.ApplicationControl("http://tizen.org/appcontrol/operation/view");
tizen.alarm.add(alarm, tizen.application.getCurrentApplication().appInfo.id, appControl);
console.log("Alarm added with id: " + alarm.id);
remove
Removes an alarm from the storage.
void remove(AlarmId id);
Since: 1.0
If an alarm goes off, it will be removed from the storage automatically.
Privilege level: public
Privilege: http://tizen.org/privilege/alarm
Parameters:
id: The ID of the alarm to remove
Exceptions:
WebAPIException
with error type NotFoundError, if this alarm identifier cannot be found in the storage.
with error type InvalidValuesError, if any input parameter does not contain a valid value.
with error type SecurityError, if the application does not have the privilege to call this method.
with error type UnknownError, if the method cannot be completed because of an unknown error.
Code example:
var alarms = tizen.alarm.getAll();
// Removes the first alarm
if (alarms.length > 0) {
try {
tizen.alarm.remove(alarms[0].id);
console.log("Successfully removed the first alarm.");
} catch(error) {
console.log("Failed to remove the first alarm.");
}
}
removeAll
Removes all alarms added by an application.
void removeAll();
Since: 1.0
Because each application has its own alarm storage, this method removes alarms only added by the calling application.
Privilege level: public
Privilege: http://tizen.org/privilege/alarm
Exceptions:
WebAPIException
with error type SecurityError, if the application does not have the privilege to call this method.
with error type UnknownError, if the method cannot be completed because of an unknown error.
Code example:
tizen.alarm.removeAll();
console.log("remove all registered alarms in the storage.");
get
Returns an alarm as per the specified identifier.
Alarm get(AlarmId id);
Since: 1.0
Parameters:
id: The alarm ID to retrieve.
Return value:
Alarm An alarm object with the specified ID.
Exceptions:
WebAPIException
with error type NotFoundError, if this alarm identifier cannot be found in the storage.
with error type InvalidValuesError, if any input parameter does not contain a valid value.
with error type UnknownError, if the method cannot be completed because of an unknown error.
Code example:
// Sets an alarm
var date = new Date();
date.setHours(date.getHours()+1);
var abs_alarm = new tizen.AlarmAbsolute(date);
// Adds an alarm
tizen.alarm.add(abs_alarm, tizen.application.getCurrentApplication().appInfo.id);
// Gets an alarm
var alarm = tizen.alarm.get(abs_alarm.id);
console.log("The alarm will trigger at " + alarm.getNextScheduledDate());
getAll
Retrieves all alarms in an application storage.
Alarm[] getAll();
Since: 1.0
Alarms that have already been triggered are removed automatically from the storage.
Return value:
Alarm[] All Alarm objects.
Exceptions:
WebAPIException
with error type UnknownError, if the method cannot be completed because of an unknown error.
Code example:
var alarms = tizen.alarm.getAll();
console.log(alarms.length + " alarms present in the storage.");
2.3. Alarm
The Alarm interface is an abstract interface for alarm types.
This alarm triggers after a duration mentioned in the delay attribute from the moment the alarm is added. If a period is provided, the alarm keeps triggering for the given interval.
Remark : Since Tizen 2.4 behaviour of this alarm has changed. In order to decrease the power consumption, the operating system decides when this alarm is going to be fired and what is the period between subsequent executions. It is guaranteed that this alarm will be fired after at least delay seconds. If period is provided, it will be adjusted by the operating system, however this value will not be lower than 600 seconds.
Code example:
// Gets the current application ID.
var appId = tizen.application.getCurrentApplication().appInfo.id;
// Sets an alarm in 3 hours from now
var alarm1 = new tizen.AlarmRelative(3 * tizen.alarm.PERIOD_HOUR);
tizen.alarm.add(alarm1, appId);
// Sets an alarm in one hour, recurring after every 10 minutes
var alarm2 = new tizen.AlarmRelative(tizen.alarm.PERIOD_HOUR, 10 * tizen.alarm.PERIOD_MINUTE);
tizen.alarm.add(alarm2, appId);
An attribute to store the difference in time (in seconds) between when an alarm is added and when it is triggered.
Since: 1.0
Remark : Since Tizen 2.4 the operating system adjusts this value to decrease the power consumption.
An attribute to store the duration in seconds between each trigger of an alarm. By default, this attribute is set to null, indicating that this alarm does not repeat.
Since: 1.0
Remark : Since Tizen 2.4 the operating system adjusts this value to decrease the power consumption.
Methods
getRemainingSeconds
Returns the duration in seconds before the next alarm is triggered.
long? getRemainingSeconds();
Since: 1.0
If the alarm has expired, this method returns null.
Return value:
long The duration before the next alarm is triggered.
Exceptions:
WebAPIException
with error type UnknownError, if the method cannot be completed because of an unknown error.
Code example:
// Gets the current application ID.
var appId = tizen.application.getCurrentApplication().appInfo.id;
// Sets an alarm in 3 hours from now
var alarm = new tizen.AlarmRelative(3 * tizen.alarm.PERIOD_HOUR);
tizen.alarm.add(alarm, appId);
var sec = alarm.getRemainingSeconds();
console.log("remaining time is " + sec);
2.5. AlarmAbsolute
The AlarmAbsolute interface provides an absolute alarm, which triggers at a specified absolute date.
If a period is provided, the alarm keeps triggering for the given interval. If the daysOfTheWeek array is not empty, the alarm triggers every week, for the given days, at the time defined by the date attribute.
Code example:
// Gets the current application ID.
var appId = tizen.application.getCurrentApplication().appInfo.id;
// Sets an alarm on January 1st 2014 08:00
var date = new Date(2014, 0, 1, 8, 0);
var alarm1 = new tizen.AlarmAbsolute(date);
tizen.alarm.add(alarm1, appId);
// Sets an alarm on January 1st 2014 08:00, repeating every 2 days
var alarm2 = new tizen.AlarmAbsolute(date, 2 * tizen.alarm.PERIOD_DAY);
tizen.alarm.add(alarm2, appId);
// Sets an alarm occurring on every Saturday and Sunday, at 08:00, starting from January 1st 2014
var alarm3 = new tizen.AlarmAbsolute(date, ["SA", "SU"]);
tizen.alarm.add(alarm3, appId);
An attribute to store the absolute date/time when the alarm is initially triggered.
This attribute is precise to the second. Milliseconds will be ignored.
Since: 1.0
An attribute to store the duration in seconds between each trigger of the alarm.
By default, this attribute is set to null, indicating that this alarm does not repeat. The _period_ and _daysOfTheWeek_ attributes are mutually exclusive.
Since: 1.0
An attribute to store the days of the week associated with the recurrence rule.
By default, this attribute is set to an empty array. The _period_ and _daysOfTheWeek_ attributes are mutually exclusive.
Since: 1.0
Methods
getNextScheduledDate
Returns the date / time of the next alarm trigger.
Date? getNextScheduledDate();
Since: 1.0
If the alarm has expired, this method returns null. The returned date is precise to the second.
Return value:
Date The date/time of the next alarm trigger.
Exceptions:
WebAPIException
with error type UnknownError, if the method cannot be completed because of an unknown error.
Code example:
// Gets the current application ID.
var appId = tizen.application.getCurrentApplication().appInfo.id;
// Sets an alarm on January 1st 2014 08:00
var date = new Date(2014, 0, 1, 8, 0);
var alarm1 = new tizen.AlarmAbsolute(date);
tizen.alarm.add(alarm1, appId);
var date = alarm1.getNextScheduledDate();
console.log("next scheduled time is " + date);
We use cookies to improve your experience on our website and to show you relevant
advertising. Manage you settings for our cookies below.
Essential Cookies
These cookies are essential as they enable you to move around the website. This
category cannot be disabled.
Company
Domain
Samsung Electronics
.samsungdeveloperconference.com
Analytical/Performance Cookies
These cookies collect information about how you use our website. for example which
pages you visit most often. All information these cookies collect is used to improve
how the website works.
Company
Domain
LinkedIn
.linkedin.com
Meta (formerly Facebook)
.samsungdeveloperconference.com
Google Inc.
.samsungdeveloperconference.com
Functionality Cookies
These cookies allow our website to remember choices you make (such as your user name, language or the region your are in) and
tailor the website to provide enhanced features and content for you.
Company
Domain
LinkedIn
.ads.linkedin.com, .linkedin.com
Advertising Cookies
These cookies gather information about your browser habits. They remember that
you've visited our website and share this information with other organizations such
as advertisers.
Company
Domain
LinkedIn
.linkedin.com
Meta (formerly Facebook)
.samsungdeveloperconference.com
Google Inc.
.samsungdeveloperconference.com
Preferences Submitted
You have successfully updated your cookie preferences.