rajeevkuma11 / phonegap-calendar-plugin-ios Goto Github PK

//
//								
//  Cordova Calendar Plugin IOS    
//									
//  Author: Felix Montanez
//  
//  Collaborators:
//  Michael Brooks
//
//  Notes: this is a basic plugin which creates an event to the user's local calendar. There are methods that I'm working on for fetching an event, modifying and deleting 
//  events in the calendar. 
//
//  Usage Example: I put the code in my JS file that I'm calling the
//  createEvent function. Declared cal as a global variable, then 
//  onDeviceReady, i declared cal = window.plugins.calendarPlugin
//  
//  The plugin is meant to be dynamic to pass the different variables from
//  the application to the iphone's native calendar
//
//  Dependencies: You will need to add the EventKit framework and the EventKitUI framework
//
//  Code: 
//
//  var cal;
//  cal = window.plugins.calendarPlugin
//  
//  function call in Javascript:
//
//  createEvent : function(title,location,notes, startDate, endDate){
//            var title= "My Appt";
//            var location = "Los Felix";
//            var notes = "me testing";
//            var startDate = "2012-01-23 09:30:00";
//            var endDate = "2012-01-23 12:30:00";
//           
//            cal.createEvent(title,location,notes,startDate,endDate);
//        },
//
//
//  Which can also be written as:
//
//  function createEvent(title,location,notes, startDate, endDate){
//      var title= "My Appt";
//      var location = "Los Felix";
//      var notes = "me testing";
//      var startDate = "2012-01-23 09:30:00";
//      var endDate = "2012-01-23 12:30:00";
//           
//      cal.createEvent(title,location,notes,startDate,endDate);
//  }
//
//  The example I've written, although the function is receiving variables,
//  for testing I declared the necessary variables. You will need to comment these out and pass
//  your variables normally through the function call.
//
//  In the Cordova.plist section, you need to add the plugin with the key/pair value of:
//	
// 	calendarPlugin   calendarPlugin
//
//


License

The MIT License

Copyright (c) 2012 Felix Montanez

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.