<commit_before># phonegap-plugin-localNotifications

- PhoneGap Version : 3.0
- last update : 24/03/2014

# Description

PhoneGap plugin for providing native local notification system to JavaScript.

** NOTE: Notification queuing is iOS ONLY.**

# Credits

Respect to <NAME> 2011 -  Copyright (c) MIT Licensed
On which the (iOS & JS methods) plugin is based.
Original can be found here [https://github.com/purplecabbage/phonegap-plugins/tree/master/iPhone/LocalNotification](https://github.com/purplecabbage/phonegap-plugins/tree/master/iPhone/LocalNotification)

## Install (with Plugman) 

iOS
	
	cordova plugin add https://github.com/Wizcorp/phonegap-plugin-localNotifications
	build ios
	
	< or >
	
	phonegap local plugin add https://github.com/Wizcorp/phonegap-plugin-localNotifications
	phonegap build ios

Android
	
	cordova plugin add https://github.com/Wizcorp/phonegap-plugin-localNotifications
	build android
	
	< or >
	
	phonegap local plugin add https://github.com/Wizcorp/phonegap-plugin-localNotifications
	phonegap build android


## APIs

### Root class

The root class for the localNotification plugin is: `localNotification` every function descibed below has been defined within the `localNotification` class.

For example the `add()` function can be called like this:
```
localNotification.add(103, {
	seconds: 30,
	message: "This is an example",
	badge: 1});
```

### `add(int id, JSONObject options)`

The `add()` function adds a notification to the notification area of the phone. Do note that adding a notification with the exact same notification id twice will replace the first notification.

```
	id: Integer which represents the notification id
	options: A JSONObject holding the notification options
```

Setting up the options Object:
```
var options = {
    	seconds: int,
    	ticker: string, //Android only & Optional
    	title: string, //Android only & Optional
    	icon: string //Android only & Optional
    	message: string, 
	badge: int
};
```

The `icon` property has to reference to the name of a drawable resource in your Android project. If you leave the `title`, `ticker` or `icon` empty they will become default values.

### `queue(int id, JSONObject options)`

**NOTE: Queuing is currently iOS ONLY.**

The `queue()` function queue's a notification to be sent to the notification area of an iDevice.

```
	id: Integer which represents the notification id.
	options: A JSONObject holding the notification options.
```

Setting up the options Object:
```
	var options = {
    		seconds: 30, 
    		message: "chaaaarrrliieeeee", 
    		badge: 1 
	};
```
	<commit_msg>Indentation issue fixed<commit_after># phonegap-plugin-localNotifications

- PhoneGap Version : 3.0
- last update : 24/03/2014

# Description

PhoneGap plugin for providing native local notification system to JavaScript.

** NOTE: Notification queuing is iOS ONLY.**

# Credits

Respect to <NAME> 2011 -  Copyright (c) MIT Licensed
On which the (iOS & JS methods) plugin is based.
Original can be found here [https://github.com/purplecabbage/phonegap-plugins/tree/master/iPhone/LocalNotification](https://github.com/purplecabbage/phonegap-plugins/tree/master/iPhone/LocalNotification)

## Install (with Plugman) 

iOS
	
	cordova plugin add https://github.com/Wizcorp/phonegap-plugin-localNotifications
	build ios
	
	< or >
	
	phonegap local plugin add https://github.com/Wizcorp/phonegap-plugin-localNotifications
	phonegap build ios

Android
	
	cordova plugin add https://github.com/Wizcorp/phonegap-plugin-localNotifications
	build android
	
	< or >
	
	phonegap local plugin add https://github.com/Wizcorp/phonegap-plugin-localNotifications
	phonegap build android


## APIs

### Root class

The root class for the localNotification plugin is: `localNotification` every function descibed below has been defined within the `localNotification` class.

For example the `add()` function can be called like this:
```
localNotification.add(103, {
	seconds: 30,
	message: "This is an example",
	badge: 1});
```

### `add(int id, JSONObject options)`

The `add()` function adds a notification to the notification area of the phone. Do note that adding a notification with the exact same notification id twice will replace the first notification.

```
	id: Integer which represents the notification id
	options: A JSONObject holding the notification options
```

Setting up the options Object:
```
var options = {
	seconds: int,
	ticker: string, //Android only & Optional
	title: string, //Android only & Optional
	icon: string //Android only & Optional
	message: string, 
	badge: int
};
```

The `icon` property has to reference to the name of a drawable resource in your Android project. If you leave the `title`, `ticker` or `icon` empty they will become default values.

### `queue(int id, JSONObject options)`

**NOTE: Queuing is currently iOS ONLY.**

The `queue()` function queue's a notification to be sent to the notification area of an iDevice.

```
	id: Integer which represents the notification id.
	options: A JSONObject holding the notification options.
```

Setting up the options Object:
```
	var options = {
    		seconds: 30, 
    		message: "chaaaarrrliieeeee", 
    		badge: 1 
	};
```
	
{'fraction_non_alphanumeric': 0.09366602687140115, 'fraction_numerical': 0.008829174664107486, 'mean_word_length': 4.226680040120361, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 12, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6009068', 'n_tokens_mistral': 1614, 'n_tokens_neox': 1458, 'n_words': 578}