6/19/12

iPhone Programming Tutorial Local Notifications | iPhone Programming Tutorials

Velum Media
news
web dev
mobile dev
the cloud
networking
music
fitness
bestcovery
search

home
featured
tutorials
snippets
ipad
iphone / ipod touch

iPhone Programming Tutorial Local Notifications

Be Sociable, Share!

Like

21

Share

July 29th, 2010 Posted by: brandontreb (ELC) - posted under:Tutorials

Way back when, when everyone was still complaining about Apples lack of support for (3rd party) multitasking,
there was a simple solution put in place. This solution was known as push notifications.
Push notifications solved many of the issues associated with background processing. For example, when quitting the AIM application, the server could keep you
logged in and send you a push notification when a new message arrived. You could then tap on a View button that would launch the app.
This solution is great and all, but it still requires that you have an active internet connection. As of iOS4, Apple has introduced a new type of notification that can
be scheduled to fire within the device itself. It requires no complicated server programming, or additional configuration with iTunes. I am talking about Local
Notifications.
Local notifications can be scheduled on the users iDevice to fire at any given time; you can even set them to be recurring. Today, we will explore these
notifications and I will provide you with a simple example of how to schedule, view, and handle local notifications. Here is a quick screenshot of the project that
we are going to create (note I am using the iPhone 4 simulator).

www.icodeblog.com/2010/07/29/iphone-programming-tutorial-local-notifications/

1/9

6/19/12

iPhone Programming Tutorial Local Notifications | iPhone Programming Tutorials

The project will allow a user to schedule a location notification to fire off at a given date. Using the text field, they are also able to specify some text for the
notification. The table view below displays a list of all of the currently scheduled location notifications within the application.
So, by now (if you are an avid iCodeBlog reader), you are already a killer iPhone dev and I can rush through the stuff that is not related to the notifications. I will
try to provide links to tutorials about sections that I rush through as well.

1. Create a View-Based Application

We will be using this as our starting point. Check out this tutorial if you are unfamiliar with doing this. Name the project Notifier.

2. Create All Properties and Dummy IBActions

This is usually a good first step when tackling an application like this. Lets get everything set up in the .h and .m files so we only have to visit Interface Builder
Once. Here is what our NotifierViewController.h file looks like.
@interface NotifierViewController : UIViewController<UITableViewDelegate,UITableViewDataSource> {
IBOutlet UITableView *tableview;
IBOutlet UIDatePicker *datePicker;
IBOutlet UITextField *eventText;
}
@property (nonatomic, retain) IBOutlet UITableView *tableview;
@property (nonatomic, retain) IBOutlet UIDatePicker *datePicker;
@property (nonatomic, retain) IBOutlet UITextField *eventText;
- (IBAction) scheduleAlarm:(id) sender;
@end

Seems clear enough. We have 3 UI elements that we care about and one action. One thing to note is, your class should implement the UITableViewDelegate and
UITableViewDataSource protocols. This is because we will be displaying a tableview containing all of the scheduled alarms.
Now, do all of the necessary steps in your .m file. This includes memory management for the IBOutlets and creating a dummy method for the scheduleAlarm
IBAction. Your .m file should look something like this. Note: I have omitted import statements because my syntax highlighter wasnt digging them.
@implementation NotifierViewController
@synthesize datePicker,tableview, eventText;
- (IBAction) scheduleAlarm:(id) sender {
}
- (void)didReceiveMemoryWarning {
[super didReceiveMemoryWarning];
}

www.icodeblog.com/2010/07/29/iphone-programming-tutorial-local-notifications/

2/9

6/19/12

iPhone Programming Tutorial Local Notifications | iPhone Programming Tutorials

- (void)viewDidUnload {
datePicker = nil;
tableview = nil;
eventText = nil;
}
- (void)dealloc {
[super dealloc];
}
@end

Now its time to build our interface. Open Interface builder and construct an interface like this.

If you want my super sweet green button image, here it is:

After creating the interface, make sure you hook up all of the UI components to their corresponding IBOutlets and hook up the touchUpInside: method of the
button the your scheduleAlarm: IBAction. For more info on hooking up IBOutlets, check out this tutorial.

3. Implement UITableViewDelegate and UITableViewDataSource Delegate methods to List

Currently Scheduled Local Notifications
It may seem weird to implement the code to display the notifications before the code that creates them, however I like this approach better. This way, once we
schedule the notifications, they automagically appear in our table. Add the following code to your .m file.
- (NSInteger)numberOfSectionsInTableView:(UITableView *)tableView {
// We only have one section
return 1;
}
- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section {
// Return the number of notifications
return [[[UIApplication sharedApplication] scheduledLocalNotifications] count];
}
- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {
static NSString *CellIdentifier = @"Cell";
UITableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:CellIdentifier];
if (cell == nil) {
cell = [[[UITableViewCell alloc] initWithStyle:UITableViewCellStyleSubtitle reuseIdentifier:CellIdentifier] autorelease];
}
// Get list of local notifications
NSArray *notificationArray = [[UIApplication sharedApplication] scheduledLocalNotifications];
UILocalNotification *notif = [notificationArray objectAtIndex:indexPath.row];

www.icodeblog.com/2010/07/29/iphone-programming-tutorial-local-notifications/

3/9

6/19/12

iPhone Programming Tutorial Local Notifications | iPhone Programming Tutorials

// Display notification info
[cell.textLabel setText:notif.alertBody];
[cell.detailTextLabel setText:[notif.fireDate description]];
return cell;

OK, finally some real code. Most of this code should seem pretty straight forward. If not, check out this tutorial on UITableViews.
So, the new code here is dealing with retrieving a list of scheduled notifications. Calling the scheduledLocalNotifications method of UIApplication will return an
NSArray of all notifications scheduled by the current app. We just index into this array and grab each notification.
Finally, we are displaying the alertBody (text that displays when the notification fires) and the fireDate (date and time when the notification will display) in the
tableview cell.

4. Scheduling Notifications
And now for the moment youve been waiting for OK, probably not, but definitely the most exciting (least boring) part of this tutorial. Lets implement that
scheduleAlarm: IBAction that you framed out earlier. Update your .m file to contain the following code.
- (IBAction) scheduleAlarm:(id) sender {
[eventText resignFirstResponder];
NSCalendar *calendar = [NSCalendar autoupdatingCurrentCalendar];
// Get the current date
NSDate *pickerDate = [self.datePicker date];
// Break the date up into components
NSDateComponents *dateComponents = [calendar components:( NSYearCalendarUnit | NSMonthCalendarUnit | NSDayCalendarUnit )
fromDate:pickerDate];
NSDateComponents *timeComponents = [calendar components:( NSHourCalendarUnit | NSMinuteCalendarUnit | NSSecondCalendarUnit )
fromDate:pickerDate];
// Set up the fire time
NSDateComponents *dateComps = [[NSDateComponents alloc] init];
[dateComps setDay:[dateComponents day]];
[dateComps setMonth:[dateComponents month]];
[dateComps setYear:[dateComponents year]];
[dateComps setHour:[timeComponents hour]];
// Notification will fire in one minute
[dateComps setMinute:[timeComponents minute]];
[dateComps setSecond:[timeComponents second]];
NSDate *itemDate = [calendar dateFromComponents:dateComps];
[dateComps release];
UILocalNotification *localNotif = [[UILocalNotification alloc] init];
if (localNotif == nil)
return;
localNotif.fireDate = itemDate;
localNotif.timeZone = [NSTimeZone defaultTimeZone];
// Notification details
localNotif.alertBody = [eventText text];
// Set the action button
localNotif.alertAction = @"View";
localNotif.soundName = UILocalNotificationDefaultSoundName;
localNotif.applicationIconBadgeNumber = 1;
// Specify custom data for the notification
NSDictionary *infoDict = [NSDictionary dictionaryWithObject:@"someValue" forKey:@"someKey"];
localNotif.userInfo = infoDict;
// Schedule the notification
[[UIApplication sharedApplication] scheduleLocalNotification:localNotif];
[localNotif release];
[self.tableview reloadData];
}

So, most of the explanation is in the comments. Ill talk you through some of the less obvious stuff. The first tricky area is dealing with the NSCalendar. We just
use the NSCalendar object to break up the date into components. Note: This demo does not require that we break the date up into components. You could have
just as easily fed the date from the date picker into the notification fireDate. The reason that Im showing you how to break it down is, you may have some sort of
custom date logic to work with and this makes things much easier in the future.
Another important bit of code is where we set the alertBody or the notification. In this example we set it to the text that the user entered into the text field. You can
set this to whatever you like.
The other thing I want to mention is the infoDict in the code. This dictionary is your chance to associate some additional information with the alert. For example, if
you are using this alert in a game like We Rule to notify you when a crop is ready. You might want to set a key and value that contains the id of the crop that has
completed. For now, we just set some arbitrary values and you can ignore them if you like.
After actually scheduling the notification, we just reload the tableview to get it to display immediately.

5. Handling Notifications After They Fire

The last piece of this puzzle is determining what to do when a notification fires. Fortunately, this step is very easy and handled inside of the appDelegate. When a
notification fires, there are one of two situations. 1. The app is running and 2. The app is not running (or running in the background) .

www.icodeblog.com/2010/07/29/iphone-programming-tutorial-local-notifications/

4/9

6/19/12

iPhone Programming Tutorial Local Notifications | iPhone Programming Tutorials

Open up your app delegate .m file and add the following code.
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// Override point for customization after application launch.
// Add the view controller's view to the window and display.
[window addSubview:viewController.view];
[window makeKeyAndVisible];
application.applicationIconBadgeNumber = 0;
// Handle launching from a notification
UILocalNotification *localNotif =
[launchOptions objectForKey:UIApplicationLaunchOptionsLocalNotificationKey];
if (localNotif) {
NSLog(@"Recieved Notification %@",localNotif);
}
return YES;
}
- (void)application:(UIApplication *)app didReceiveLocalNotification:(UILocalNotification *)notif {
// Handle the notificaton when the app is running
NSLog(@"Recieved Notification %@",notif);
}

The first thing we see here is the application badge number is getting set to 0. Whenever a notification fires, it will increase the badge count on the application.
Next, we handle the case when the application launches from a notification. This happens when the user presses the view button on the notification. For now, we
just NSLog the data, but you should handle the notification how you see fit for your app.
Finally, we implement the didReceiveLocalNotification method. This method is required if you want to handle notifications at all in your app. You will see this
method fire when the app is running and you receive a local notification. When the app is running, you will not see the UIAlertView show up with the notification
data.
And there you have it! The complete lifecycle of a local notification. You may download the source for this tutorial below. If you have any questions, feel free to
post them in the comments section or write them to me on Twitter.
Notifier Source Code
Be Sociable, Share!

Like

21

Share

Previous Post
Next Post

Popular Posts
iPhone Game Programming Tutorial - Part 1 338 comments
iPhone Programming Tutorial - Populating UITableView With An NSArray 322 comments
iPhone Programming Tutorial - Creating a ToDo List Using SQLite Part 1 225 comments
iPhone Programming Tutorial - Connecting Code to An Interface Builder View 210 comments
iPhone Programming Tutorial - Transitioning Between Views 209 comments

WorkoutoftheDay
Strength & Conditioning Workout of the Day
Strength & Conditioning: Week 1, Day 1
Our first week of workouts from
Featured Coach Jeff Tucker. Work on
basic gymnastics skills and improve overall
Awake & Evolve Workout of the Day
strength and athleticism with this three week
Forward Bend Flow
cycle.
Relax and renew with this seated
sequence to open the hips, relax the
spine, and calm the mind with a deep forward
Women's Workout of the Day
bend.
Women's Workout: Week 9, Day 1
This 12-week cycle of the Womens
WOD will focus on building all over body
strength, as well as flexibility and core
RKC Kettlebell Workout of the Day
stabilization.
RKC Kettlebell: Week 7, Day 2
Gain strength, improve mobility, and
increase endurance in the first cycle of

www.icodeblog.com/2010/07/29/iphone-programming-tutorial-local-notifications/

5/9

6/19/12

iPhone Programming Tutorial Local Notifications | iPhone Programming Tutorials

categories
tags
Uncategorized
Tutorials
Snippets
Featured
Articles
Intermediate
beginner
iphone
iphone programming
iPhone Coding
Advanced
tutorial
xcode
uitableview
iOS

show all tags

Partners
Bestcovery MXDWN RubyGlob SmallCloudBuilder SmallNetBuilder TGDaily

Bestcovery
Best LED TV
Best AV Receiver
Best dSLR
Best Netbook
Best Wireless Router

recent tutorials
view all beginner tutorials

Using XCode 4 Snippets

Recently, I came across this post and fell in love with the idea of using XCode 4 snippets. Up until I read t
Be Sociable, Share!

www.icodeblog.com/2010/07/29/iphone-programming-tutorial-local-notifications/

6/9

6/19/12

iPhone Programming Tutorial Local Notifications | iPhone Programming Tutorials

Like

11

Share

READ MORE

Making UITableViews look not so plain

As most of you probably know, UITableViews are incredibly useful and versatile views to be using in you
Be Sociable, Share!

Like

Share

READ MORE

Back To Basics An Introduction To View Controllers

Introduction
In todays post, we are going to be discussing view controllers. Lets start by talk
Be Sociable, Share!

Like

Share

READ MORE

Back To Basics: Hello iPhone

Today Im going to show you how to make a simple Hello World project on the iPhone. There
Be Sociable, Share!

Like

14

Share

READ MORE

Back To Basics Getting Set Up For iOS Development

For this tutorial, we are going to discuss the basics of getting set up for developing on the iOS platform.
Be Sociable, Share!

Like

Share

READ MORE
view all intermediate tutorials

Simple Sqlite Database Interaction Using FMDB

Introduction
In the age where Core Data is king, the database that started it all is often overlooked. I
Be Sociable, Share!

Like

10

Share

READ MORE

Subclassing Class Clusters

Subclassing is something any object oriented programmer is pretty familiar with. Common examples would be that
Be Sociable, Share!

Like

Share

READ MORE

Dynamically Controlling Your Application From The Web

www.icodeblog.com/2010/07/29/iphone-programming-tutorial-local-notifications/

7/9

6/19/12

iPhone Programming Tutorial Local Notifications | iPhone Programming Tutorials

Often times you find yourself in a situation where you might want to control your application remotely. You m
Be Sociable, Share!

Like

Share

READ MORE

Timing Out An Application Due To Inactivity

In the recent months, I have had a few separate applications that required a timeout. What I me
Be Sociable, Share!

Like

Share

READ MORE

More Informative NSLogs with Prefix Headers

Hello iCoders,
I have a quick tip today that I have been using in some of my development that you guys may fin
Be Sociable, Share!

Like

Share

READ MORE
view all advanced tutorials

Update #2: ELCImagePickerController

Welcome back to another update to the ELCImagePickerController. If youre not familiar with this class I
Be Sociable, Share!

Like

Share

READ MORE

Grand Central Dispatch And Writing Methods That Accept Blocks As Arguments
Have you ever looked at the enumerateObjectsUsingBlock method of NSArray and wondered how you might use that d
Be Sociable, Share!

Like

Share

READ MORE

Adding block callbacks to the Facebook iOS SDK

If you are like me and love using blocks over delegates, then these code snippets will come in handy. After le
Be Sociable, Share!

Like

Share

READ MORE

Creating Static Libraries For iOS

Today Im going to show you how to make a static library for iOS. We will make a simple library and use
Be Sociable, Share!

Like

29

Share

16

READ MORE

www.icodeblog.com/2010/07/29/iphone-programming-tutorial-local-notifications/

8/9

6/19/12

iPhone Programming Tutorial Local Notifications | iPhone Programming Tutorials

Update: ELCImagePickerController
I recently spent some time with ELCImagePickerController. For those of you whove worked with UIImageP
Be Sociable, Share!

Like

Share

READ MORE
iCodeBlog
elc technologies
2010 iCodeBlog. All rights Reserved. About iCodeBlog | Privacy Policy | Terms of Use | Advertise With Us. |

www.icodeblog.com/2010/07/29/iphone-programming-tutorial-local-notifications/

9/9