Zimlet JavaScript API Reference - ZmAppt

Class ZmAppt


Extends ZmCalItem.

This class represents a calendar item.

Defined in: ZmAppt.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmAppt(list, noinit)
Method Summary
Method Attributes Method Name and Description
 
getApptTimeSummary(buf, i, isHtml, isEdit)
Gets the appointment time summary.
 
Gets the attendees.
 
getAttendeesText(type, inclDispName)
Gets the attendee as text.
 
Gets the folder.
 
Returns an object with layout coordinates for this appointment.
 
Gets the summary for proposed time
 
getRecurrenceSummary(buf, i, isHtml, isEdit)
Gets the recurrence summary.
 
getSummary(isHtml)
Gets the summary.
 
getToolTip(controller)
Gets the tool tip.
 
Checks if the appointment has attendees of the specified type.
 
Checks if the appointment has any attendees.
 
Checks if the appointment is private.
 
Checks whether appointment needs a recurrence info in summary
 
setAttendees(list, type)
Sets the attendees (person, location, or equipment) for this appt.
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, getRemoteFolderOwner, getSentBy, getShortStartHour, getTextSummary, getTimezone, getUniqueEndDate, getUniqueStartDate, getViewMode, hasAttachments, 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, toString
Methods borrowed from class ZmCalBaseItem:
adjustMS, getAlarmData, getAlarmInstStart, getDuration, getDurationText, getEndTime, getLocation, getName, getParticipantStatusStr, getReminderName, getStartTime, getUniqueId, hasAlarmData, isAlarmInRange, isAlarmInstance, isAlarmOld, isAllDayEvent, isMultiDay
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
ZmAppt(list, noinit)
Parameters:
{ZmList} list
the list
{Boolean} noinit
if true, do not initialize the appointment
Method Detail
{String} getApptTimeSummary(buf, i, isHtml, isEdit)
Gets the appointment time summary.
Parameters:
{Array} buf
buffer array to fill summary content
{Integer} i
buffer array index to start filling
{Boolean} isHtml
if true, format as html
{Boolean} isEdit
if view mode is edit/edit instance/edit series
Returns:
{String} the appointment time summary

{Array} getAttendees(type)
Gets the attendees.
Parameters:
{constant} type
the type
Returns:
{Array} an array of attendee objects
See:
ZmCalBaseItem.PERSON
ZmCalBaseItem.LOCATION
ZmCalBaseItem.EQUIPMENT

{String} getAttendeesText(type, inclDispName)
Gets the attendee as text.
Parameters:
{constant} type
the type
{Boolean} inclDispName
if true, include the display name
Returns:
{String} the attendee string

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

getLayoutInfo()
Returns an object with layout coordinates for this appointment.

{String} getProposedTimeSummary(isHtml)
Gets the summary for proposed time
Parameters:
{Boolean} isHtml
if true, format as html
Returns:
{String} the summary

{String} getRecurrenceSummary(buf, i, isHtml, isEdit)
Gets the recurrence summary.
Parameters:
{Array} buf
buffer array to fill summary content
{Integer} i
buffer array index to start filling
{Boolean} isHtml
if true, format as html
{Boolean} isEdit
if view mode is edit/edit instance/edit series
Returns:
{String} the recurrence summary

{String} getSummary(isHtml)
Gets the summary.
Parameters:
{Boolean} isHtml
if true, format as html
Returns:
{String} the summary

{Hash|String} getToolTip(controller)
Gets the tool tip. If it needs to make a server call, returns a callback instead.
Parameters:
{ZmController} controller
the controller
Returns:
{Hash|String} the callback {Hash} or tool tip

{Boolean} hasAttendeeForType(type)
Checks if the appointment has attendees of the specified type.
Parameters:
{constant} type
the type
Returns:
{Boolean} true if the appointment has 1 or more attendees

{Boolean} hasAttendees()
Checks if the appointment has any attendees.
Returns:
{Boolean} true if the appointment has 1 or more attendees

{Boolean} isPrivate()
Checks if the appointment is private.
Returns:
{Boolean} true if the appointment is private

{Boolean} needsRecurrenceSummary()
Checks whether appointment needs a recurrence info in summary
Returns:
{Boolean} returns whether appointment needs recurrence summary

setAttendees(list, type)
Sets the attendees (person, location, or equipment) for this appt.
Parameters:
{Array} list
the list of email {String}, AjxEmailAddress, ZmContact, or ZmResource
{constant} type
the type

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