Class ZmApp
Class Detail
ZmApp(name, container, parentController)
Creates the application.
Field Detail
<static>
ZmApp.BRIEFCASE
Defines the "briefcase" application.
Defined in: ZmBriefcaseApp.js. <static>
ZmApp.CALENDAR
Defines the "calendar" application.
Defined in: ZmCalendarApp.js. <static>
ZmApp.CONTACTS
Defines the "address book" application.
Defined in: ZmContactsApp.js. <static>
ZmApp.MAIL
Defines the "mail" application.
Defined in: ZmMailApp.js. <static>
ZmApp.PORTAL
Defines the "portal" application.
Defined in: ZmPortalApp.js. <static>
ZmApp.PREFERENCES
Defines the "preferences" application.
Defined in: ZmPreferencesApp.js.
Method Detail
activate(active, viewId)
Activates the application.
addDeferredFolder(params)
Adds a deferred folder.
createView(params)
Creates the application view.
deleteSessionController(params, controllerClass, sessionId, searchResultsController)
Deletes a controller of the given type, class, and sessionId.
disposeTreeControllers()
Disposes of the tree controllers (right now mainly gets rid of change listeners.
{String}
getDisplayName()
Gets the application display name.
{Object}
getInitialSearchType()
Gets the initial search type.
{int}
getLimit(offset)
Gets the limit for the search triggered by the application launch or an overview click.
{String}
getName()
Gets the application name.
{number}
getNumSessionControllers(type)
Gets the number of active session controllers
{ZmOverview}
getOverview()
Gets the current overview, if any. Subclasses should ensure that a ZmOverview is returned.
{ZmOverview}
getOverviewContainer(dontCreate)
Gets the overview container.
{String}
getOverviewId(account)
Gets the overview id of the current ZmOverview, if any.
{String}
getOverviewPanelContent()
Creates the overview content for this app. The default implementation creates
a ZmOverview with standard options. Other apps may want to use different
options, or create a DwtComposite instead.
{Array}
getRemoteFolderIds(account)
Gets the remote folder ids.
getSearchParams(params)
Gets the search parameters.
getSessionController(params, controllerClass, sessionId, searchResultsController)
Returns a controller of the given type and class. If no sessionId is provided, then
the controller's session ID will be an incremental number. If a sessionId is given,
then a check is made for an existing controller with that session ID. If none is
found, one is created and given that session ID.
{string}
getTypeFromController(params, controllerClass, sessionId, searchResultsController)
Evaluates the controller class and returns the default view type from that controller.
{Boolean}
isActive()
Checks if the application is active.
launch(params, callback)
Launches the application.
popView(force, viewId, skipHistory)
Pops the application view.
pushView(name, force)
Pushes the application view.
{Boolean}
reset(active)
Resets the application state.
resetOverview(overviewId)
Resets the current overview, preserving expansion.
resetWebClientOfflineOperations()
Handle the common aspects of a transition from online to offline and offline to online, and also do so
when an app is activated
<static>
ZmApp.runAppFunction(funcName, mixed)
Runs the given function for all known (e.g. part of ZmApp.CLASS)
app classes, passing args.
NOTE: This runs class functions only, not instance (prototype) functions.
setAppView(view)
Sets the application view.
setOverviewPanelContent(reset)
Sets the overview tree to display overview content for this application.
setView(name, force)
Sets the application view.
stageView(name)
Stages the application view.
startAlert()
Starts an alert on the application tab.
stopAlert()
Stops an alert on the application tab.
{String}
toString()
Returns a string representation of the object.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:34 GMT-0400 (EDT)
|