Zimlet JavaScript API Reference - ZmTasksApp

Class ZmTasksApp


Extends ZmApp.

This class represents the task application.

Defined in: ZmTasksApp.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmTasksApp(container)
Creates the task application.
Method Summary
Method Attributes Method Name and Description
 
createNotify(creates, force)
Checks for the creation of a tasks folder or a mount point to one.
<static>  
ZmTasksApp.createpCompleteButton(parent, buttonId, buttonListener, menuSelectionListener)
Creates a new button with a reminder options as its menu.
 
Gets the list controller.
 
Gets the reminder controller.
 
getTaskController(sessionId)
Gets the controller.
 
getTaskFolderIds(localOnly)
Gets the list of checked calendar ids.
 
Gets the name of the calendar with specified id.
 
getTaskListController(sessionId, searchResultsController)
Gets the list controller.
 
Creates a task from a mail item.
 
search(folder, startDate, endDate, callback, accountName)
Performs a search.
 
showSearchResults(results, callback, searchResultsController)
Shows the search results.
Methods borrowed from class ZmApp:
activate, addDeferredFolder, createView, deleteSessionController, disposeTreeControllers, getDisplayName, getInitialSearchType, getLimit, getName, getNumSessionControllers, getOverview, getOverviewContainer, getOverviewId, getOverviewPanelContent, getRemoteFolderIds, getSearchParams, getSessionController, getTypeFromController, isActive, launch, popView, pushView, reset, resetOverview, resetWebClientOfflineOperations, setAppView, setOverviewPanelContent, setView, stageView, startAlert, stopAlert, toString
Class Detail
ZmTasksApp(container)
Creates the task application.
Parameters:
{DwtControl} container
the container
Method Detail
createNotify(creates, force)
Checks for the creation of a tasks folder or a mount point to one.
Parameters:
{Hash} creates
a hash of create notifications
{Boolean} force
if true, force the create

<static> ZmTasksApp.createpCompleteButton(parent, buttonId, buttonListener, menuSelectionListener)
Creates a new button with a reminder options as its menu.
Parameters:
{DwtComposite} parent
the parent
{String} buttonId
the button id to fetch inside DOM and append DwtButton to
{AjxListener} buttonListener
the listener to call when date button is pressed
{AjxListener} menuSelectionListener
the listener to call when date is selected in DwtCalendar

{ZmTaskListController} getListController()
Gets the list controller.
Returns:
{ZmTaskListController} the controller

{ZmReminderController} getReminderController()
Gets the reminder controller.
Returns:
{ZmReminderController} the controller

{ZmTaskController} getTaskController(sessionId)
Gets the controller.
Parameters:
sessionId
Returns:
{ZmTaskController} the controller

{Array} getTaskFolderIds(localOnly)
Gets the list of checked calendar ids. If calendar packages are not loaded, gets the list from deferred folder ids.
Parameters:
{Boolean} localOnly
if true, use local calendar only
Returns:
{Array} an array of ids

{String} getTaskFolderName(id)
Gets the name of the calendar with specified id.
Parameters:
{String} id
the id of the task
Returns:
{String} the name

{ZmTaskListController} getTaskListController(sessionId, searchResultsController)
Gets the list controller.
Parameters:
sessionId
searchResultsController
Returns:
{ZmTaskListController} the controller

newTaskFromMailItem(msg, date)
Creates a task from a mail item.
Parameters:
{ZmMailMsg} msg
the message
{Date} date
the date

search(folder, startDate, endDate, callback, accountName)
Performs a search.
Parameters:
{ZmFolder} folder
the folder
{Date} startDate
the start date
{Date} endDate
the end date
{AjxCallback} callback
the callback
{String} accountName
the account name

showSearchResults(results, callback, searchResultsController)
Shows the search results.
Parameters:
{Hash} results
the search results
{AjxCallback} callback
the callback
searchResultsController

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