The benCoding.AlarmManager module enables you to use the native Android AlarmManager in your Titanium apps to schedule notifications and services.
This project can be found on github at https://github.com/benbahrenburg/benCoding.AlarmManager
* This is an Android module designed to work with Titanium SDK 1.8.2 or greater. * Before getting start please note you need to compile this module yourself * ModuleThe Module folder contains the benCoding.AlarmManager project.
- ExampleProject
The ExampleProject folder contains a full example project. Since this module uses services and activities it is important that you review this example before using in your app.
If you are building from source you will need to do the following:
- Update your .classpath file fit your environment
- Update the build.properties to have the correct paths for your environment
var alarmManager = require('bencoding.alarmmanager').createAlarmManager();
Now we have the module installed and avoid in our project we can start to use the components, see the feature guide below for details.
For a detailed example on how to use this module, please download the example project located in the ExampleProject folder on github.
Android Alarm's work using BroadcastReceivers. In order to have your Titanium project subscribe to the Alarms it generates you need to add the receivers into your tiapp.xml file.The benCoding.AlarmManager uses two receivers. One for each kind of Alarm you can schedule. See below for the example.
<receiver android:name="bencoding.alarmmanager.AlarmNotificationListener"></receiver>
<receiver android:name="bencoding.alarmmanager.AlarmServiceListener"></receiver>
Given all of the different configuration options needed, I highly recommend starting with the ExampleProject before incorporating into another project.
You can reach more about BroadcastReceivers here.
The addAlarmNotification allows you to schedule an Alarm that will then create an notification.You can create an AlarmNotification using the below properties:
- minute - (Required) The minute of the start time.
- hour - (Optional) The hour you want to start the alarm
- day - (Optional) The day you want to start the alarm
- month - (Optional) The month you want to start the alarm
- year - (Optional) The year you want to start the alarm
- contentTitle - (Required) The title of the notification
- contentText - (Required) The text of the notification
- playSound (Optional) Play the default notification sound when alarm triggered.
- vibrate (Optional) Vibrate the device on notification. Please note this requires the vibrate permission.
- showLights (Optional) Activate notification lights on device when alarm triggered.
- icon - (Optional)The icon of the notification
- repeat - (Optional) Used to schedule a repeating alarm. You can provide a millisecond value or use the words hourly, daily, monthly, yearly.
Please note if you omit the day, month, and year parameters the module will assume you mean to make the alarm effective from today and add the number of minutes provided.
The valid repeat options are:
- hourly
- daily
- monthly
- yearly
You can also provide a millisecond value to schedule your own repeat frequency.
The addAlarmService allows you to schedule an Alarm that will run a service within your Titanium App.Before using this method you will need to define a service and re-compile your project. After recompiling your project open your /build/AndroidManifest.xml to file your full service name. This is important as Titanium generates this name. To learn more about Android Services please read the documentation here.
You can create an AlarmService using the below properties:
- service - (Required) The full service name from your AndroidManifest.xml to be run.
- minute - (Required) The minute of the start time.
- hour - (Optional) The hour you want to start the alarm
- day - (Optional) The day you want to start the alarm
- month - (Optional) The month you want to start the alarm
- year - (Optional) The year you want to start the alarm
- interval - (Optional) The value used to create an interval service. This value must be in milliseconds.
- forceRestart - (Optional) Force the service to restart if it is already running.
- repeat - (Optional) Used to schedule a repeating alarm. You can provide a millisecond value or use the words hourly, daily, monthly, yearly.
Please note if you omit the day, month, and year parameters the module will assume you mean to make the alarm effective from today and add the number of minutes provided.
The valid repeat options are:
- hourly
- daily
- monthly
- yearly
You can also provide a millisecond value to schedule your own repeat frequency.
This method cancels all alarms submitted using the addAlarmNotification method. Unfortunately if you want to cancel only one alarm you need to cancel them all and re-submit. This is due to how Android handles pendingIntents. This method cancels all alarms submitted using the addAlarmService method. Unfortunately if you want to cancel only one alarm you need to cancel them all and re-submit. This is due to how Android handles pendingIntents. The below example shows how to use all of the methods. For additional samples please see the example folder contained within the module or [here on Github](https://github.com/benbahrenburg/benCoding.SMS/tree/master/example).
//Import our module into our Titanium App
var alarmModule = require('bencoding.alarmmanager');
var alarmManager = alarmModule.createAlarmManager();
//Create a date variable to be used later
var now = new Date();
//Set an Alarm to publish a notification in about two minutes
alarmManager.addAlarmNotification({
icon: Ti.Android.R.drawable.star_on, //Optional icon must be a resource id or url
minute:2, //Set the number of minutes until the alarm should go off
contentTitle:'Alarm #2', //Set the title of the Notification that will appear
contentText:'Alarm & Notify Basic Repeat' //Set the body of the notification that will apear
});
var ew1 = Ti.UI.createAlertDialog({
title:'Info', message:"You should see your alarm notification in about 2 minutes & repeat each minute",
buttonNames:[Ti.Android.currentActivity.getString(Ti.Android.R.string.ok)]
});
ew1.show();
//Below is an example on how you can provide a full date to schedule your alarm
//Set an Alarm to publish a notification in about two minutes and repeat each minute
alarmManager.addAlarmNotification({
year: now.getFullYear(),
month: now.getMonth(),
day: now.getDate(),
hour: now.getHours(),
minute: now.getMinutes() + 2, //Set the number of minutes until the alarm should go off
contentTitle:'Alarm #3', //Set the title of the Notification that will appear
contentText:'Alarm & Notify Scheduled', //Set the body of the notification that will apear
repeat:60000 //You can use the words hourly,daily,weekly,monthly,yearly or you can provide milliseconds.
//Or as shown above you can provide the millesecond value
});
var ew2 = Ti.UI.createAlertDialog({
title:'Info', message:"You should see your alarm notification in about 2 minutes",
buttonNames:[Ti.Android.currentActivity.getString(Ti.Android.R.string.ok)]
});
ew2.show();
//Cancel our Notification based Alarms
alarmManager.cancelAlarmNotification();
var ew9 = Ti.UI.createAlertDialog({
title:'Info', message:"Your alarm notification has been cancelled",
buttonNames:[Ti.Android.currentActivity.getString(Ti.Android.R.string.ok)]
});
ew9.show();
//Schedule a service to be run (once) in about two minutes
alarmManager.addAlarmService({
//The full name for the service to be called. Find this in your AndroidManifest.xml Titanium creates
service:'com.appworkbench.alarmtest.TestserviceService',
minute:2 //Set the number of minutes until the alarm should go off
});
var ew5 = Ti.UI.createAlertDialog({
title:'Info', message:"The Service provided will be started in about 2 minutes",
buttonNames:[Ti.Android.currentActivity.getString(Ti.Android.R.string.ok)]
});
ew5.show();
//Schedule a service to be run (once) in about two minutes, then to run at the same time each day
alarmManager.addAlarmService({
//The full name for the service to be called. Find this in your AndroidManifest.xml Titanium creates
service:'com.appworkbench.alarmtest.TestserviceService',
year: now.getFullYear(),
month: now.getMonth(),
day: now.getDate(),
hour: now.getHours(),
minute: now.getMinutes() + 2, //Set the number of minutes until the alarm should go off
repeat:'daily' //You can use the words hourly,daily,weekly,monthly,yearly or you can provide milliseconds.
});
var ew8 = Ti.UI.createAlertDialog({
title:'Info', message:"You should see your alarm notification in about 2 minutes & repeat each day",
buttonNames:[Ti.Android.currentActivity.getString(Ti.Android.R.string.ok)]
});
ew8.show();
alarmManager.cancelAlarmService();
var ew10 = Ti.UI.createAlertDialog({
title:'Info', message:"Your alarm service has been cancelled",
buttonNames:[Ti.Android.currentActivity.getString(Ti.Android.R.string.ok)]
});
ew10.show();
<android xmlns:android="http://schemas.android.com/apk/res/android">
<manifest>
<supports-screens android:anyDensity="false"/>
<application>
<activity android:alwaysRetainTaskState="true"
android:configChanges="keyboardHidden|orientation"
android:label="AlarmTest"
android:launchMode="singleTop"
android:name=".AlarmtestActivity" android:theme="@style/Theme.Titanium">
<intent-filter>
<action android:name="android.intent.action.MAIN"/>
<category android:name="android.intent.category.LAUNCHER"/>
</intent-filter>
</activity>
<receiver android:name="bencoding.alarmmanager.AlarmNotificationListener"></receiver>
<receiver android:name="bencoding.alarmmanager.AlarmServiceListener"></receiver>
</application>
</manifest>
<services>
<service type="interval" url="testservice.js"/>
</services>
</android>
This project is licensed under the OSI approved Apache Public License (version 2). For details please see the license associated with each project.
Developed by Ben Bahrenburg available on twitter @benCoding
Please consider following the @benCoding Twitter for updates and more about Titanium.
For module updates, Titanium tutorials and more please check out my blog at benCoding.Com.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent