Class ZmCalItem
Class Detail
ZmCalItem(type, list, id, folderId)
Field Detail
<static>
ZmCalItem.MODE_COPY_SINGLE_INSTANCE
Defines the "copy single instance" mode.
<static>
ZmCalItem.MODE_DELETE
Defines the "delete" mode.
<static>
ZmCalItem.MODE_DELETE_INSTANCE
Defines the "delete instance" mode.
<static>
ZmCalItem.MODE_DELETE_SERIES
Defines the "delete series" mode.
<static>
ZmCalItem.MODE_EDIT
Defines the "edit" mode.
<static>
ZmCalItem.MODE_EDIT_SERIES
Defines the "edit series" mode.
<static>
ZmCalItem.MODE_EDIT_SINGLE_INSTANCE
Defines the "edit single instance" mode.
<static>
ZmCalItem.MODE_FORWARD
Defines the "forward" mode.
<static>
ZmCalItem.MODE_FORWARD_INVITE
Defines the "forward" mode.
<static>
ZmCalItem.MODE_FORWARD_SERIES
Defines the "forward series" mode.
<static>
ZmCalItem.MODE_FORWARD_SINGLE_INSTANCE
Defines the "forward single instance" mode.
<static>
ZmCalItem.MODE_GET
Defines the "get" mode.
<static>
ZmCalItem.MODE_LAST
Defines the "last" mode index constant.
<static>
ZmCalItem.MODE_NEW
Defines the "new" mode.
<static>
ZmCalItem.MODE_NEW_FROM_QUICKADD
Defines the "new from quick" mode.
<static>
ZmCalItem.MODE_PROPOSE_TIME
Defines the "propose" mode.
<static>
ZmCalItem.MODE_PURGE
Defines the "purge" (delete from trash) mode.
<static>
ZmCalItem.PRIORITY_HIGH
Defines the "high" priority.
<static>
ZmCalItem.PRIORITY_LOW
Defines the "low" priority.
<static>
ZmCalItem.PRIORITY_NORMAL
Defines the "normal" priority.
<static>
ZmCalItem.REMINDER_NONE
Defines "none" reminder.
<static>
ZmCalItem.REMINDER_UNIT_DAYS
Defines "days" reminder units.
<static>
ZmCalItem.REMINDER_UNIT_HOURS
Defines "hours" reminder units.
<static>
ZmCalItem.REMINDER_UNIT_MINUTES
Defines "minutes "reminder units.
<static>
ZmCalItem.REMINDER_UNIT_WEEKS
Defines "weeks" reminder units.
<static>
ZmCalItem.ROLE_CHAIR
Defines the "chair" role.
<static>
ZmCalItem.ROLE_NON_PARTICIPANT
Defines the "non-participant" role.
<static>
ZmCalItem.ROLE_OPTIONAL
Defines the "optional" role.
<static>
ZmCalItem.ROLE_REQUIRED
Defines the "required" role.
Method Detail
addExceptionDetails(comp)
Sets the exception details to request
addReminderAction(action)
Adds the given action to this appt's reminders. A type of action can only be added once.
cancel(mode, msg, callback, errorCallback, batchCmd)
Deletes/cancels appointment/invite
clearRecurrence()
clears the recurrence.
Defined in: ZmAppt.js.
{Array}
getAttachments()
Gets the attachments.
{Hash}
getDateRange(instance, current, refPath)
Gets the date range.
getDetails(viewMode, callback, errorCallback, ignoreOutOfDate, noBusyOverlay, batchCmd)
Gets the details.
{Object}
getFolder()
Gets the folder.
{String}
getHtmlSummary()
Gets the summary as HTML.
<static>
{String}
ZmCalItem.getImageForPriority(task, id)
Gets the priority image.
{String}
getInviteDescription(isHtml)
Gets a string representation of the invite content.
<static>
{String}
ZmCalItem.getLabelForParticipationStatus(status)
Gets the participation status label.
<static>
{String}
ZmCalItem.getLabelForPriority(priority)
Gets the priority label.
<static>
{String}
ZmCalItem.getLabelForStatus(status)
Gets the status label.
{ZmFolder|String}
getLocalFolderId()
Gets the "local" folder id even for remote folders. Otherwise, just use
this.folderId .
{String}
getMailFromAddress()
Gets the mail from address.
{Boolean}
getMailNotificationOption()
Gets the mail notification option.
{String}
getNotesPart(contentType)
Gets the notes part. This method will walk the notesParts array looking for
the first part that matches given content type.
{String}
getOrganizer()
Gets the organizer.
{String}
getOrganizerName()
Gets the organizer name.
{ZmCalItem}
getOrig()
Gets the original calendar item.
{Date}
getOrigEndDate()
Gets the original end date.
{Date}
getOrigEndTime()
Gets the original end time.
{Date}
getOrigStartDate()
Gets the original start date.
{Date}
getOrigStartTime()
Gets the original start time.
{Date}
getOrigTimezone()
Gets the original timezone.
<static>
{String}
ZmCalItem.getParticipationStatusIcon(status)
Gets the participation status icon.
{String}
getRecurBlurb()
Gets the recurrence "blurb".
{ZmRecurrence}
getRecurrence()
Gets the recurrence.
{String}
getRecurType()
Gets the recurrence "type".
{String}
getRemoteFolderOwner()
Gets the remote folder owner.
{String}
getSentBy()
Gets the sent by.
{String}
getShortStartHour()
Gets the start hour in short date format.
{String}
getSummary(isHtml)
Gets the summary.
{String}
getTextSummary()
Gets the summary as text.
{AjxTimezone}
getTimezone()
Gets the timezone.
{String}
getToolTip(controller)
Gets the tool tip.
{Date}
getUniqueEndDate()
Gets the unique end date.
{Date}
getUniqueStartDate()
Gets the unique start date.
getViewMode(mode)
Gets the view mode
{Boolean}
hasAttachments()
Checks if this item has attachments.
{Boolean}
hasAttendeeForType(type)
Checks if this item has attendee type.
{Boolean}
hasAttendees()
Checks if this item has attendees.
{Boolean}
hasPersonAttendees()
Checks if this item has person attendees.
{Boolean}
isCustomRecurrence()
Checks if this item has a custom recurrence.
{Boolean}
isEndInRange(startTime, endTime)
Checks if the end date is in range.
{Boolean}
isFolderReadOnly()
Checks if the folder containing the item is read-only by the .
{Boolean}
isInRange(startTime, endTime)
Checks if this item is in range.
{Boolean}
isOrganizer()
Checks if this item is an organizer.
{Boolean}
isOverlapping(other, checkFolder)
Checks if the item is overlapping.
{Boolean}
isReadOnly()
Checks if the item is read-only.
{Boolean}
isRecurring()
Checks if this item is recurring.
{Boolean}
isStartInRange(startTime, endTime)
Checks if the start date is in range.
{Boolean}
isValidDuration()
Checks whether the duration of this item is valid.
{Boolean}
isValidDurationRecurrence()
Checks whether the duration of this item is valid with respect to the
recurrence period. For example, if the item repeats daily, its duration
should not be longer than a day.
This can get very complicated due to custom repeat rules. So the
limitation is just set on the repeat type. The purpose is to prevent
(as has happened) someone creating a repeating appt where they set the
duration to be the span the appt is in effect over a year instead of its
duration during the day. For example, repeat daily, start = Jan 1 2014,
end = July 1 2014. See Bug 87993.
removeAttachment(part)
Removes an attachment.
removeReminderAction(action)
Removes the given action from this appt's reminders.
resetRepeatCustomDayOfWeek()
Resets the repeat custom day of week.
resetRepeatMonthlyDayList()
Resets the repeat monthly day months list.
resetRepeatWeeklyDays()
Resets the repeat weekly days.
resetRepeatYearlyMonthsList(mo)
Resets the repeat yearly months list.
save(attachmentId, callback, errorCallback, notifyList)
Saves the item.
setAllDayEvent(isAllDay)
Sets all day event.
setAttachments(ids)
Sets the attachments.
setDateRange(rangeObject, instance, parentValue, refPath)
Sets the date range.
setEndDate(endDate, keepCache)
Sets the end date.
setEndTimezone(timezone)
Sets the end timezone.
setFolderId(folderId)
Sets the folder id.
setFromSavedResponse(result)
Sets the required data from saved response
setMailNotificationOption(sendNotificationMail)
Sets the mail notification option.
setName(newName)
Sets the name.
setOrganizer(organizer)
Sets the organizer.
setOrigTimezone(timezone)
Sets the original timezone.
setRecurType(repeatType)
Sets the repeat type.
setReminderMinutes(minutes)
Sets reminder minutes.
setReminderUnits(reminderValue, reminderUnits, sendEmail)
Sets the reminder units
setStartDate(startDate, keepCache)
Sets the start date.
setTextNotes(notes)
Sets the notes (text/plain).
setTimezone(timezone, keepCache)
Sets the timezone.
setType(newType)
Sets the item type.
setViewMode(mode)
Sets the view mode, and resets any other fields that should not be set for that view mode.
{String}
toString()
Returns a string representation of the object.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:33 GMT-0400 (EDT)
|