Zimlet JavaScript API Reference - ZmBriefcase

Class ZmBriefcase


Extends ZmFolder.

This class represents a briefcase. A briefcase contains briefcase items.

Defined in: ZmBriefcase.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmBriefcase(params)
Creates the briefcase
Method Summary
Method Attributes Method Name and Description
<static>  
ZmBriefcase.checkName(name)
Checks the briefcase name for validity.
 
mayContain(what, targetFolderType)
Returns true if the given object(s) may be placed in this folder.
 
Returns a string representation of the object.
Methods borrowed from class ZmFolder:
createQuery, getIcon, getName, hasFeeds, hasSearch, isHardDelete, isInSpam, isOutbound, 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
ZmBriefcase(params)
Creates the briefcase
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 briefcase
{String} params.owner
the owner of this organizer
{String} params.oname
the owner's name for this organizer
{String} params.zid Optional
the Zimbra id of owner, if remote share
{String} params.rid Optional
the Remote id of organizer, if remote share
{String} params.restUrl Optional
the REST URL of this organizer.
Method Detail
<static> {String} ZmBriefcase.checkName(name)
Checks the briefcase name for validity. Returns an error message if the name is invalid and null if the name is valid.
Parameters:
{String} name
a briefcase name
Returns:
{String} the name

mayContain(what, targetFolderType)
Returns true if the given object(s) may be placed in this folder. If the object is a folder, check that:
  • We are not the immediate parent of the folder
  • We are not a child of the folder
  • We are not Spam or Drafts
  • We don't already have a child with the folder's name (unless we are in Trash)
  • We are not moving a regular folder into a search folder
  • We are not moving a search folder into the Folders container
  • We are not moving a folder into itself
If the object is an item or a list or items, check that:
  • We are not the Folders container
  • We are not a search folder
  • The items aren't already in this folder
  • A contact can only be moved to Trash
  • A draft can be moved to Trash or Drafts
  • Non-drafts cannot be moved to Drafts
Parameters:
{Object} what
the object(s) to possibly move into this briefcase (item or organizer)
targetFolderType

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