Class ecm.model.Desktop

Extends ecm.model._ModelObject.
Represents the current desktop. This class provides information on about the servers and layout that are configured for the desktop. The class also provides a list of the messages that have been displayed to the user.

The Desktop class provides access to the single desktop object that is available for a page. Even though a Desktop object is created initially, the desktop configuration is not loaded until an explicit call is made to the loadDesktop method.
Defined in: <ecm\model\Desktop.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.model.Desktop(properties) Constructs the desktop.

Field Summary

Field Attributes	Field Name and Description
	actionLists An array of ecm.model.Action objects holding the desktop actions.
	actionsHandler A ecm.widget.layout.CommonActionsHandler object to handle desktop actions.
	addDocFoldersToRepo Mobile settings to allow Mobile application to add documents and create folders to the repository.
	addPhotoFromMobile Mobile settings to allow Mobile application to add photos from the camera and photo library.
	adminFeature A ecm.model.Feature object for the admin features.
	applicationName A string holding the application name.
	appServerOs An object holding the application server operating system information.
	authenticationType Authentication mechanism used to authenticate the user when they log in to the desktop.
	bannerApplicationNameColor A string value holding the color to use for the application name in the banner.
	bannerBackgroundColor A string value holding the banner's background color.
	bannerLogoUrl A URL string to the logo displayed in the banner area.
	bannerMenuColor A string value holding the color to use for the menu in the banner.
	bookmarkLayout A string value holding the desktop bookmark layout class.
	bookmarkLayoutWidget A single instance of the bookmark layout widget to use for the desktop.
	configuredLabels A ecm.model.ConfiguredLabels object.
	connected A boolean value indicating this desktop is logged in.
	container A ecm.model.Container object for the desktop container object.
	culturalCollation A boolean value setting for cultural collation.
	defaultFeature A ecm.model.Feature object for the first feature to be displayed in the layout.
	defaultLayoutRepositories An object containing the repository id's for the default repositories defined for the various features in the layout.
	defaultRepositoryId Default repository id that is defined for this desktop.
	desktopLoaded A boolean value indicating whether this desktop has been loaded or not.
	dirtyMessage An instance of ecm.model.Message for a message that will be displayed on the logout dialog as a warning.
	disableAutocomplete A boolean value indicating whether browser autocomplete feature should be disabled.
	disableCookies A boolean value indicating whether browser "cookies" are disabled.
	documentId A string value holding a document identifier.
	emailLink A string value holding email link.
	emailServiceEnabled A boolean value indicating if the email service is enabled.
	enableThumbnails A boolean value indicating if thumbnail generation should be enabled for this desktop and false if it should not.
	encryptionKey Configured encryption key that is set in the settings configuration.
	favorites A array of ecm.model.Favorite objects for this desktop.
	features An array of ecm.model.Feature objects set for the desktop.
	fileIntoFolder A boolean value indicating if new documents must be filed in a folder.
	fileTypes An array of ecm.model.admin.FileTypeConfig objects that hold the file type information of this desktop.
	fromEmailModifiable A boolean value indicating if the From email address can be modified by the user on the email dialog.
	hasBoxRepositories Flag indicating whether or not this desktop contains Box repositories.
	helpContext A string value holding the help URL context.
	helpSettingsUrl A string value holding the IBM help URL from Settings.
	helpTaxonomy A string value holding the help taxonomy.
	helpUrl A string value holding the help URL.
	helpWelcomeFile A string value holding the help welcome file.
	hideEntryTemplateNotFoundWarning A boolean value indicating if the entry template not found warning should be hidden when item properties are edited.
	layout A string value holding the desktop layout class.
	layoutDijit A single instance of the layout dijit to use for the desktop.
	linkedBoxRepositories A list of Box repositories that are associated with the logged in Desktop user.
	loginInformationUrl A URL string to a page providing additional login information.
	loginLogoUrl A URL string to the logo displayed on the login panel.
	maxConversionSize Maximum size (in MB) of content sent to the server for conversion routines.
	maxNumberDocToAdd An int value holding the maximum number of documents that can be added with the multi-select add document action.
	maxNumberDocToModify An int value holding the maximum number of items that can be modified at one time.
	messages An array of ecm.model.Message objects retrieved for this desktop.
	messageSearchUrl A base URL string to use for searching for messages.
	mobileAppAccess Mobile settings of allowing Mobile application user to access this desktop.
	mobileFeatures An object holding the mobile features.
	navigatorBuild A string value holding the IBM Content Navigator build number.
	navigatorRelease A string value holding the IBM Content Navigator release information.
	navigatorVersionNumber An int value holding the IBM Content Navigator version number.
	onRequestTimeout The timeout handler to use for all requests to the midtier.
	openActions
	openDocFromOtherApp Mobile settings to allow Mobile application to open documents in other applications.
	passwordRulesUrl A URL string to a page providing rules for password specification.
	pluginSettings An object that contains settings assigned by custom plug-ins.
	preventCreateNewSearch A boolean value indicating if the users can create an ad hoc search.
	preventCreateNewUnifiedSearch A boolean value indicating if the users can create a cross-repository search.
	repositories An array of ecm.model.Repository objects for this desktop.
	repositoryId A string value holding a repository identifier.
	requestTimeout The timeout time to use for all requests to the midtier, in milliseconds.
	servicesUrl The URL to use for access to the IBM Content Navigator services.
	shareEnabled A boolean indicating if share is enabled.
	shareMyEmailModifiable Boolean indicating if the my email can be modified by the user on the share dialog.
	shareRepositoryId The share repository id.
	showGlobalToolbar A boolean value indicating if the global toolbar should be shown in the layout or not.
	showSecurity A boolean value indicating if security should be displayed for documents and folders.
	showSecurityInheritanceUI A boolean value indicating if security inheritance UI should be displayed for folders.
	showStatusbar A boolean value that controls whether the status bar should be enabled.
	showViewFilmstrip A boolean value indicating if filmstrip view should be enabled for this desktop and false if it should not.
	syncServer An instance of ecm.model.SyncServer used perform desktop, web and mobile sync.
	taskManager An instance of ecm.model.TaskManager used perform task manager related services.
	templateName A string value holding a template name.
	theme A string value indicating the theme that is used for the desktop.
	userActionMacros An array of ecm.model.admin.UserActionMacroConfig objects holding the macros for this desktop.
	userDisplayName The full, display user name for the user logged into the desktop.
	userId The user Id for the user logged into the desktop.
	userLoginName The login name used to login to the desktop.
	useSiteLoginPage A boolean value indicating if a site login page should be used instead of the login dialog when desktop authentication is required.
	valueFormatter An instance of ecm.model.ValueFormatter used to format values for display.
	viewerMappings An array of ecm.model.ViewerMapping objects defined for this desktop.
	viewers An array of ecm.model.Viewer objects defined for this desktop.
	viewersCache An array of ecm.model.Viewer objects held in the desktop cache.

Fields borrowed from class ecm.model._ModelObject:: categorization, id, isRecurring, name, nameFilter, pane, status, type

Method Summary

Method Attributes	Method Name and Description
	addFavorite(favorite, callback) Adds a new favorite to the favorites list.
	addFeature(feature) Adds a new ecm.model.Feature to the desktop.
	addMessage(message) Adds a message to the list of messages maintained in the desktop.
	clearFavorites() Clear favorites cache.
	clearMessages() Clears the messages list.
	clearSyncItems() Clear sync items cache.
	copyDesktop(desktop) This is added to prevent pop-up windows from having to reload another copy of the desktop singleton when they initially start up.
	createAdminFeature(repositoryJSON) Creates a new admin feature from JSON.
	createRepository(repositoryJSON) Creates a new repository object.
	getActionsHandler(callback) Returns the actions handler object.
	getBookmarkLayout(callback, args) Returns a single instance of the bookmark layout widget to use for the desktop.
	getConfiguredLabels(callback) Return the configured labels for the desktop.
	getConfiguredLabelsvalue(key) Return the configured label value.
	getCustomLabel(name) Return customizable label.
	getFeature(feature) Returns a feature from the desktop.
	getFeatureById(featureId) Returns a feature from the desktop.
	getHelpContext() Returns the context for help pages.
	getHelpUrl(forPage) Returns the base URL to use for help pages.
	getLayout(callback) Returns a single instance of the layout widget to use for the desktop.
	getLoadedViewerClass(viewer)
	getMessageSearchUrl() Returns a base URL to use for searching for messages.
	getPreviewersForItem(item, explicitMatchRequired, callback, contextRequire) Returns an array of ecm.model.Viewer objects for the viewer to use to preview the provided item.
	getRepository(repositoryId) Returns an instance of ecm.model.Repository for the given repository identifier.
	getRepositoryByName(name, domainId) Returns an instance of ecm.model.Repository for the given server name.
	getRepositoryOfObjectStore(objectStoreName, domainId) Returns an instance of ecm.model.Repository for the given FileNet P8 object store name.
	getRepositoryTypes() Retrieves an array of all the repository types contained in this desktop.
	getRequestParam(name) Retrieves the specified request parameter from the invocation URL.
	getServicesUrl() Returns the URL that is being used to access the IBM Content Navigator services.
	getViewer(viewerId) Returns an instance of ecm.model.Viewer for the specified viewer identifier.
	getViewerForItem(item, explicitMatchRequired) Returns the appropriate instance of ecm.model.Viewer for the viewer to use to view the provided item.
	getViewersForItem(item, explicitMatchRequired, callback, contextRequire) Returns an array of ecm.model.Viewer objects for the viewer to use to view the provided item.
	isContainerLoggedIn() Returns a boolean true value if the container is logged in.
	isLoggedIn() Returns true if the initial repository is connected.
	isPluginLoaded(pluginId) Return boolean true if the specified plugin is loaded
	isReloading() Returns a boolean true value if the desktop is reloading.
	loadDesktop(desktopId, callback, synchronous, useLastCache) Loads the desktop.
	loadFavorites(callback) Loads an array of ecm.model.Favorite objects for the current user within this desktop.
	loadMenuActions(actionListSuffix, callback, errorback) Returns the action list for a particular suffix.
	loadSyncItems(callback) Loads an array of ecm.model.SyncItem objects for the current user within this desktop.
	loadViewerClasses(loadedCallback, viewerClasses, contextRequire) Loads the specified viewer classes using AMD require, unless they've been loaded already.
	logoff() Disconnects from the server.
	logOffRepositories(response) Log off the desktop repositories.
	logon(password, callback, reqParams, reqHeaders) Connects to the server and authenticates with the provided password.
	onBeforeClose(events) An event function that is called prior to logout of the initial repository or close of the browser window.
	onChangeUploadProgress(evt) An event function that is called when upload progress is changed.
	onCompleteUploadProgress(evt) An event function that is called when upload progress is completed.
	onDesktopLoaded(response) An event function invoked when the desktop has been loaded.
	onDisplayBatchStatusDialog() An event function that is called when the batch status dialog is displayed.
	onDisplayStatusDialog(statusDialog) An event function that is called when the status dialog is displayed.
	onFavoriteAdded(favorite) Event function called when a favorite is added.
	onFavoritesRemoved(favoritesRemoved) Event function that is called when a favorite is removed.
	onFavoriteUpdated(favorite) Event function that is called when a favorite is updated.
	onHideBatchStatusDialog() An event function that is called when the batch status dialog is hidden.
	onHideStatusDialog(statusDialog) An event function that is called when the status dialog is hidden.
	onLogin(repository) This event is triggered when the initial repository is connected.
	onLogout(repository) This event is triggered when the initial repository is disconnected.
	onMessageAdded(message) This event function is called when a user-displayed message is to be shown or added to the messages area.
	onMessagesChanged() This event function is called when a message is added or the messages are cleared.
	onPluginCSSLoaded() This event is fired after all CSS loads complete for plug-in provided CSS.
	onRequestCompleted(request) This event function is called when a request to the services completed (either successfully or unsuccessfully).
	onRequestStarted(request) This event function is called when a request to the services is about to be launched.
	onSessionExpired(request, error) This event is triggered when a session expiration is detected.
	onSyncItemUpdated(syncItem) Event function that is called when a sync item is updated.
	onTeamspacesListChanged() An event function called when the list of teamspaces has changed.
	onTeamspacesValueChanged(id, teamspaceStringValue) An event function that is called when teamspaces has been turn on or off from Admin for a repository.
	refresh() Refreshes all repositories in this desktop.
	refreshActionsList()
	reloadDesktop(logoutUrl) This function reloads the desktop URL.
	removeFavorites(favorites, callback) Removes the specified favorites from the list.
	removeFeature(feature) Removes a feature from the desktop.
	setActionsHandler(actionsHandler) Sets the actions handler object.
	setServicesUrl(url) Sets the URL to use for access to the Content Navigator services.
	updateFavorite(favorite, callback) Updates a favorite in the favorites list.
	updateSyncItem(favorite, callback) Updates a sync item in the sync item list.

Methods borrowed from class ecm.model._ModelObject:: destroy, onChange, own, toString

Constructor Detail

ecm.model.Desktop(properties)

Constructs the desktop. Note that a desktop has already been constructed and resides in the global variable ecm.model.desktop, so it is not normally necessary to construct the desktop object. However, the desktop needs to be loaded. To load the desktop object, invoke ecm.model.desktop.loadDesktop. Many of the fields will be null until the desktop has been loaded.

Parameters:
properties: The properties of the desktop. Can be any of the public fields as defined below and on ecm.model._ModelObject.

Field Detail

actionLists

An array of ecm.model.Action objects holding the desktop actions.

actionsHandler

A ecm.widget.layout.CommonActionsHandler object to handle desktop actions.

addDocFoldersToRepo

Mobile settings to allow Mobile application to add documents and create folders to the repository.

addPhotoFromMobile

Mobile settings to allow Mobile application to add photos from the camera and photo library.

adminFeature

A ecm.model.Feature object for the admin features.

applicationName

A string holding the application name.

appServerOs

An object holding the application server operating system information.

authenticationType

Authentication mechanism used to authenticate the user when they log in to the desktop. Supported mechanisms include:

1 - Authentication is handled via the web application container (e.g. IBM WebSphere Application Server).
2 - Authentication is handled by an ECM repository (e.g. IBM FileNet Content Manager).

bannerApplicationNameColor

A string value holding the color to use for the application name in the banner.

bannerBackgroundColor

A string value holding the banner's background color.

bannerLogoUrl

A URL string to the logo displayed in the banner area.

bannerMenuColor

A string value holding the color to use for the menu in the banner.

bookmarkLayout

A string value holding the desktop bookmark layout class.

Since:: 2.0.3

bookmarkLayoutWidget

A single instance of the bookmark layout widget to use for the desktop. See ecm.widget.layout.BookmarkLayout for more information on a bookmark layout.

Since:: 2.0.3

configuredLabels

A ecm.model.ConfiguredLabels object.

connected

A boolean value indicating this desktop is logged in.

Since:: 2.0.2

container

A ecm.model.Container object for the desktop container object.

culturalCollation

A boolean value setting for cultural collation. If true, string sorting should be done on the server.

defaultFeature

A ecm.model.Feature object for the first feature to be displayed in the layout.

defaultLayoutRepositories

An object containing the repository id's for the default repositories defined for the various features in the layout. For the NavigatorMainLayout there are three fields in the object whose values define the three default repositories for the layout:

work - the default repository for workflow
teamspaces - the default repository for teamspaces
others - the default repository for browse, search and other features.

defaultRepositoryId

Default repository id that is defined for this desktop. This will only be defined if the desktop is defined to use repository authentication.

Since:: 2.0.2

desktopLoaded

A boolean value indicating whether this desktop has been loaded or not.

dirtyMessage

An instance of ecm.model.Message for a message that will be displayed on the logout dialog as a warning.

disableAutocomplete

A boolean value indicating whether browser autocomplete feature should be disabled.

disableCookies

A boolean value indicating whether browser "cookies" are disabled.

documentId

A string value holding a document identifier.

emailLink

A string value holding email link. It is set by the layouts to record the parameters passed in on the invocation for launching a view on a particular document. These parameters are normally those pasted into email using the email as link action.

emailServiceEnabled

A boolean value indicating if the email service is enabled. If disabled, e-mails are sent using the Email Applet.

Since:: 2.0.3.8

enableThumbnails

A boolean value indicating if thumbnail generation should be enabled for this desktop and false if it should not.

encryptionKey

Configured encryption key that is set in the settings configuration.

Since:: 2.0.3

favorites

A array of ecm.model.Favorite objects for this desktop.

features

An array of ecm.model.Feature objects set for the desktop.

fileIntoFolder

A boolean value indicating if new documents must be filed in a folder.

fileTypes

An array of ecm.model.admin.FileTypeConfig objects that hold the file type information of this desktop.

fromEmailModifiable

A boolean value indicating if the From email address can be modified by the user on the email dialog.

Since:: 2.0.3.8

hasBoxRepositories

Flag indicating whether or not this desktop contains Box repositories.

Since:: 2.0.3.5

helpContext

A string value holding the help URL context.

helpSettingsUrl

A string value holding the IBM help URL from Settings. This URL is for IBM KCCI url syntax.

Since:: 2.0.3

helpTaxonomy

A string value holding the help taxonomy. This is used to construct the KCCI help url.

Since:: 2.0.3

helpUrl

A string value holding the help URL. This help url is specified in desktop. This has the original / wcdocs url syntax.

helpWelcomeFile

A string value holding the help welcome file. This is used to construct the KCCI help url.

Since:: 2.0.3

hideEntryTemplateNotFoundWarning

A boolean value indicating if the entry template not found warning should be hidden when item properties are edited.

Since:: 2.0.3.5

layout

A string value holding the desktop layout class.

layoutDijit

A single instance of the layout dijit to use for the desktop. See ecm.widget.layout.BaseLayout for more information on layout dijits.

linkedBoxRepositories

A list of Box repositories that are associated with the logged in Desktop user.

Since:: 2.0.3.5

loginInformationUrl

A URL string to a page providing additional login information.

loginLogoUrl

A URL string to the logo displayed on the login panel.

maxConversionSize

Maximum size (in MB) of content sent to the server for conversion routines.

Since:: 2.0.3

maxNumberDocToAdd

An int value holding the maximum number of documents that can be added with the multi-select add document action.

maxNumberDocToModify

An int value holding the maximum number of items that can be modified at one time.

messages

An array of ecm.model.Message objects retrieved for this desktop.

messageSearchUrl

A base URL string to use for searching for messages.

mobileAppAccess

Mobile settings of allowing Mobile application user to access this desktop.

mobileFeatures

An object holding the mobile features.

navigatorBuild

A string value holding the IBM Content Navigator build number.

navigatorRelease

A string value holding the IBM Content Navigator release information.

navigatorVersionNumber

An int value holding the IBM Content Navigator version number. This version number will be incremented on every major release and can be used by plugin writers to detect and target new features in each release.

Since:: 2.0.3

onRequestTimeout

The timeout handler to use for all requests to the midtier. This is undefined by default.

openActions

Since:: 2.0.2 A two-level map containing all of the open actions available for this Desktop.

openDocFromOtherApp

Mobile settings to allow Mobile application to open documents in other applications.

passwordRulesUrl

A URL string to a page providing rules for password specification.

pluginSettings

An object that contains settings assigned by custom plug-ins. The settings object for a plug-in should be assigned to the property named using the plug-in Id.
Example JSON: "pluginSettings": { "ExamplePlugin": { "ExampleSetting1": "Example value", "ExampleSetting2": 5 } }

Since:: 2.0.3.5

preventCreateNewSearch

A boolean value indicating if the users can create an ad hoc search.

preventCreateNewUnifiedSearch

A boolean value indicating if the users can create a cross-repository search.

repositories

An array of ecm.model.Repository objects for this desktop.

repositoryId

A string value holding a repository identifier.

requestTimeout

The timeout time to use for all requests to the midtier, in milliseconds. This is undefined by default, meaning the default timeout of the browser will be used by default.

servicesUrl

The URL to use for access to the IBM Content Navigator services. By default, the URL is set relative to the Dojo location. This assumes the Dojo being used is IBM Content Navigator's (typically located in /navigator/dojo). For custom application situations where the IBM Content Navigator's dojo is not used, this can be set to the address of IBM Content Navigator.

shareEnabled

A boolean indicating if share is enabled.

Since:: 2.0.3.5

shareMyEmailModifiable

Boolean indicating if the my email can be modified by the user on the share dialog.

Since:: 2.0.3.5

shareRepositoryId

The share repository id.

Since:: 2.0.3.5

showGlobalToolbar

A boolean value indicating if the global toolbar should be shown in the layout or not.

showSecurity

A boolean value indicating if security should be displayed for documents and folders.

showSecurityInheritanceUI

A boolean value indicating if security inheritance UI should be displayed for folders.

showStatusbar

A boolean value that controls whether the status bar should be enabled.

Since:: 2.0.3

showViewFilmstrip

A boolean value indicating if filmstrip view should be enabled for this desktop and false if it should not.

syncServer

An instance of ecm.model.SyncServer used perform desktop, web and mobile sync.

Since:: 2.0.3

taskManager

An instance of ecm.model.TaskManager used perform task manager related services.

Since:: 2.0.2

templateName

A string value holding a template name.

theme

A string value indicating the theme that is used for the desktop.

userActionMacros

An array of ecm.model.admin.UserActionMacroConfig objects holding the macros for this desktop.

userDisplayName

The full, display user name for the user logged into the desktop. (Valid when connected.)

Since:: 2.0.2

userId

The user Id for the user logged into the desktop. (Valid when connected.)

Since:: 2.0.2

userLoginName

The login name used to login to the desktop. (Valid when connected.)

Since:: 2.0.3.8

useSiteLoginPage

A boolean value indicating if a site login page should be used instead of the login dialog when desktop authentication is required.

Since:: 2.0.3.3

valueFormatter

An instance of ecm.model.ValueFormatter used to format values for display.

viewerMappings

An array of ecm.model.ViewerMapping objects defined for this desktop.

viewers

An array of ecm.model.Viewer objects defined for this desktop.

viewersCache

An array of ecm.model.Viewer objects held in the desktop cache.

Method Detail

addFavorite(favorite, callback)

Adds a new favorite to the favorites list.

Parameters:
favorite: A ecm.model.Favorite object to add to the list.
callback: A callback function called after the favorite item has been added.

addFeature(feature)

Adds a new ecm.model.Feature to the desktop.

Parameters:
feature: The ecm.model.Feature to add to the desktop layout.

addMessage(message)

Adds a message to the list of messages maintained in the desktop.

Parameters:
message: An instance of ecm.model.Message for the message being added.

clearFavorites()

Clear favorites cache.

clearMessages()

Clears the messages list.

clearSyncItems()

Clear sync items cache.

Since:: 2.0.3.5

copyDesktop(desktop)

This is added to prevent pop-up windows from having to reload another copy of the desktop singleton when they initially start up. Instead, they can just clone from the window parent's singleton, if present.

Parameters:
desktop: A ecm.model.Desktop object to clone.

createAdminFeature(repositoryJSON)

Creates a new admin feature from JSON.

Parameters:
repositoryJSON: A JSON object holding the repository information.

createRepository(repositoryJSON)

Creates a new repository object.

Parameters:
repositoryJSON

getActionsHandler(callback)

Returns the actions handler object.

Parameters:
callback: Required to support asynchronous loading.

getBookmarkLayout(callback, args)

Returns a single instance of the bookmark layout widget to use for the desktop. See ecm.widget.layout.BookmarkLayout for more information on a bookmark layout.

Parameters:
callback: Required callback function to get an instance of the bookmark layout widget.
args: Arguments to use when constructing the new bookmark layout widget.

Since:: 2.0.3

getConfiguredLabels(callback)

Return the configured labels for the desktop.

Parameters:
callback: A callback function that is called with an array of configured label values.

getConfiguredLabelsvalue(key)

Return the configured label value.

Parameters:
key: A string value holding the key of the string to return.

getCustomLabel(name)

Return customizable label. This method will first look at a table of customizable labels filled by database content. If no data is found it will then pull the information from ecm.messages.

Parameters:
name: A string value holding the string identifer to look for.

getFeature(feature)

Returns a feature from the desktop.

Parameters:
feature: The ecm.model.Feature to retrieve from the desktop layout.

getFeatureById(featureId)

Returns a feature from the desktop.

Parameters:
featureId: The id of the feature to retrieve from the desktop layout.

getHelpContext()

Returns the context for help pages.

Since:: 2.0.3

getHelpUrl(forPage)

Returns the base URL to use for help pages.

Parameters:
forPage

Since:: 2.0.3

getLayout(callback)

Returns a single instance of the layout widget to use for the desktop. See ecm.widget.layout.BaseLayout for more information on layout widgets.

Parameters:
callback: Required to use getLayout with the asynchronous loader.

getLoadedViewerClass(viewer)

Parameters:
viewer

getMessageSearchUrl()

Returns a base URL to use for searching for messages.

Since:: 2.0.3

getPreviewersForItem(item, explicitMatchRequired, callback, contextRequire)

Returns an array of ecm.model.Viewer objects for the viewer to use to preview the provided item.

Parameters:
item: An instance of ecm.model.Item for the item to be viewed.
explicitMatchRequired: A boolean value indicating that an explicit MIME type match is required to find the viewer
callback: Required to use getViewersForItem with the asynchronous loader.
contextRequire

Since:: 2.0.3

getRepository(repositoryId)

Returns an instance of ecm.model.Repository for the given repository identifier.

Parameters:
repositoryId

getRepositoryByName(name, domainId)

Returns an instance of ecm.model.Repository for the given server name. For FileNet P8, this method will validate against the Object Store name.

Parameters:
name: A string value holding the repository's server name or for FileNet P8 object store name.
domainId: The ID of the FileNet P8 domain where the object store resides (optional). If not specified, the repository is not guaranteed to be correct since there may be more than one repository with the same object store name residing in different domains.

getRepositoryOfObjectStore(objectStoreName, domainId)

Returns an instance of ecm.model.Repository for the given FileNet P8 object store name.

Parameters:
objectStoreName: A string value holding a FileNet P8 object store name.
domainId: The ID of the FileNet P8 domain where the object store resides (optional). If not specified, the repository is not guaranteed to be correct since there may be more than one repository with the same object store name residing in different domains.

getRepositoryTypes()

Retrieves an array of all the repository types contained in this desktop.

Since:: 2.0.3.3

Returns:: An array of repository types.

getRequestParam(name)

Retrieves the specified request parameter from the invocation URL.

Parameters:
name: The name of the parameter to retrieve.

getServicesUrl()

Returns the URL that is being used to access the IBM Content Navigator services.

Deprecated:: As of 2.0.2. You can obtain the services URL simply by accessing the member variable on the Desktop object. For example, Desktop.servicesUrl.

getViewer(viewerId)

Returns an instance of ecm.model.Viewer for the specified viewer identifier.

Parameters:
viewerId: A string value holding the viewer identifier.

getViewerForItem(item, explicitMatchRequired)

Returns the appropriate instance of ecm.model.Viewer for the viewer to use to view the provided item.

Parameters:
item: An instance of ecm.model.Item for the item to be viewed.
explicitMatchRequired: A boolean value indicating that an explicit match is required to find the viewer

Deprecated:: as of ICN 2.0.3, use getViewersForItem instead.

getViewersForItem(item, explicitMatchRequired, callback, contextRequire)

Returns an array of ecm.model.Viewer objects for the viewer to use to view the provided item.

Parameters:
item: An instance of ecm.model.Item for the item to be viewed.
explicitMatchRequired: A boolean value indicating that an explicit MIME type match is required to find the viewer
callback: Required to use getViewersForItem with the asynchronous loader.
contextRequire

isContainerLoggedIn()

Returns a boolean true value if the container is logged in.

isLoggedIn()

Returns true if the initial repository is connected. If this is the case, clients should not show a login.

isPluginLoaded(pluginId)

Return boolean true if the specified plugin is loaded

Parameters:
pluginId: A string value holding the plugin Identifier

isReloading()

Returns a boolean true value if the desktop is reloading.

Since:: 2.0.3.3

loadDesktop(desktopId, callback, synchronous, useLastCache)

Loads the desktop.

Parameters:
desktopId: A string value holding the identifier of the desktop (or null for default desktop).
callback: A function that is invoked when the desktop has completed loading.
synchronous: A boolean value indicating that the load operation should be performed in a synchronous fashion.
useLastCache: Use the last cached copy of the desktop, if present. If not present, the desktop will be generated and cached (default is false, if this parameter is omitted or null).

loadFavorites(callback)

Loads an array of ecm.model.Favorite objects for the current user within this desktop.

Parameters:
callback: A callback function for the caller to work with the list of favorites return from the server.

loadMenuActions(actionListSuffix, callback, errorback)

Returns the action list for a particular suffix.

Parameters:
actionListSuffix: A string value holding the action suffix
callback: A callback function that is called after the context menu actions are loaded.
errorback

loadSyncItems(callback)

Loads an array of ecm.model.SyncItem objects for the current user within this desktop.

Parameters:
callback: A callback function for the caller to work with the list of sync items return from the server.

Since:: 2.0.3.5

loadViewerClasses(loadedCallback, viewerClasses, contextRequire)

Loads the specified viewer classes using AMD require, unless they've been loaded already..

Parameters:
loadedCallback
viewerClasses
contextRequire

logoff()

Disconnects from the server.

Since:: 2.0.2

logOffRepositories(response)

Log off the desktop repositories.

Parameters:
response: A response parameter.

logon(password, callback, reqParams, reqHeaders)

Connects to the server and authenticates with the provided password.

Parameters:
password: The password to use for logon.
callback: A function that is invoked on successfully logging on to the server.
reqParams: Custom request parameters to send to the mid-tier logon action (optional).
reqHeaders: Custom header parameters to send to the mid-tier logon action (optional).

Since:: 2.0.2

onBeforeClose(events)

An event function that is called prior to logout of the initial repository or close of the browser window.

Parameters:
events: An array of strings containing messages describing objects being edited or information that will be lost when the logout or close is performed. The array is initially empty. Event handlers can add messages to the array. If any messages are added, the confirmation dialog shown before logout or the browsers on-before-unload dialog will display these messages.

onChangeUploadProgress(evt)

An event function that is called when upload progress is changed.

Parameters:
evt

onCompleteUploadProgress(evt)

An event function that is called when upload progress is completed.

Parameters:
evt

onDesktopLoaded(response)

An event function invoked when the desktop has been loaded. The get methods on the desktop will not return valid values until this event has triggered.

Parameters:
response: The response used to initiate the desktop (optional).

onDisplayBatchStatusDialog()

An event function that is called when the batch status dialog is displayed.

onDisplayStatusDialog(statusDialog)

An event function that is called when the status dialog is displayed.

Parameters:
statusDialog

onFavoriteAdded(favorite)

Event function called when a favorite is added.

Parameters:
favorite: A ecm.model.Favorite object that was added to the list.

onFavoritesRemoved(favoritesRemoved)

Event function that is called when a favorite is removed.

Parameters:
favoritesRemoved: An array of strings holding the identifiers of the favorite items that have been removed.

onFavoriteUpdated(favorite)

Event function that is called when a favorite is updated.

Parameters:
favorite: A ecm.model.Favorite object to update.

onHideBatchStatusDialog()

An event function that is called when the batch status dialog is hidden.

onHideStatusDialog(statusDialog)

An event function that is called when the status dialog is hidden.

Parameters:
statusDialog

onLogin(repository)

This event is triggered when the initial repository is connected.

Parameters:
repository: An instance of ecm.model.Repository for the initial repository connected.

onLogout(repository)

This event is triggered when the initial repository is disconnected.

Parameters:
repository: The initial repository, now disconnected.

onMessageAdded(message)

This event function is called when a user-displayed message is to be shown or added to the messages area. Typically, error messages would be shown to the user through a message dialog as well as added to the messages area, whereas informational messages would only be added to the messages area.

Parameters:
message: An instance of ecm.model.Message for the last message added.

onMessagesChanged()

This event function is called when a message is added or the messages are cleared. It is intended to provide notification for the messages area to update the list of messages.

onPluginCSSLoaded()

This event is fired after all CSS loads complete for plug-in provided CSS. The ecm.widget.layout.BaseLayout listens to this event in order to resize the layout in case any plug-in CSS has changed computed sizes.

Since:: 2.0.2.1

onRequestCompleted(request)

This event function is called when a request to the services completed (either successfully or unsuccessfully). Any dialog box or other indicator to the user to wait should be removed.

Parameters:
request

onRequestStarted(request)

This event function is called when a request to the services is about to be launched. A dialog box or other indicator can be displayed to indicate that the user should wait.

Parameters:
request

onSessionExpired(request, error)

This event is triggered when a session expiration is detected.

The ecm.widget.dialog.LoginDialog can be connected to listen to this event and will display the login dialog on the event of a session expiration.

Parameters:
request: An instance of ecm.model.Request for the request that failed. To retry the request after login, use request.retry().
error: An instance of ecm.model.Message that is the error message.

onSyncItemUpdated(syncItem)

Event function that is called when a sync item is updated.

Parameters:
syncItem: A ecm.model.SyncItem object to update.

onTeamspacesListChanged()

An event function called when the list of teamspaces has changed.

onTeamspacesValueChanged(id, teamspaceStringValue)

An event function that is called when teamspaces has been turn on or off from Admin for a repository.

Parameters:
id: A string value holding the repository identifer.
teamspaceStringValue: A boolean value set to true if the teamspace if enabled.

refresh()

Refreshes all repositories in this desktop.

refreshActionsList()

reloadDesktop(logoutUrl)

This function reloads the desktop URL.

Parameters:
logoutUrl: If a logoutUrl is provided, the logoutUrl is loaded to process the logout before the desktop is reloaded.

Since:: 2.0.3.3

removeFavorites(favorites, callback)

Removes the specified favorites from the list.

Parameters:
favorites: An array of ecm.model.Favorite objects to remove.
callback: A callback function that is called after the favorite items have been removed.

removeFeature(feature)

Removes a feature from the desktop.

Parameters:
feature: The ecm.model.Feature to remove from the desktop layout.

setActionsHandler(actionsHandler)

Sets the actions handler object. This object contains functions that are invoked for all of the actions defined in ecm.model.Action objects.

Parameters:
actionsHandler: An object containing the action functions. See ecm.widget.layout.CommonActionsHandler.

setServicesUrl(url)

Sets the URL to use for access to the Content Navigator services. By default, the URL is /navigator. For situations where the IBM Content Navigator resides on a different application server from the web application, this can be set to the address of that server, typically using a proxy reference.

Parameters:
url: A string value holding the url to set.

updateFavorite(favorite, callback)

Updates a favorite in the favorites list.

Parameters:
favorite: A ecm.model.Favorite object to update.
callback: A callback function called after the favorite item has been updated.

updateSyncItem(favorite, callback)

Updates a sync item in the sync item list.

Parameters:
favorite: A ecm.model.SyncItem object to update.
callback: A callback function called after the favorite item has been updated.

Since:: 2.0.3.5