Zimlet JavaScript API Reference - ZmConvController

Class ZmConvController


Extends ZmConvListController.

This class manages the two-pane conversation view. The top pane contains a list view of the messages in the conversation, and the bottom pane contains the current message.

Defined in: ZmConvController.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmConvController(container, mailApp, type, sessionId)
Creates a new, empty conversation controller.
Method Summary
Method Attributes Method Name and Description
 
getMsg(params)
Gets the selected message.
 
show(conv, parentController, callback, markRead, msg)
Displays the given conversation in a two-pane view.
Methods borrowed from class ZmConvListController:
popShield, switchView
Methods borrowed from class ZmDoublePaneController:
getCurrentView, getItemView, reset
Methods borrowed from class ZmMailListController:
isReadingPaneOn, isReadingPaneOnRight, sendReadReceipt
Methods borrowed from class ZmListController:
getCurrentSearchResults, getItemCount, getItems, getList, getListView, getSearchString, getSearchStringHint, getTabGroup, handleKeyAction, isDraftsFolder, isOutboxFolder, isSyncFailuresFolder, setHasMore, setList
Methods borrowed from class ZmBaseController:
getCurrentToolbar, isCurrent, setSessionId
Methods borrowed from class ZmController:
getApp, getCurrentViewId, getCurrentViewType, getKeyMapName, getNewFolderCallback, getSessionId, getViewElements, isTransient, mapSupported, popupErrorDialog, popupUploadErrorDialog, setCurrentViewId, setCurrentViewType
Class Detail
ZmConvController(container, mailApp, type, sessionId)
Creates a new, empty conversation controller.
Author: Conrad Damon.
Parameters:
{DwtControl} container
the containing shell
{ZmApp} mailApp
the containing application
{constant} type
type of controller
{string} sessionId
the session id
Method Detail
{ZmMailMsg} getMsg(params)
Gets the selected message.
Parameters:
{Hash} params
a hash of parameters
Returns:
{ZmMailMsg} the selected message

show(conv, parentController, callback, markRead, msg)
Displays the given conversation in a two-pane view.
Parameters:
{ZmConv} conv
a conversation
{ZmListController} parentController
the controller that called this method
{AjxCallback} callback
the client callback
{Boolean} markRead
if true, mark msg read
{ZmMailMsg} msg
msg that launched this conv view (via "Show Conversation")

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