Zimlet JavaScript API Reference - ZmDataSourceCollection

Class ZmDataSourceCollection


Extends ZmModel.

This class represents a data source collection.

Defined in: ZmDataSourceCollection.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates the data source collection.
Method Summary
Method Attributes Method Name and Description
 
checkStatus(sourceMap, delayMs)
Periocially check status of the import
 
getByFolderId(folderId, type)
Gets a list of data sources associated with the given folder ID.
 
Gets the IMAP accounts.
 
Gets the IMAP accounts.
 
Gets the POP accounts.
 
Gets the POP accounts.
Methods borrowed from class ZmModel:
addChangeListener, removeAllChangeListeners, removeChangeListener
Class Detail
ZmDataSourceCollection()
Creates the data source collection.
Method Detail
checkStatus(sourceMap, delayMs)
Periocially check status of the import
Parameters:
{Object} sourceMap
map of accounts
{int} delayMs
delay time between checks

{Array} getByFolderId(folderId, type)
Gets a list of data sources associated with the given folder ID.
Parameters:
{String} folderId
[String] the folderId
{constant} type
the type of data source (see ZmAccount.TYPE_ constants)
Returns:
{Array} an array of items
See:
ZmAccount

{Array} getImapAccounts()
Gets the IMAP accounts.
Returns:
{Array} an array of ZmImapAccount objects

{Array} getImapAccountsFor(folderId)
Gets the IMAP accounts.
Parameters:
{String} folderId
the folder id
Returns:
{Array} an array of ZmImapAccount objects

{Array} getPopAccounts()
Gets the POP accounts.
Returns:
{Array} an array of ZmPopAccount objects

{Array} getPopAccountsFor(folderId)
Gets the POP accounts.
Parameters:
{String} folderId
the folder id
Returns:
{Array} an array of ZmPopAccount objects

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