Class ZmZimbraMail
Class Detail
ZmZimbraMail(params)
Creates a controller to run ZimbraMail. Do not call directly, instead use the run()
factory method.
Method Detail
activateApp(appName, force, callback, errorCallback, params)
Activates the given application.
addApp(app)
Adds the application.
{Boolean}
addAppListener(app, type, listener)
Adds a listener for the given event type and app.
<static>
ZmZimbraMail.addAppListener(appName, type, listener)
Static function to add an app listener before this class has been
instantiated. This is separate from ZmZimbraMail#addListener
so that the caller doesn't need to know the specifics of how we
twiddle the type name for app events.
{Boolean}
addListener(type, listener)
Adds a listener for the given event type.
<static>
ZmZimbraMail.addListener(type, listener)
Static function to add a listener before this class has been instantiated.
During construction, listeners are copied to the event manager. This function
could be used by a skin, for example.
addPostRenderCallback(callback, order, delay, runNow)
Sets up a callback to be run after the starting app has rendered, if we're doing
post-render callbacks. The callback is registered with an order that determines
when it will run relative to other callbacks. A delay can also be given, so that
the UI has a chance to do some work between callbacks.
appRendered(appName)
An app calls this once it has fully rendered, so that we may notify
any listeners.
cancelRequest(reqId, errorCallback, noBusyOverlay)
Cancels the request.
dismissStatusMsg(all)
Dismisses the displayed status message, if any
<static>
ZmZimbraMail.exitSession()
Logs user off when session has expired and user has choosen to stay on page when prompted
focusContentPane()
Focuses on the content pane.
focusToolbar()
Focuses on the toolbar.
{ZmApp}
getActiveApp()
Gets the active app.
{ZmApp}
getApp(appName)
Gets a handle to the given app.
{ZmAppChooser}
getAppChooser()
Gets the application chooser.
{ZmAppButton}
getAppChooserButton(id)
Gets the app chooser button.
{ZmAppViewMgr}
getAppViewMgr()
Gets a handle to the app view manager.
<static>
ZmZimbraMail.getConfirmExitMethod()
Return the confirmExitMethod that can be used for window.onbeforeunload
{ZmActionMenu}
getDropMenuOptions(parent, parentElement, adminUrl)
Adds a "help" submenu.
{ZmActionMenu}
getHelpButton(parent)
Adds a "help" submenu.
{Boolean}
getInstantNotify()
Gets the "instant notification" setting.
{DwtKeyMapMgr}
getKeyMapMgr()
Gets the key map manager.
{String}
getKeyMapName()
Gets the key map name.
{ZmApp}
getPreviousApp()
Gets the previous application.
handleKeyAction(actionCode, ev)
Handles the key action.
<static>
{int}
ZmZimbraMail.hashSortCompare(hash, a, b)
Returns sort order using a and b as keys into given hash.
<static>
ZmZimbraMail.hasSessionEnded()
Returns the state of ZCS application if user is logged out in case of browser quit.
The public method is added to take appropriate action in the chat app if user session is ending.
<static>
ZmZimbraMail.killSplash()
Hides the splash screen.
<static>
ZmZimbraMail.logOff(ev, relogin)
Logs off the application.
<static>
ZmZimbraMail.redir(locationStr)
Redirect.
{Boolean}
removeAppListener(app, type, listener)
Removes a listener for the given event type and app.
{Boolean}
removeListener(type, listener)
Removes a listener for the given event type.
<static>
ZmZimbraMail.run(params)
Sets up ZimbraMail, and then starts it by calling its constructor. It is assumed that the
CSFE is on the same host.
runAppFunction(funcName, force)
Runs the given function for all enabled apps, passing args.
sendClientEventNotify(event, isNetworkOn)
Sends a
<ClientEventNotifyRequest> to the server.
sendNoOp()
Sends a
<NoOpRequest> to the server. Used for '$set:noop'
<static>
ZmZimbraMail.sendRedirect(locationStr)
Sends a redirect.
sendRequest(params)
Sends the request.
setActiveApp(view)
Handles a change in which app is current. The change will be reflected in the
current app toolbar and the overview. The previous and newly current apps are
notified of the change. This method is called after a new view is pushed.
setActiveTabId(id)
Sets the active tab.
<static>
ZmZimbraMail.setExitTimer(startTimer)
If a user has been prompted and elects to stay on page, this timer automatically logs them off after an interval of time.
setInstantNotify(on)
Sets the client into "instant notifications" mode.
setNewButtonProps(params)
Set up the New button based on the current app.
{Boolean}
setPollInterval(kickMe)
Resets the interval between poll requests, based on what's in the settings,
only if we are not in instant notify mode.
setSessionTimer(bStartTimer)
Sets the session timer.
setStatusMsg(params, force, dismissCallback, finishCallback)
Displays a status message.
setUserInfo()
Sets the user info.
showMiniCalendar()
Shows the mini-calendar.
showReminder()
Shows reminders.
showTaskReminder()
Shows reminders.
startup(params, app, settings)
Startup the mail controller.
The following steps are performed:
<static>
ZmZimbraMail.unload()
Unloads the controller. Allows parent window to walk list of open child windows and either "delete"
or "disable" them.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:35 GMT-0400 (EDT)
|