Zimlet JavaScript API Reference - ZmTaskFolder

Class ZmTaskFolder


Extends ZmFolder.

This class represents a task folder.

Defined in: ZmTaskFolder.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmTaskFolder(params)
Creates the task folder.
Method Summary
Method Attributes Method Name and Description
<static>  
ZmTaskFolder.checkName(name)
Checks the name for validity
 
setFreeBusy(callback, errorCallback, exclude)
Sets the free/busy.
 
Returns a string representation of the object.
Methods borrowed from class ZmFolder:
createQuery, getIcon, getName, hasFeeds, hasSearch, isHardDelete, isInSpam, isOutbound, mayContain, move, notifyCreate, notifyModify, supportsPublicAccess, 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, isReadOnly, isRemote, isSystem, isUnder, markAllRead, notifyDelete, removeChangeListener, rename, reparent, setColor, setGlobalMarkRead, setOfflineSyncInterval, setRetentionPolicy, setRGB, size, supportsPrivatePermission, supportsSharing, sync, update
Class Detail
ZmTaskFolder(params)
Creates the task folder.
Author: Parag Shah.
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
{String} params.color
the color
{String} params.url
the URL for this organizer's feed
{String} params.owner
the owner
{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} ZmTaskFolder.checkName(name)
Checks the name for validity
Parameters:
name
Returns:
{String} an error message if the name is invalid; null if the name is valid.

setFreeBusy(callback, errorCallback, exclude)
Sets the free/busy.
Parameters:
{AjxCallback} callback
the callback
{AjxCallback} errorCallback
the error callback
{Boolean} exclude
checks to exclose free busy

{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)