Zimlet JavaScript API Reference - ZmInvite

Class ZmInvite


Extends ZmModel.

This class represents an invite to a calendar appointment.

Defined in: ZmInvite.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates an invite.
Method Summary
Method Attributes Method Name and Description
<static>  
ZmInvite.createFromDom(node)
Creates the invite from the DOM.
 
getAlarm(compNum)
Gets the alarm.
 
Gets the appointment id.
 
Gets the Appt summary.
 
getAttendees(compNum)
Gets the attendees.
 
Gets the component.
 
Gets the comment.
 
Gets the description.
 
Gets the description html.
 
Gets the components.
 
getDurationText(compNum, emptyAllDay, startOnly, isText, startDate, endDate)
Gets the duration text.
 
getEventName(compNum)
Gets the event name.
 
getExceptId(compNum)
Gets the except id.
 
getFreeBusy(compNum)
Gets the free busy.
 
getInviteMethod(compNum)
Gets the invite method.
 
getLocation(compNum)
Gets the location.
 
Gets the message id.
 
getName(compNum)
Gets the name.
 
Gets the organizer email.
 
Gets the organizer name.
 
getPrivacy(compNum)
Gets the privacy.
 
returns proposed time from counter invite
 
getRecurrenceId(compNum)
Gets the recurrence id (ridZ) - applicable to recurring appointment .
 
Gets the recurrence.
 
getReplies(compNum)
Gets the replies.
 
getResources(compNum)
Gets the resources.
 
getSentBy(compNum)
Gets the sent by.
 
getSequenceNo(compNum)
Gets the sequence no
 
getServerEndDate(compNum, noSpecialUtcCase)
Gets the server end date.
 
Gets the server end time.
 
Gets the server end time timezone.
 
getServerStartDate(compNum, noSpecialUtcCase)
Gets the server start date.
 
Gets the server start time.
 
Gets the server start time timezone.
 
Gets start date from exception ID.
 
getStatus(compNum)
Gets the status.
 
getSummary(isHtml)
Gets the summary.
 
Gets the tool tip in HTML for this invite.
 
getTransparency(compNum)
Gets the transparency.
 
getXProp(compNum)
Gets the x-prop.
 
Checks the invite has acceptable components.
 
Returns true if this invite has attendees, one of which replied back with an "actioned" response (e.g.
 
Checks the invite has a counter method.
 
Checks the invite has a reply method.
 
Checks if the invite has multiple components.
 
Checks if the invite has other attendees.
 
Checks if the invite has other individual (non-location & resource) attendees.
 
isAllDayEvent(compNum)
Checks if the invite is an all day event.
 
Checks if the invite is empty.
 
isException(compNum)
Checks if the invite is an exception.
 
Checks if this invite has html description.
 
isMultiDay(compNum)
Checks if the invite is multi-day.
 
isOrganizer(compNum)
Checks if is organizer.
 
isRecurring(compNum)
Checks if the invite is recurring.
 
Sets the message id.
 
shouldRsvp(compNum)
Gets the RSVP.
 
Returns a string representation of the object.
Methods borrowed from class ZmModel:
addChangeListener, removeAllChangeListeners, removeChangeListener
Class Detail
ZmInvite()
Creates an invite.
Method Detail
<static> {ZmInvite} ZmInvite.createFromDom(node)
Creates the invite from the DOM.
Parameters:
{Object} node
the node
Returns:
{ZmInvite} the newly created invite

{String} getAlarm(compNum)
Gets the alarm.
Parameters:
{int} compNum
the component number
Returns:
{String} the alarm or null for none

{String} getAppointmentId(compNum)
Gets the appointment id.
Parameters:
{int} compNum
the component number
Returns:
{String} the id

{String} getApptSummary(isHtml)
Gets the Appt summary.
Parameters:
{Boolean} isHtml
true to return summary as HTML
Returns:
{String} the appt summary

{Array} getAttendees(compNum)
Gets the attendees.
Parameters:
{int} compNum
the component number
Returns:
{Array} an array of attendees or an empty array for none

{Object} getComponent(id)
Gets the component.
Parameters:
{String} id
the component id
Returns:
{Object} the component

{String} getComponentComment(compNum)
Gets the comment.
Parameters:
{int} compNum
the component number
Returns:
{String} the comment or null for none

{String} getComponentDescription(compNum)
Gets the description.
Parameters:
{int} compNum
the component number
Returns:
{String} the description or null for none

{String} getComponentDescriptionHtml(compNum)
Gets the description html.
Parameters:
{int} compNum
the component number
Returns:
{String} the description html or null for none

{Array} getComponents()
Gets the components.
Returns:
{Array} an array of components

{String} getDurationText(compNum, emptyAllDay, startOnly, isText, startDate, endDate)
Gets the duration text.
Parameters:
{int} compNum
the component number
{Boolean} emptyAllDay
true to return an empty string "" if all day event.
{Boolean} startOnly
true to include start only
{Boolean} isText
true to return as text, not html
{Date} startDate
Optional. Start date to use instead of the original start date
{Date} endDate
Optional. End date to use instead of the original end date
Returns:
{String} the duration

{String} getEventName(compNum)
Gets the event name.
Parameters:
{int} compNum
the component number
Returns:
{String} the name or null for none

{String} getExceptId(compNum)
Gets the except id.
Parameters:
{int} compNum
the component number
Returns:
{String} the except id

{String} getFreeBusy(compNum)
Gets the free busy.
Parameters:
{int} compNum
the component number
Returns:
{String} the free busy

{String} getInviteMethod(compNum)
Gets the invite method.
Parameters:
{int} compNum
the component number
Returns:
{String} the method or null for none

{String} getLocation(compNum)
Gets the location.
Parameters:
{int} compNum
the component number
Returns:
{String} the location

{String} getMessageId()
Gets the message id.
Returns:
{String} the message id

{String} getName(compNum)
Gets the name.
Parameters:
{int} compNum
the component number
Returns:
{String} the name

{String} getOrganizerEmail(compNum)
Gets the organizer email.
Parameters:
{int} compNum
the component number
Returns:
{String} the organizer email or null for none

{String} getOrganizerName(compNum)
Gets the organizer name.
Parameters:
{int} compNum
the component number
Returns:
{String} the organizer name or null for none

{String} getPrivacy(compNum)
Gets the privacy.
Parameters:
{int} compNum
the component number
Returns:
{String} the privacy

{string} getProposedTimeStr(compNum)
returns proposed time from counter invite
Parameters:
{int} compNum
the component number
Returns:
{string} proposed time as formatted string

{String} getRecurrenceId(compNum)
Gets the recurrence id (ridZ) - applicable to recurring appointment .
Parameters:
{int} compNum
the component number
Returns:
{String} the recurrence id, null for non-recurring appointment

{ZmRecurrence} getRecurrenceRules(compNum)
Gets the recurrence.
Parameters:
{int} compNum
the component number
Returns:
{ZmRecurrence} the recurrence

{String} getReplies(compNum)
Gets the replies.
Parameters:
{int} compNum
the component number
Returns:
{String} the reply

{Array} getResources(compNum)
Gets the resources.
Parameters:
{int} compNum
the component number
Returns:
{Array} an array of resources

{String} getSentBy(compNum)
Gets the sent by.
Parameters:
{int} compNum
the component number
Returns:
{String} the sent by or null for none

{String} getSequenceNo(compNum)
Gets the sequence no
Parameters:
{int} compNum
the component number
Returns:
{String} the sequence no

{Date} getServerEndDate(compNum, noSpecialUtcCase)
Gets the server end date.
Parameters:
{int} compNum
the component number
noSpecialUtcCase
Returns:
{Date} the end date

{String} getServerEndTime(compNum)
Gets the server end time.
Parameters:
{int} compNum
the component number
Returns:
{String} the end time

{String} getServerEndTimeTz(compNum)
Gets the server end time timezone.
Parameters:
{int} compNum
the component number
Returns:
{String} the timezone

{Date} getServerStartDate(compNum, noSpecialUtcCase)
Gets the server start date.
Parameters:
{int} compNum
the component number
noSpecialUtcCase
Returns:
{Date} the start date

{Date} getServerStartTime(compNum)
Gets the server start time.
Parameters:
{int} compNum
the component number
Returns:
{Date} the start time

{String} getServerStartTimeTz(compNum)
Gets the server start time timezone.
Parameters:
{int} compNum
the component number
Returns:
{String} the timezone

getStartDateFromExceptId(compNum)
Gets start date from exception ID.
Parameters:
{int} compNum
the component number

{String} getStatus(compNum)
Gets the status.
Parameters:
{int} compNum
the component number
Returns:
{String} the status

{String} getSummary(isHtml)
Gets the summary.
Parameters:
{Boolean} isHtml
true to return summary as HTML
Returns:
{String} the summary

{String} getToolTip()
Gets the tool tip in HTML for this invite.

Note: This method assumes that there are currently one and only one component object on the invite.

Returns:
{String} the tool tip

{String} getTransparency(compNum)
Gets the transparency.
Parameters:
{int} compNum
the component number
Returns:
{String} the transparent value

{String} getXProp(compNum)
Gets the x-prop.
Parameters:
{int} compNum
the component number
Returns:
{String} the x-prop

{Boolean} hasAcceptableComponents()
Checks the invite has acceptable components.
Returns:
{Boolean} true if the invite has acceptable components

hasAttendeeResponse()
Returns true if this invite has attendees, one of which replied back with an "actioned" response (e.g. accept/decline/tentative)

{Boolean} hasCounterMethod(compNum)
Checks the invite has a counter method.
Parameters:
{int} compNum
the component number
Returns:
{Boolean} true if the invite has a counter method

{Boolean} hasInviteReplyMethod(compNum)
Checks the invite has a reply method.
Parameters:
{int} compNum
the component number
Returns:
{Boolean} true if the invite has a method that REQUIRES a reply (ironically NOT REPLY method but rather REQUEST or PUBLISH)

{Boolean} hasMultipleComponents()
Checks if the invite has multiple components.
Returns:
{Boolean} true if the invite has one or more components

{Boolean} hasOtherAttendees(compNum)
Checks if the invite has other attendees.
Parameters:
{int} compNum
the component number
Returns:
{Boolean} true if the invite has more than one other attendee

{Boolean} hasOtherIndividualAttendees(compNum)
Checks if the invite has other individual (non-location & resource) attendees.
Parameters:
{int} compNum
the component number
Returns:
{Boolean} true if the invite has more than one other individual attendee

{Boolean} isAllDayEvent(compNum)
Checks if the invite is an all day event.
Parameters:
{int} compNum
the component number
Returns:
{Boolean} true if an all day event

{Boolean} isEmpty()
Checks if the invite is empty.
Returns:
{Boolean} true if the invite is empty

{Boolean} isException(compNum)
Checks if the invite is an exception.
Parameters:
{int} compNum
the component number
Returns:
{Boolean} true if exception

{Boolean} isHtmlInvite()
Checks if this invite has html description.
Returns:
{Boolean} true if this invite has HTML description

{Boolean} isMultiDay(compNum)
Checks if the invite is multi-day.
Parameters:
{int} compNum
the component number
Returns:
{Boolean} true if the invite is multi-day

{Boolean} isOrganizer(compNum)
Checks if is organizer.
Parameters:
{int} compNum
the component number
Returns:
{Boolean} true if is organizer

{Boolean} isRecurring(compNum)
Checks if the invite is recurring.
Parameters:
{int} compNum
the component number
Returns:
{Boolean} true if recurring
See:
#getRecurrenceRules

setMessageId(id)
Sets the message id.
Parameters:
{String} id
the message id

{String} shouldRsvp(compNum)
Gets the RSVP.
Parameters:
{int} compNum
the component number
Returns:
{String} the RSVP or null for none

{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:38 GMT-0400 (EDT)