Zimlet JavaScript API Reference - ZmAddrBook

Class ZmAddrBook


Extends ZmFolder.

This class represents an address book.

Defined in: ZmAddrBook.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmAddrBook(params)
Creates an address book.
Method Summary
Method Attributes Method Name and Description
 
Checks if the address book supports public access.
Methods borrowed from class ZmFolder:
createQuery, getIcon, getName, hasFeeds, hasSearch, isHardDelete, isInSpam, isOutbound, mayContain, move, notifyCreate, notifyModify, toggleSyncOffline
Methods borrowed from class ZmOrganizer:
addChangeListener, addShare, clearShares, deleteLocal, empty, getAccount, getById, getByName, getByPath, getByType, getChild, getChildByPath, getColor, getDataSources, getFolder, getIconWithColor, getMainShare, getOwner, getOwnerRestUrl, getPath, getRemoteId, getRestUrl, getSearchPath, getShares, getSyncUrl, getToolTip, getUrl, hasChild, hasPrivateAccess, hasUnreadDescendent, isAdmin, isChildOf, isColorChanged, isDataSource, isFeed, isInTrash, isPermAllowed, isReadOnly, isRemote, isSystem, isUnder, markAllRead, notifyDelete, removeChangeListener, rename, reparent, setColor, setGlobalMarkRead, setOfflineSyncInterval, setRetentionPolicy, setRGB, size, supportsPrivatePermission, supportsSharing, sync, update
Class Detail
ZmAddrBook(params)
Creates an address book.
Author: Parag Shah.
Parameters:
{Hash} params
a hash of parameters
{int} params.id
a numeric ID
{String} params.name
[string] the name
{ZmOrganizer} params.parent
the parent organizer
{ZmTree} params.tree
a tree model that contains this organizer
{int} params.color
the color of this address book
{String} params.owner
the owner of the address book (if shared)
{String} params.zid
the the share ID of a shared address book
{String} params.rid
the the remote folder id of a shared address book
{String} params.restUrl
the REST URL of this organizer
Method Detail
{Boolean} supportsPublicAccess()
Checks if the address book supports public access.
Returns:
{Boolean} always returns true

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