Class ecm.model.MySyncedFilesResultSet
Extends
ecm.model._ModelObject.
This class represents a set of sync item results. The most efficient method to iterate through the results
is to use getStore and use dijits that support dojo.data stores.
Defined in: <ecm\model\MySyncedFilesResultSet.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
ecm.model.MySyncedFilesResultSet(properties)
Constructor
|
- Fields borrowed from class ecm.model._ModelObject:
- categorization, id, isRecurring, name, nameFilter, pane, status, type, userId
Method Summary
Method Attributes | Method Name and Description |
---|---|
getActionsMenuItemsType(items, loadBaseMenu)
Return the context menu type for the list of items
|
|
getItems(handler)
Returns an array of ecm.model.SyncItem objects for all hits in the result set.
|
|
Return the default toolbar name.
|
|
loadContextMenu(items, callback, loadBaseMenu)
Load the context menu actions for the set of items
|
|
loadToolbar(callback)
Load the default my synced files toolbar.
|
|
<static> |
ecm.model.MySyncedFilesResultSet.MySyncedFilesResultSet.registerFactory(factory)
Static function that registers a factory for sub-classes of
MySyncedFilesResultSet . |
refresh()
Refreshes the my synced files view.
|
|
reload()
Clears the sync items cache and reloads sync items from the server.
|
- Methods borrowed from class ecm.model._ModelObject:
- destroy, getSortCriteria, onChange, own, toString
Constructor Detail
ecm.model.MySyncedFilesResultSet(properties)
Constructor
- Parameters:
- properties
- The properties for the model object. The properties can be any of the public fields as defined below and on ecm.model._ModelObject.
- Since:
- 2.0.3.5
Method Detail
getActionsMenuItemsType(items, loadBaseMenu)
Return the context menu type for the list of items
- Parameters:
- items
- A array of sync items
- loadBaseMenu
- Boolean indicating whether to load just the base sync item actions. If false, item-specific context menus will be loaded.
getItems(handler)
Returns an array of ecm.model.SyncItem objects for all hits in the result set.
- Parameters:
- handler
- Function.
- Returns:
- Array of ecm.model.SyncItem objects.
getToolbarDef()
Return the default toolbar name.
loadContextMenu(items, callback, loadBaseMenu)
Load the context menu actions for the set of items
- Parameters:
- items
- An array of sync items.
- callback
- A function called when the context menu items have been loaded.
- loadBaseMenu
- Set this flag to true to load only the base sync item menu. This is used when we fail to authenticate with the repository containing the sync item or cannot retrieve the item associated with the sync item.
loadToolbar(callback)
Load the default my synced files toolbar.
- Parameters:
- callback
- A function called when the toolbar actions have been loaded.
<static> ecm.model.MySyncedFilesResultSet.MySyncedFilesResultSet.registerFactory(factory)
Static function that registers a factory for sub-classes of
MySyncedFilesResultSet
.
- Parameters:
- factory
- A factory object with
createFromJSON
method to possibly create a sub-class ofMySyncedFilesResultSet
. The factory method should return null when the given item is not one for known sub-classes, giving chances for other factories to create one or falling back to the defaultMySyncedFilesResultSet
construction.
refresh()
Refreshes the my synced files view.
reload()
Clears the sync items cache and reloads sync items from the server.