Zimlet JavaScript API Reference - ZmResourceList

Class ZmResourceList


Extends ZmContactList.

This class represents a list of calendar resources. A calendar resource can be a location or a piece of equipment. All calendar resource records are stored in the GAL.

Defined in: ZmResourceList.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmResourceList(resType, search)
Create a new, empty calendar resources list.
Method Summary
Method Attributes Method Name and Description
 
Gets the resource with the given address, if any.
 
Gets the resource with the given name, if any.
 
load(batchCmd)
Loads the list.
 
Searches the calendar resources.
Methods borrowed from class ZmContactList:
createLocal, deleteItems, deleteLocal, getById, getContactByEmail, getContactByPhone, getIdHash, getSubList, moveItems, moveLocal, setIsGal
Methods borrowed from class ZmList:
add, addFromDom, cache, clear, copyItems, create, flagItems, get, getArray, getVector, hasMore, indexOf, modifyItem, modifyLocal, notifyCreate, remove, removeAllTags, set, setHasMore, size, tagItems
Methods borrowed from class ZmModel:
addChangeListener, removeAllChangeListeners, removeChangeListener
Class Detail
ZmResourceList(resType, search)
Create a new, empty calendar resources list.
Author: Conrad Damon.
Parameters:
{constant} resType
the type of resources (location or equipment)
{ZmSearch} search
the search that generated this list
See:
ZmCalBaseItem
Method Detail
{ZmResource} getResourceByEmail(address)
Gets the resource with the given address, if any. Canonical list only.
Parameters:
{String} address
an email address
Returns:
{ZmResource} the resource or null if not found

{ZmResource} getResourceByName(name)
Gets the resource with the given name, if any. Canonical list only. Since names aren't guaranteed to be unique, this returns the last resource with the given name.
Parameters:
{String} name
the resource name
Returns:
{ZmResource} the resource or null if not found

load(batchCmd)
Loads the list.
Parameters:
{ZmBatchCommand} batchCmd
the batch command

searchCalResources(params)
Searches the calendar resources.
Parameters:
{Hash} params
a hash of parameters

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