edu.worcester.cs499summer2012.service.NotificationHelper.java Source code

Introduction

Here is the source code for edu.worcester.cs499summer2012.service.NotificationHelper.java

Source

/*
 * NotificationHelper.java
 * 
 * Copyright 2012 Jonathan Hasenzahl, James Celona, Dhimitraq Jorgji
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package edu.worcester.cs499summer2012.service;

import java.util.Calendar;
import java.util.GregorianCalendar;

import android.app.Notification;
import android.app.NotificationManager;
import android.app.PendingIntent;
import android.content.Context;
import android.content.Intent;
import android.content.SharedPreferences;
import android.os.Build;
import android.preference.PreferenceManager;
import android.support.v4.app.NotificationCompat;
import android.text.format.DateFormat;
import edu.worcester.cs499summer2012.R;
import edu.worcester.cs499summer2012.activity.SettingsActivity;
import edu.worcester.cs499summer2012.activity.ViewTaskActivity;
import edu.worcester.cs499summer2012.task.Task;

/**
 * Creates Notifications using NotificationCompat to allow for
 * comparability though different API levels
 * 
 * @author Dhimitraq Jorgji
 *
 */
public class NotificationHelper {
    /**
     * Basic Text Notification for Task Butler, using NotificationCompat
     * @param context 
     * @param id id of task, call task.getID() and pass it to this parameter
     */
    public void sendBasicNotification(Context context, Task task) {
        SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(context);
        boolean vibrate = prefs.getBoolean(SettingsActivity.VIBRATE_ON_ALARM, true);
        int alarmInterval;
        int alarmUnits;

        if (task.hasFinalDateDue()) {
            alarmInterval = Integer
                    .parseInt(prefs.getString(SettingsActivity.ALARM_TIME, SettingsActivity.DEFAULT_ALARM_TIME));
            alarmUnits = Calendar.MINUTE;
        } else {
            alarmInterval = Integer.parseInt(
                    prefs.getString(SettingsActivity.REMINDER_TIME, SettingsActivity.DEFAULT_REMINDER_TIME));
            alarmUnits = Calendar.HOUR_OF_DAY;
        }

        Calendar next_reminder = GregorianCalendar.getInstance();
        next_reminder.add(alarmUnits, alarmInterval);

        NotificationCompat.Builder builder = new NotificationCompat.Builder(context).setAutoCancel(true)
                .setContentIntent(getPendingIntent(context, task.getID()))
                .setContentInfo(Task.PRIORITY_LABELS[task.getPriority()]).setContentTitle(task.getName())
                .setContentText(DateFormat.format("'Next reminder at' h:mmaa", next_reminder))
                .setDefaults(vibrate ? Notification.DEFAULT_ALL
                        : Notification.DEFAULT_SOUND | Notification.DEFAULT_LIGHTS)
                .setSmallIcon(Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB ? R.drawable.ic_notification
                        : R.drawable.ic_notification_deprecated)
                .setTicker(task.getName()).setWhen(System.currentTimeMillis());
        @SuppressWarnings("deprecation")
        Notification notification = builder.getNotification();
        NotificationManager notificationManager = getNotificationManager(context);
        notificationManager.notify(task.getID(), notification);
    }

    /**
     * Basic Text Notification with Ongoing flag enabled for Task Butler, using NotificationCompat
     * @param context 
     * @param id id of task, call task.getID() and pass it to this parameter
     * @deprecated Use sendBasicNotification for all notifications
     */
    public void sendPersistentNotification(Context context, Task task) {
        NotificationCompat.Builder builder = new NotificationCompat.Builder(context).setContentText(task.getNotes())
                .setContentTitle(task.getName())
                .setSmallIcon(Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB ? R.drawable.ic_notification
                        : R.drawable.ic_notification_deprecated)
                .setAutoCancel(true).setContentIntent(getPendingIntent(context, task.getID()))
                .setWhen(System.currentTimeMillis()).setOngoing(true).setDefaults(Notification.DEFAULT_ALL);
        Notification notification = builder.getNotification();
        NotificationManager notificationManager = getNotificationManager(context);
        notificationManager.notify(task.getID(), notification);
    }

    //get a PendingIntent
    PendingIntent getPendingIntent(Context context, int id) {
        Intent intent = new Intent(context, ViewTaskActivity.class).putExtra(Task.EXTRA_TASK_ID, id);
        return PendingIntent.getActivity(context, id, intent, 0);
    }

    //get a NotificationManager
    NotificationManager getNotificationManager(Context context) {
        return (NotificationManager) context.getSystemService(Context.NOTIFICATION_SERVICE);
    }

    /**
     * Cancels an existing notification, if user modified the task. Make the
     * actual call from TaskAlarm.cancelNotification(Context, int)
     * @param context
     * @param taskID
     */
    public void cancelNotification(Context context, int taskID) {
        NotificationManager notificationManager = getNotificationManager(context);
        notificationManager.cancel(taskID);
    }

}