A class for representing an importable task. More...
Public Member Functions | |
| (id) | - initWithName: |
| (void) | - setType:withPropertyKeys:withPropertyValues: |
| (void) | - addSubtask: |
| (void) | - setActionForTaskWithAppDisplayName:withCompletionNotifyURL:withCompletionLaunchURL:withActionLaunchURL:withActionImage: |
| (NSString *) | - plainTextRepresentationWithName: |
| (AppigoNote *) | - noteRepresentation |
Protected Attributes | |
| NSMutableArray * | _subtasks |
Properties | |
| NSString * | name |
| AppigoTaskType | type |
| NSArray * | typeKeys |
| NSArray * | typeValues |
| AppigoTaskPriority | priority |
| NSDate * | dueDate |
| BOOL | dueDateHasTime |
| NSDate * | startDate |
| NSDate * | completionDate |
| NSInteger | repeat |
| NSString * | advancedRepeat |
| NSString * | note |
| NSString * | list |
| NSString * | context |
| NSString * | tags |
| UIImage * | actionImage |
| NSArray * | subtasks |
A class for representing an importable task.
A class to represent a task that can be placed on the Appigo Pasteboard and referenced by Appigo Applications.
| - (void) addSubtask: | (AppigoTask *) | subtask |
A convenience method to add a subtask to the task. You should only add subtasks to projects or checklists. Subtasks added to other types of tasks will be ignored by Todo if you attempt to import them.
| subtask | The subtask to add. |
| - (id) initWithName: | (NSString *) | taskName |
Initialize a new task object.
| taskName | The task name. The name will be trimmed of whitespace (an empty name is invalid and will be replaced with, "Unknown"). |
| - (AppigoNote *) noteRepresentation |
Build an AppigoNote object from the task that can be used to import the task into Appigo Notebook.
| - (NSString *) plainTextRepresentationWithName: | (BOOL) | includeName |
Get a plain text representation of a task.
| includeName | Specify YES to include the name in the text representation or NO to omit it. |
| - (void) setActionForTaskWithAppDisplayName: | (NSString *) | aDisplayName | ||
| withCompletionNotifyURL: | (NSURL *) | aCompletionNotifyURL | ||
| withCompletionLaunchURL: | (NSURL *) | aCompletionLaunchURL | ||
| withActionLaunchURL: | (NSURL *) | anActionLaunchURL | ||
| withActionImage: | (UIImage *) | anActionImage | ||
Add a custom action to the task which will allow custom actions on the task once it is imported into Appigo Todo. An overview of this process is described on the Custom Task Types page.
Set an option action that will be used when importing a task in Todo. This allows third party applications to be notified/called when the user completes the task or when they perform the task type's "action" (just like calling a contact on the Call Contact task). You must specify at least one of the URLs in the parameters. If you do not specify any URLs, this call will do nothing.
Be aware that custom task information (name, URLs, etc.) is stored in the task's typeData and the existing type and typeData information will be replaced with the information in this method.
| aDisplayName | (required) A string that will be used to show the origin of the custom task in Todo. This string is used regardless of the device's language/locale/region settings. | |
| aCompletionNotifyURL | (optional) A URL which specifies a call to a backend service you may operate. If specified, a UIAlertView will ask the user if they want to notify appDisplayName that they are completing the task. This URL should reference a service available on the Internet and not your iPhone app (use completionLaunchURL to launch your application when a task is completed). | |
| aCompletionLaunchURL | (optional) A URL which can be used to launch your iPhone app when a user completes the task. A UIAlertView will ask the user if they want to launch appDisplayName. | |
| anActionLaunchURL | (optional) A URL which will be used to perform an action from the task's detail screen. A UIAlertView will ask the user if they want to open appDisplayName before calling openURL: on this URL. | |
| anActionImage | (optional) This image will be used on the task's detail screen to the left of the task's name and should be drawn to mimic Todo's built-in action buttons, which are typically round and should appear to look like a button. For an example of this, create a "Call a Contact" task and then look at the icon which appears to the left of the task name. The size of this image must be 29x29 pixels and should be drawn using a transparent background. The image will be transferred to Todo as NSData * using UIImagePNGRepresentation(). If UIImagePNGRepresentation() returns nil, a default action image will be used. Action Images are tied to a specific application ID. If you specify a different image than previous imports, the most recently imported image will be used for all previous imported tasks made from your application. actionLaunchURL must also be specified if you specify this image. If actionLaunchURL is nil, the actionImage will be ignored. |
| - (void) setType: | (AppigoTaskType) | aTaskType | ||
| withPropertyKeys: | (NSArray *) | keys | ||
| withPropertyValues: | (NSArray *) | values | ||
Set the task type.
All task types except for Normal, Project, and Checklist must have corresponding keys and values set for additional task type information. This information will eventually be used to present phone numbers to a user such as "mobile: 555-555-1234" for a Call a Contact task type. The keys and values will be ignored when setting task types of AppigoTaskTypeNormal, AppigoTaskTypeProject, and AppigoTaskTypeChecklist.
For more information about task type data (the property keys and values, refer to the Task Type Data page.
| aTaskType | The new task type. | |
| keys | An array of keys (NSString *) that match up with the number of values. These keys specify additional task type information such as phone numbers, addresses, urls, etc. that will be shown to the user when they tap a task's action button in Todo (to call a contact, visit a website, etc.). | |
| values | An array of values which match up with the number of keys. The values will be items such as phone numbers, email addresses, addresses, etc. |
- (UIImage *) actionImage [read, write, retain] |
The action image associated with a custom task type. See the Custom Task Types page for more information.
- (NSString *) advancedRepeat [read, write, retain] |
A string which contains advance repeat information.
Valid strings should conform to one of the following formats:
- (NSDate *) completionDate [read, write, retain] |
An NSDate specifying when the task was completed. If the task is active and not completed, this should be left nil.
- (NSString *) context [read, write, retain] |
A case-insensitive context name that the task should be associated with. If a matching context is found in Todo, the context will be used. If no existing context is found, the specified context will be created.
- (NSDate *) dueDate [read, write, retain] |
An NSDate specifying when the task is due. If you leave this nil, you are specifying that the task should not have a due date.
- (BOOL) dueDateHasTime [read, write, assign] |
Specify YES when the dueDate contains specific information about the time that the task is due.
- (NSString *) list [read, write, retain] |
A case-insensitive list name that the task belongs to. If a matching list is found in Todo the task will be placed inside the corresponding list. If multiple lists with the same name exist in Todo, the list used for this task is undefined. If a matching list name is not found in Todo, the list will be created before assigning the task to the list.
- (NSString *) name [read, assign] |
The name of the task.
- (NSString *) note [read, write, retain] |
A string of supporting information about the task.
- (AppigoTaskPriority) priority [read, write, assign] |
An AppigoTaskPriority value to determine how important the task is.
- (NSInteger) repeat [read, write, assign] |
An integer value indicating whether the task should repeat. Specify 0 to indicate that the task does not repeat. Other allowed values are:
Repeat from Due Date
Repeat from Completion Date
- (NSDate *) startDate [read, write, retain] |
An NSDate specifying when work for this task should begin to occur. This field is meant for compatibility with some synchronization options and may/may not be shown in the user interface in an Appigo application.
- (NSArray*) subtasks [read, write, copy] |
An array of tasks that are the subtasks of a project or checklist type. If the task type is not set as Project/Checklist, any specified subtasks will be discarded when imported to Todo.
- (NSString *) tags [read, write, retain] |
A comma-separated list of tags to associate with the task. Non-existing tags will be created.
- (AppigoTaskType) type [read, assign] |
The task type. If left unspecified, AppigoTaskTypeNormal will be used.
- (NSArray *) typeKeys [read, assign] |
An array of keys (NSString *) with accompanying typeValues which specify additional type data information such as phone numbers, addresses, etc. which correspond to the task type.
- (NSArray *) typeValues [read, assign] |
An array of values (NSString *) corresponding to the typeKeys.