Zimlet JavaScript API Reference - ZmAccountOverviewContainer

Class ZmAccountOverviewContainer


Creates a header tree item for an account if mailbox has multiple accounts configured. For each account header, a ZmOverview is added a child. If mailbox only has one account configured, no account header is created and the ZmOverview is added as a child of the container.

Defined in: ZmAccountOverviewContainer.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates an overview container for a multi-account mailbox.
Method Summary
Method Attributes Method Name and Description
 
Adds a search folder.
 
Expands the given account only (collapses all other accounts).
 
initialize(params)
Initializes the account overview.
 
Returns a string representation of the object.
 
updateAccountInfo(account, updateStatus, updateTooltip)
Sets/updates the account-level status icon next to account name tree header.
 
updateLabel(organizer)
Updates the label.
 
updateTooltip(folderId)
Updates the tool tip.
Class Detail
ZmAccountOverviewContainer(params)
Creates an overview container for a multi-account mailbox.
Author: Parag Shah.
Parameters:
{Hash} params
a hash of parameters
Method Detail
addSearchFolder(folder)
Adds a search folder.
Parameters:
{ZmFolder} folder
the folder

expandAccountOnly(account)
Expands the given account only (collapses all other accounts).
Parameters:
{ZmAccount} account
the account to expand

initialize(params)
Initializes the account overview.
Parameters:
{Hash} params
a hash of parameters

{String} toString()
Returns a string representation of the object.
Returns:
{String} a string representation of the object

updateAccountInfo(account, updateStatus, updateTooltip)
Sets/updates the account-level status icon next to account name tree header. This only applies to app-based overview containers (i.e. not dialogs). Also resets the tooltip for the account header tree item.
Parameters:
{ZmZimbraAccount} account
the account to update status icon for
{Boolean} updateStatus
if true, update the status
{Boolean} updateTooltip
if true, update the tool tip

updateLabel(organizer)
Updates the label.
Parameters:
{ZmOrganizer} organizer
the organizer

updateTooltip(folderId)
Updates the tool tip.
Parameters:
{String} folderId
the folder id

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