Class ZmItem
Class Detail
ZmItem(type, id, list, noCache)
Creates an item.
Author: Conrad Damon.
Field Detail
<static>
ZmItem.DND_ACTION_BOTH
Defines the "move & copy" action.
<static>
ZmItem.DND_ACTION_COPY
Defines the "copy" action.
<static>
ZmItem.DND_ACTION_MOVE
Defines the "move" action.
<static>
ZmItem.NOTES_SEPARATOR
Defines the notes separator which is used by items
(such as calendar or share invites) that have notes.
Method Detail
{Boolean}
cache()
Caches the item.
{boolean}
canAddTag(tagName)
is it possible to add a tag to this item?
clear()
Clears the item.
create(args)
Creates an item.
deleteLocal()
Deletes local, in case an item wants to do something while being deleted.
flagLocal(flag, on)
Applies the given flag change to this item by setting a boolean property.
{ZmItem}
getById(id)
Gets the item by id.
{Object}
getDefaultDndAction(forceCopy)
Gets the default action to use when dragging this item. This method
is meant to be overloaded for items that are read-only and can only be copied.
{String}
getFolderId()
Gets the folder id that contains this item, if available.
<static>
{String}
ZmItem.getItemId(id)
Gets an item id by taking a normalized id (or an item id) and returning the item id.
{String}
getRestUrl()
Gets the rest url for this item.
getTagImageFromIds(tagIds)
{String}
getTagImageInfo()
Gets the appropriate tag image info for this item.
{Boolean}
hasTag(tagName)
Checks if the item has a given tag.
{Boolean}
isReadOnly()
Checks if this item is read-only. This method should be
overloaded by the derived object to determine what "read-only" means.
{Boolean}
isShared()
Checks if this item is shared.
modify(mods)
Modifies an item.
<static>
{Object}
ZmItem.move(itemId, folderId, callback, errorCallback, accountName)
Moves the item.
{Object}
move(folderId, callback, errorCallback)
Moves the item.
moveLocal(folderId)
Updates the folder for this item.
<static>
ZmItem.registerItem(item, params)
Registers an item and stores information about the given item type.
removeAllTagsLocal()
Removes all tags.
<static>
{Object}
ZmItem.rename(itemId, newName, callback, errorCallback, accountName)
Rename the item.
{Object}
rename(newName, callback, errorCallback)
Rename the item.
{String}
setFlag(flag, on)
Sets the given flag change to this item. Both the flags string and the
flag properties are affected.
{Boolean}
tagLocal(tag, doTag)
Adds or removes the given tag for this item.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:38 GMT-0400 (EDT)
|