Zimlet JavaScript API Reference - ZmSearchFolder

Class ZmSearchFolder


Extends ZmFolder.

This class represents a search folder.

Defined in: ZmSearchFolder.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmSearchFolder(params)
Creates the search folder.
Method Summary
Method Attributes Method Name and Description
<static>  
ZmSearchFolder.create(params)
Creates a search folder.
 
Gets the icon.
 
Gets the tool tip.
 
setQuery(query, callback, errorCallback, batchCmd)
Sets the underlying search query.
 
Returns a string representation of the object.
Methods borrowed from class ZmFolder:
createQuery, 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, 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
ZmSearchFolder(params)
Creates the search folder.
Parameters:
{Hash} params
a hash of parameters
Method Detail
<static> ZmSearchFolder.create(params)
Creates a search folder.
Parameters:
{Hash} params
a hash of parameters

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

getToolTip()
Gets the tool tip.

setQuery(query, callback, errorCallback, batchCmd)
Sets the underlying search query.
Parameters:
{String} query
search query
{AjxCallback} callback
the callback
{AjxCallback} errorCallback
the error callback
{ZmBatchCommand} batchCmd
the batch command

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