Zimlet JavaScript API Reference - ZmBriefcaseApp

Class ZmBriefcaseApp


Extends ZmApp.

The briefcase application manages the creation and display of briefcase items.

Defined in: ZmBriefcaseApp.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmBriefcaseApp(container, parentController)
Creates and initializes the briefcase application.
Method Summary
Method Attributes Method Name and Description
<static>  
ZmBriefcaseApp.getDocWindowFeatures()
Gets the popup doc window features.
 
getLimit(offset)
Gets the limit for the search triggered by the application launch or an overview click.
 
newDoc(contentType, new, winName)
Creates a new document.
 
search(params)
Performs a search.
 
showSearchResults(results, callback, searchResultsController)
Shows the search results.
 
uploadSaveDocs(params, params, status, guids)
uploadSaveDocs performs SaveDocument calls, creating a document with an associated uploadId.
Methods borrowed from class ZmApp:
activate, addDeferredFolder, createView, deleteSessionController, disposeTreeControllers, getDisplayName, getInitialSearchType, 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
ZmBriefcaseApp(container, parentController)
Creates and initializes the briefcase application.
Author: Conrad Damon.
Parameters:
{DwtControl} container
the container
{ZmController} parentController
the parent controller
Method Detail
<static> {String} ZmBriefcaseApp.getDocWindowFeatures()
Gets the popup doc window features.
Returns:
{String} the window features

{int} getLimit(offset)
Gets the limit for the search triggered by the application launch or an overview click.
Parameters:
{Boolean} offset
if true app has offset
Returns:
{int} the limit

newDoc(contentType, new, winName)
Creates a new document.
Parameters:
{String} contentType
the content type
{String} new
the document name
{String} winName
the name of the popup doc window

search(params)
Performs a search.
Parameters:
{Hash} params
a hash of parameters
{String} params.folderId
the ID of briefcase folder to search in
{String} params.query Optional
the query to send (overrides folderId)
{AjxCallback} params.callback Optional
the callback
{String} params.accountName Optional
the account name
{Boolean} params.noRender Optional
if true, do not display results

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

uploadSaveDocs(params, params, status, guids)
uploadSaveDocs performs SaveDocument calls, creating a document with an associated uploadId. If the file already exists, conflict resolution is performed.
Parameters:
{object} params
params to customize the upload flow: uploadFolder Folder to save associated document into files: raw File object from the external HTML5 drag and drop notes: Notes associated with each of the files being added allResponses: All the server responses. Contains the uploadId (guid) for a file errorCallback: Run upon an error conflictAction If specified, the action used to resolve a file conflict preResolveConflictCallback: Standard processing (SaveDocument), Run prior to conflict resolution completeDocSaveCallback: Standard processing (SaveDocument), Run when all documents have been saved
params
status
guids

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