AppigoPasteboard Class Reference

A convenience class for importing tasks and notes into Appigo Todo and Appigo Notebook. More...

Static Public Member Functions

(void) + setTask:
(AppigoTask *) + task
(AppigoTask *) + taskFromPasteboardNamed:
(BOOL) + openTodoWithTask:
(void) + setNote:
(AppigoNote *) + note
(AppigoNote *) + noteFromPasteboardNamed:
(BOOL) + openNotebookWithNote:
(void) + setShowErrorAlertsAutomatically:

Detailed Description

A convenience class for importing tasks and notes into Appigo Todo and Appigo Notebook.

A convenience class that allows third party iPhone apps to import data into Appigo Applications via UIPasteboard objects.


Member Function Documentation

+ (AppigoNote *) note  

Get the currently available note from the Appigo Pasteboard.

Returns:
Returns the currently available note from the pasteboard or nil if no note is currently present.
+ (AppigoNote *) noteFromPasteboardNamed: (NSString *)  pasteboardName  

Get the currently available note from a specific pasteboard.

Parameters:
pasteboardName The name of the specific pasteboard to look for a note.
Returns:
Returns the currently available note from the specified pasteboard or nil if no note is available on the specified pasteboard.
+ (BOOL) openNotebookWithNote: (AppigoNote *)  note  

Launch Appigo Notebook and import the specified note.

Parameters:
note The note to import into Appigo Notebook.
Returns:
Returns NO if Notebook was unable to be launched. Check the console log for the specific reason. In most cases, the user likely does not have Appigo Notebook installed. We recommend using a UIAlertView to prompt the user about this (and offer a direct link to the App Store for them to download/purchase Notebook). Samples of how to do this are available in CustomTask (a sample third party app which demonstrates how to use Appigo's Third Party Integration).
+ (BOOL) openTodoWithTask: (AppigoTask *)  task  

Launch Appigo Todo and import the specified task.

Parameters:
task The task to import into Appigo Todo.
Returns:
Returns NO if Todo was unable to be launched. Check the console log for the specific reason. In most cases, the user likely does not have Appigo Todo (or Appigo Todo Lite) installed. We recommend using a UIAlertView to prompt the user about this (and offer a direct link to the App Store for them to download/purchase Notebook). Samples of how to do this are available in CustomTask (a sample third party app which demonstrates how to use Appigo's Third Party Integration).
+ (void) setNote: (AppigoNote *)  note  

Set the Appigo Pasteboard note.

Parameters:
note The note to set/add to the Appigo Pasteboard to make it available to other applications.
+ (void) setShowErrorAlertsAutomatically: (BOOL)  showAlertsAutomatically  

Specify whether the AppigoPasteboard should automatically handle showing an alert if the user does not already have the target Appigo app installed when calling openTodoWithTask: or openNotebookWithNote:.

Parameters:
showAlertsAutomatically A BOOL value to specify whether to show alerts. By default, this is set to YES. Specify NO to handle informing users yourself.
+ (void) setTask: (AppigoTask *)  task  

Set the Appigo Pasteboard task.

Parameters:
task The task to set/add to the Appigo Pasteboard to make it available to other applications.
+ (AppigoTask *) task  

Get the currently available task from the Appigo Pasteboard.

Returns:
Returns the currently available task from the pasteboard or nil if no task is currently present.
+ (AppigoTask *) taskFromPasteboardNamed: (NSString *)  pasteboardName  

Get the currently available task from a specific pasteboard.

Parameters:
pasteboardName The name of the specific pasteboard to look for a task.
Returns:
Returns the currently available task from the specified pasteboard or nil if no task is available on the specified pasteboard.

The documentation for this class was generated from the following file:
Copyright © 2009-2010 Appigo, Inc. All rights reserved.