Zimlet JavaScript API Reference - ZmCalendar

Class ZmCalendar


Extends ZmFolder.



Defined in: ZmCalendar.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmCalendar(params)
Creates a calendar.
Method Summary
Method Attributes Method Name and Description
<static>  
ZmCalendar.checkName(name)
Checks the calendar name.
<static>  
ZmCalendar.create(params)
Creates a new calendar.
 
Gets the icon.
 
Checks if the calendar is read-only.
 
mayContain(what)
Checks if the given object(s) may be placed in this folder.
 
setFreeBusy(exclude, callback, errorCallback, batchCmd)
Sets the free/busy.
 
supportsPublicAccess()
Methods borrowed from class ZmFolder:
createQuery, getName, hasFeeds, hasSearch, isHardDelete, isInSpam, isOutbound, move, notifyCreate, notifyModify, toggleSyncOffline
Methods borrowed from class ZmOrganizer:
addChangeListener, addShare, clearShares, deleteLocal, empty, getAccount, getById, getByName, getByPath, getByType, getChild, getChildByPath, getColor, getDataSources, getFolder, getIconWithColor, getMainShare, getOwner, getOwnerRestUrl, getPath, getRemoteId, getRestUrl, getSearchPath, getShares, getSyncUrl, getToolTip, getUrl, hasChild, hasPrivateAccess, hasUnreadDescendent, isAdmin, isChildOf, isColorChanged, isDataSource, isFeed, isInTrash, isPermAllowed, isRemote, isSystem, isUnder, markAllRead, notifyDelete, removeChangeListener, rename, reparent, setColor, setGlobalMarkRead, setOfflineSyncInterval, setRetentionPolicy, setRGB, size, supportsPrivatePermission, supportsSharing, sync, update
Class Detail
ZmCalendar(params)
Creates a calendar.
Author: Andy Clark.
Parameters:
{Hash} params
a hash of parameters:
{int} params.id
the numeric ID
{String} params.name
the name
{ZmOrganizer} params.parent
the parent organizer
{ZmTree} params.tree
the tree model that contains this organizer
{constant} params.color
the color for this calendar
{String} params.url
the URL for this organizer's feed
{String} params.owner
the owner of this calendar
{String} params.zid
the Zimbra id of owner, if remote share
{String} params.rid
the remote id of organizer, if remote share
{String} params.restUrl
the REST URL of this organizer
Method Detail
<static> {String} ZmCalendar.checkName(name)
Checks the calendar name.
Parameters:
{String} name
the name to check
Returns:
{String} the valid calendar name

<static> ZmCalendar.create(params)
Creates a new calendar. The color and flags will be set later in response to the create notification. This function is necessary because calendar creation needs custom error handling.
Parameters:
{Hash} params
a hash of parameters

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

{Boolean} isReadOnly()
Checks if the calendar is read-only.
Returns:
{Boolean} true if read-only

{Boolean} mayContain(what)
Checks if the given object(s) may be placed in this folder. For calendars being dragged, the current target cannot: - Be the parent of the dragged calendar - Be the dragged calendar - Be an ancestor of the dragged calendar - Contain a calendar with the same name as the dragged calendar - Be a shared calendar
Parameters:
{Object} what
the object(s) to possibly move into this folder (item or organizer)
Returns:
{Boolean} true if the object may be placed in this folder

setFreeBusy(exclude, callback, errorCallback, batchCmd)
Sets the free/busy.
Parameters:
{Boolean} exclude
if true, exclude free busy
{AjxCallback} callback
the callback
{AjxCallback} errorCallback
the error callback
{ZmBatchCommand} batchCmd
optional batch command

supportsPublicAccess()

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