Class ZmList
Class Detail
ZmList(type, search)
Creates an empty list of items of the given type.
Author: Conrad Damon.
Method Detail
add(item, index)
Adds an item to the list.
addFromDom(node, args)
Adds an item to the list from the given XML node.
cache(offset, newList)
Caches the list.
clear()
Clears the list, including the id hash.
copyItems(params)
Copies a list of items to the given folder.
{ZmItem}
create(args)
Creates an item from the given arguments. A subclass may override
sortIndex() to add it to a particular point in the list. By default, it
will be added at the end.
The item will invoke a SOAP call, which generates a create notification from the server. That will be handled by notifyCreate(), which will call _notify() so that views can be updated.
createLocal(item)
Creates the item (local).
deleteItems(params)
Deletes one or more items from the list. Normally, deleting an item just
moves it to the Trash (soft delete). However, if it's already in the Trash,
it will be removed from the data store (hard delete).
deleteLocal(items)
Deletes the items (local).
flagItems(params)
Sets and unsets a flag for each of a list of items.
{ZmItem}
get(index)
Gets the item.
<static>
{String}
ZmList.getActionSummary(params)
Returns a string describing an action, intended for display as toast to tell the
user what they just did.
{Array}
getArray()
Returns the list as an array.
{ZmItem}
getById(id)
Gets the item with the given id.
{AjxVector}
getSubList(offset, limit)
Gets a vector containing a subset of items of this list.
{AjxVector}
getVector()
Returns the list as a vector.
{Boolean}
hasMore()
Gets if there are more items for this search.
{int}
indexOf(item)
Returns the index of the given item in the list.
modifyItem(item, mods, callback)
Applies the given list of modifications to the item.
modifyLocal(items, mods)
Modifies the items (local).
moveItems(params)
Moves a list of items to the given folder.
Search results are treated as though they're in a temporary folder, so that they behave as they would if they were in any other folder such as Inbox. When items that are part of search results are moved, they will disappear from the view, even though they may still satisfy the search.
moveLocal(items, folderId)
Moves the items (local).
notifyCreate(node)
Create notification.
remove(item)
Removes an item from the list.
removeAllTags(params)
Removes all tags from a list of items.
set(respNode)
Populates the list with elements created from the response to a SOAP command. Each
node in the response should represent an item of the list's type. Items are added
in the order they are received; no sorting is done.
setHasMore(bHasMore)
Sets the "more" flag for this list.
{int}
size()
Returns the number of items in the list.
tagItems(params)
Tags or untags a list of items. A sanity check is done first, so that items
aren't tagged redundantly, and so we don't try to remove a nonexistent tag.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:38 GMT-0400 (EDT)
|