Zimlet JavaScript API Reference - ZmTask

Class ZmTask


Extends ZmCalItem.

This class represents a task.

Defined in: ZmTask.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmTask(list, id, folderId)
Method Summary
Method Attributes Method Name and Description
<static>  
ZmTask.createFromDom(taskNode, args, instNode)
Creates a task from the DOM.
 
Gets the end time.
 
Gets the folder.
 
Gets the icon.
 
 
Gets the percent complete (between 0 and 100).
 
Gets the priority.
 
Gets the "owner" of remote/shared calItem folder this calItem belongs to.
 
Gets the start time.
 
Gets the status.
 
Checks if alarm is in range (based on current time).
 
Checks if alarm is modified.
 
Checks if the task is complete.
<static>  
ZmTask.isInTrash(task)
Checks if the task is in the trash.
 
Checks if this item is multi-day.
 
Checks if this task is past due.
 
Returns a string representation of the object.
Methods borrowed from class ZmCalItem:
addExceptionDetails, addReminderAction, cancel, clearRecurrence, getAttachments, getDateRange, getDetails, getHtmlSummary, getInviteDescription, getLocalFolderId, getMailFromAddress, getMailNotificationOption, getNotesPart, getOrganizer, getOrganizerName, getOrig, getOrigEndDate, getOrigEndTime, getOrigStartDate, getOrigStartTime, getOrigTimezone, getRecurBlurb, getRecurrence, getRecurType, getSentBy, getShortStartHour, getSummary, getTextSummary, getTimezone, getToolTip, getUniqueEndDate, getUniqueStartDate, getViewMode, hasAttachments, hasAttendeeForType, hasAttendees, hasPersonAttendees, isCustomRecurrence, isEndInRange, isFolderReadOnly, isInRange, isOrganizer, isOverlapping, isReadOnly, isRecurring, isStartInRange, isValidDuration, isValidDurationRecurrence, removeAttachment, removeReminderAction, resetRepeatCustomDayOfWeek, resetRepeatMonthlyDayList, resetRepeatWeeklyDays, resetRepeatYearlyMonthsList, save, setAllDayEvent, setAttachments, setDateRange, setEndDate, setEndTimezone, setFolderId, setFromSavedResponse, setMailNotificationOption, setName, setOrganizer, setOrigTimezone, setRecurType, setReminderMinutes, setReminderUnits, setStartDate, setTextNotes, setTimezone, setType, setViewMode
Methods borrowed from class ZmCalBaseItem:
adjustMS, getAlarmData, getAlarmInstStart, getDuration, getDurationText, getLocation, getName, getParticipantStatusStr, getReminderName, getUniqueId, hasAlarmData, isAlarmInstance, isAlarmOld, isAllDayEvent
Methods borrowed from class ZmItem:
cache, canAddTag, clear, create, deleteLocal, flagLocal, getById, getDefaultDndAction, getFolderId, getRestUrl, getTagImageFromIds, getTagImageInfo, hasTag, isShared, modify, move, moveLocal, removeAllTagsLocal, rename, setFlag, tagLocal
Methods borrowed from class ZmModel:
addChangeListener, removeAllChangeListeners, removeChangeListener
Class Detail
ZmTask(list, id, folderId)

Author: Parag Shah.
Parameters:
{Object} list
the list
{int} id
the task id
{String} folderId
the folder id
Method Detail
<static> {ZmTask} ZmTask.createFromDom(taskNode, args, instNode)
Creates a task from the DOM.
Parameters:
{Object} taskNode
the task
{Hash} args
arguments
{Object} instNode
(not used)
Returns:
{ZmTask} the task

{Date} getEndTime()
Gets the end time.
Returns:
{Date} the end time

{ZmTaskFolder} getFolder()
Gets the folder.
Returns:
{ZmTaskFolder} the folder

{String} getIcon()
Gets the icon.
Returns:
{String} the icon

{id} getId()
Returns:
{id} task id

{int} getPercentComplete()
Gets the percent complete (between 0 and 100).
Returns:
{int} the percentage complete

{int} getPriority()
Gets the priority.
Returns:
{int} the priority
See:
ZmCalItem.PRIORITY_LOW
ZmCalItem.PRIORITY_NORMAL
ZmCalItem.PRIORITY_HIGH
ZmCalItem.getLabelForPriority
ZmCalItem.getImageForPriority

{ZmFolder} getRemoteFolderOwner()
Gets the "owner" of remote/shared calItem folder this calItem belongs to.
Returns:
{ZmFolder} the folder

{Date} getStartTime()
Gets the start time.
Returns:
{Date} the start time

{int} getStatus()
Gets the status.
Returns:
{int} the status
See:
ZmCalendarApp.STATUS_COMP
ZmCalendarApp.STATUS_DEFR
ZmCalendarApp.STATUS_INPR
ZmCalendarApp.STATUS_NEED
ZmCalendarApp.STATUS_WAIT
ZmCalItem.getLabelForStatus

{Boolean} isAlarmInRange()
Checks if alarm is in range (based on current time).
Returns:
{Boolean} true if the alarm is in range

{Boolean} isAlarmModified()
Checks if alarm is modified.
Returns:
{Boolean} true if the alarm is modified

{Boolean} isComplete()
Checks if the task is complete.
Returns:
{Boolean} true if the task is complete

<static> {Boolean} ZmTask.isInTrash(task)
Checks if the task is in the trash.
Parameters:
{ZmTask} task
the task
Returns:
{Boolean} true if in trash

{Boolean} isMultiDay()
Checks if this item is multi-day.
Returns:
{Boolean} true if start date and end date are on different days
See:
#getStartTime
#getEndTime

{Boolean} isPastDue()
Checks if this task is past due.
Returns:
{Boolean} true if the task is past due

{String} toString()
Returns a string representation of the object.
Returns:
{String} a string representation of the object

Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:43 GMT-0400 (EDT)