Zimlet JavaScript API Reference - ZmZimletMgr

Class ZmZimletMgr


This class represents the Zimlet manager.

Defined in: ZmZimletMgr.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates the Zimlet manager.
Field Summary
Field Attributes Field Name and Description
<static>  
ZmZimletMgr.CORE_ZIMLETS
List of Core Zimlets.
<static>  
If the Zimlet's config_template has hasSensitiveData = true, it will be considered as sensitive Zimlet and such zimlets are disabled (by-default) in mixed-mode.
Method Summary
Method Attributes Method Name and Description
 
Changes the zimlet label.
 
Gets the content zimlets.
 
Gets the indexed zimlets.
 
Gets the panel zimlets.
 
Gets the portlet zimlets.
 
Gets the portlets hash.
 
Gets the zimlet.
 
Gets the zimlets.
 
Gets the zimlets hash.
 
Checks if the manager is loaded.
 
Returns a string representation of the object.
 
Checks if the zimlet exists.
Class Detail
ZmZimletMgr()
Creates the Zimlet manager.
Field Detail
<static> ZmZimletMgr.CORE_ZIMLETS
List of Core Zimlets. com_zimbra_apptsummary|com_zimbra_date|com_zimbra_dnd|com_zimbra_email|com_zimbra_linkedin|com_zimbra_phone|com_zimbra_webex|com_zimbra_social|com_zimbra_srchhighlighter|com_zimbra_url

<static> ZmZimletMgr.HAS_SENSITIVE_DATA_CONFIG_NAME
If the Zimlet's config_template has hasSensitiveData = true, it will be considered as sensitive Zimlet and such zimlets are disabled (by-default) in mixed-mode. System admin can set: mcf zimbraZimletDataSensitiveInMixedModeDisabled FALSE (instead of TRUE), to enable
Method Detail
changeZimletLabel(item)
Changes the zimlet label.
Parameters:
{Object} item
the item

{Array} getContentZimlets()
Gets the content zimlets.
Returns:
{Array} an array of objects

{Array} getIndexedZimlets()
Gets the indexed zimlets.
Returns:
{Array} an array of objects

{Array} getPanelZimlets()
Gets the panel zimlets.
Returns:
{Array} an array of objects

{Array} getPortletZimlets()
Gets the portlet zimlets.
Returns:
{Array} an array of objects

{Hash} getPortletZimletsHash()
Gets the portlets hash.
Returns:
{Hash} the portlets hash

{ZmZimletContext} getZimletByName(name)
Gets the zimlet.
Parameters:
{String} name
the name
Returns:
{ZmZimletContext} the zimlet or null if not found

{Array} getZimlets()
Gets the zimlets.
Returns:
{Array} an array of ZmZimletContext objects

{Hash} getZimletsHash()
Gets the zimlets hash.
Returns:
{Hash} as hash of zimlets

{Boolean} isLoaded()
Checks if the manager is loaded.
Returns:
{Boolean} true if loaded; false otherwise

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

{ZmZimletContext} zimletExists(name)
Checks if the zimlet exists.
Parameters:
{String} name
the name
Returns:
{ZmZimletContext} the zimlet or null if not found

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