Zimlet JavaScript API Reference - ZmBriefcaseBaseItem

Class ZmBriefcaseBaseItem


Extends ZmItem.

This class is a base class for briefcase item classes.

Defined in: ZmBriefcaseItem.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmBriefcaseBaseItem(id, list, noCache, type)
Abstract class
Method Summary
Method Attributes Method Name and Description
 
createFromAttachment(msgId, partId, name, folderId, attribs)
Creates an item from an attachment.
 
Gets the briefcase folder.
 
Gets the content type.
 
Gets the folder.
 
getIcon(large)
Gets the icon.
 
getPath(dontIncludeThisName)
Gets the path.
 
getRestUrl(dontIncludeThisName, ignoreCustomDocs, includeVersion)
Gets the REST URL.
 
Checks if this item is an document which can only be downloaded and cannot be rendered by browser
 
Checks if this item is read only.
 
Checks if this item is a real file.
 
Checks if this item is shared.
 
Checks if this item is a web doc.
Methods borrowed from class ZmItem:
cache, canAddTag, clear, create, deleteLocal, flagLocal, getById, getDefaultDndAction, getFolderId, getTagImageFromIds, getTagImageInfo, hasTag, modify, move, moveLocal, removeAllTagsLocal, rename, setFlag, tagLocal
Methods borrowed from class ZmModel:
addChangeListener, removeAllChangeListeners, removeChangeListener
Class Detail
ZmBriefcaseBaseItem(id, list, noCache, type)
Abstract class
Parameters:
{int} id
the unique id
{ZmList} list
a list that contains this item
{Boolean} noCache
if true, do not cache this item
type
See:
ZmBriefcaseBaseItem
Method Detail
createFromAttachment(msgId, partId, name, folderId, attribs)
Creates an item from an attachment.
Parameters:
{String} msgId
the message
{String} partId
the message part
{String} name
the item name
{String} folderId
the folder id
attribs

{ZmBriefcase} getBriefcaseFolder()
Gets the briefcase folder.
Returns:
{ZmBriefcase} the folder

{String} getContentType()
Gets the content type.
Returns:
{String} the content type

{ZmFolder} getFolder()
Gets the folder.
Returns:
{ZmFolder} the folder

{String} getIcon(large)
Gets the icon.
Parameters:
{Boolean} large
if true, return the large icon
Returns:
{String} the icon

{String} getPath(dontIncludeThisName)
Gets the path.
Parameters:
{Boolean} dontIncludeThisName
if true, do not include this item name in the path
Returns:
{String} the path

{String} getRestUrl(dontIncludeThisName, ignoreCustomDocs, includeVersion)
Gets the REST URL.
Parameters:
{Boolean} dontIncludeThisName
if true, do not include this item name in the path
{Boolean} ignoreCustomDocs
if true, ignore custom docs
{Boolean} includeVersion
if true include the version if exists (it's latest for the base item)
Returns:
{String} the REST URL

{Boolean} isDownloadable()
Checks if this item is an document which can only be downloaded and cannot be rendered by browser
Returns:
{Boolean} true if this item is downloadable

{Boolean} isReadOnly()
Checks if this item is read only.
Returns:
{Boolean} true if this item is read only

{Boolean} isRealFile()
Checks if this item is a real file.
Returns:
{Boolean} true if this item is a real file (not a web doc or folder)

{Boolean} isShared()
Checks if this item is shared.
Returns:
{Boolean} true if this item is shared

{Boolean} isWebDoc()
Checks if this item is a web doc.
Returns:
{Boolean} true if this item is a web doc

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