Zimlet JavaScript API Reference - ZmImportExportController

Class ZmImportExportController


Extends ZmController.

This class represents an import/export controller.

Defined in: ZmImportExportController.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates an import/export controller.
Field Summary
Field Attributes Field Name and Description
<static>  
ZmImportExportController.SUBTYPE_DEFAULT
Defines the sub-type default array
<static>  
ZmImportExportController.TYPE_CSV
Defines the "CSV" type.
<static>  
ZmImportExportController.TYPE_DEFAULT
Defines the default type.
<static>  
ZmImportExportController.TYPE_ICS
Defines the "ICS" type.
<static>  
ZmImportExportController.TYPE_TGZ
Defines the "TGZ" type.
Method Summary
Method Attributes Method Name and Description
 
exportData(params, callback, errorCallback)
Exports user data as specified in the params object.
 
importData(params, callback, errorCallback)
Imports user data as specified in the params object.
 
Returns a string representation of the object.
Methods borrowed from class ZmController:
getApp, getCurrentViewId, getCurrentViewType, getKeyMapName, getNewFolderCallback, getSessionId, getTabGroup, getViewElements, handleKeyAction, isTransient, mapSupported, popupErrorDialog, popupUploadErrorDialog, setCurrentViewId, setCurrentViewType, setSessionId
Class Detail
ZmImportExportController()
Creates an import/export controller.
Field Detail
<static> ZmImportExportController.SUBTYPE_DEFAULT
Defines the sub-type default array

<static> ZmImportExportController.TYPE_CSV
Defines the "CSV" type.

<static> ZmImportExportController.TYPE_DEFAULT
Defines the default type.
See:
ZmImportExportController.TYPE_TGZ

<static> ZmImportExportController.TYPE_ICS
Defines the "ICS" type.

<static> ZmImportExportController.TYPE_TGZ
Defines the "TGZ" type.
Method Detail
{Boolean} exportData(params, callback, errorCallback)
Exports user data as specified in the params object.
Parameters:
{Hash} params
a hash of parameters
{String} params.folderId
the folder id for export. If not specified, all folders want to be exported.
{String} params.type
the type (defaults to TYPE_TGZ)
{String} params.subType
the sub-type (defaults to SUBTYPE_DEFAULT[type])
{String} params.views
a comma-separated list of views
{String} params.filename
the filename for exported file
{String} params.searchFilter
the search filter
{Boolean} params.skipMeta
if true, skip export of meta-data
{AjxCallback} callback
the callback for success
{AjxCallback} errorCallback
the callback for errors
Returns:
{Boolean} true if the export is successful

{Boolean} importData(params, callback, errorCallback)
Imports user data as specified in the params object.
Parameters:
{Hash} params
a hash of parameters
{Element} params.form
the form containing file input field
{String} params.folderId
the folder id for import. If not specified, assumes import to root folder.
{String} params.type
the type (defaults to TYPE_TGZ)
{String} params.subType
the sub-type (defaults to SUBTYPE_DEFAULT[type])
{String} params.resolve
resolve duplicates: "" (ignore), "modify", "replace", "reset" (defaults to ignore).
{String} params.views
a comma-separated list of views
{AjxCallback} callback
the callback for success
{AjxCallback} errorCallback
the callback for errors
Returns:
{Boolean} true if the import is successful

{String} toString()
Returns a string representation of the object.
Returns:
{String} a string representation of the object

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