Zimlet JavaScript API Reference - ZmApptList

Class ZmApptList


Extends ZmList.

This class represents a list of appointments.

Defined in: ZmApptList.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Create a new, empty appointment list.
Method Summary
Method Attributes Method Name and Description
 
getSubset(startTime, endTime)
Gets a new appointment list containing only appointment in the given range.
<static>  
ZmApptList.mergeVectors(vecArray)
Merges all the sorted vectors in the specified array into a single sorted vector.
 
moveItems(params)
Moves a list of items to the given folder.
Methods borrowed from class ZmList:
add, addFromDom, cache, clear, copyItems, create, createLocal, deleteItems, deleteLocal, flagItems, get, getArray, getById, getSubList, getVector, hasMore, indexOf, modifyItem, modifyLocal, moveLocal, notifyCreate, remove, removeAllTags, set, setHasMore, size, tagItems
Methods borrowed from class ZmModel:
addChangeListener, removeAllChangeListeners, removeChangeListener
Class Detail
ZmApptList()
Create a new, empty appointment list.
Method Detail
getSubset(startTime, endTime)
Gets a new appointment list containing only appointment in the given range.
Author: the new list.
Parameters:
{Date} startTime
the start time
{Date} endTime
the end time

<static> {AjxVector} ZmApptList.mergeVectors(vecArray)
Merges all the sorted vectors in the specified array into a single sorted vector.
Parameters:
{AjxVector} vecArray
the array
Returns:
{AjxVector} the resulting array

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.

Parameters:
{Hash} params
a hash of parameters
{Array} params.items
a list of items to move
{ZmFolder} params.folder
the destination folder
{Hash} params.attrs
the additional attrs for SOAP command
{AjxCallback} params.callback
the callback to run after each sub-request
{closure} params.finalCallback
the callback to run after all items have been processed
{int} params.count
the starting count for number of items processed
{boolean} params.noUndo
true if the action is not undoable (e.g. performed as an undo)
{String} params.actionTextKey
key for optional text to display in the confirmation toast instead of the default summary. May be set explicitly to null to disable the confirmation toast entirely

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