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 |
---|---|
An array of ecm.model.Action objects holding the desktop actions.
|
|
A ecm.widget.layout.CommonActionsHandler object to handle desktop actions.
|
|
Mobile settings to allow Mobile application to add documents and create folders to the repository.
|
|
Mobile settings to allow Mobile application to add photos from the camera and photo library.
|
|
A ecm.model.Feature object for the admin features.
|
|
A string holding the application name.
|
|
An object holding the application server operating system information.
|
|
Authentication mechanism used to authenticate the user when they log in to the desktop.
|
|
A string value holding the color to use for the application name in the banner.
|
|
A string value holding the banner's background color.
|
|
A URL string to the logo displayed in the banner area.
|
|
A string value holding the color to use for the menu in the banner.
|
|
A string value holding the desktop bookmark layout class.
|
|
A single instance of the bookmark layout widget to use for the desktop.
|
|
A ecm.model.ConfiguredLabels object.
|
|
A boolean value indicating this desktop is logged in.
|
|
A ecm.model.Container object for the desktop container object.
|
|
A boolean value setting for cultural collation.
|
|
A ecm.model.Feature object for the first feature to be displayed in the layout.
|
|
An object containing the repository id's for the default repositories defined for the various features in the
layout.
|
|
Default repository id that is defined for this desktop.
|
|
A boolean value indicating whether this desktop has been loaded or not.
|
|
An instance of ecm.model.Message for a message that will be displayed on the logout dialog as a
warning.
|
|
A boolean value indicating whether browser autocomplete feature should be disabled.
|
|
A boolean value indicating whether browser "cookies" are disabled.
|
|
A string value holding a document identifier.
|
|
A string value holding email link.
|
|
A boolean value indicating if the email service is enabled.
|
|
A boolean value indicating if thumbnail generation should be enabled for this desktop and false if it should
not.
|
|
Configured encryption key that is set in the settings configuration.
|
|
A array of ecm.model.Favorite objects for this desktop.
|
|
An array of ecm.model.Feature objects set for the desktop.
|
|
A boolean value indicating if new documents must be filed in a folder.
|
|
An array of ecm.model.admin.FileTypeConfig objects that hold the file type information of this
desktop.
|
|
A boolean value indicating if the From email address can be modified by the user on the email dialog.
|
|
Flag indicating whether or not this desktop contains Box repositories.
|
|
A string value holding the help URL context.
|
|
A string value holding the IBM help URL from Settings.
|
|
A string value holding the help taxonomy.
|
|
A string value holding the help URL.
|
|
A string value holding the help welcome file.
|
|
A boolean value indicating if the entry template not found warning should be hidden when item properties are
edited.
|
|
A string value holding the desktop layout class.
|
|
A single instance of the layout dijit to use for the desktop.
|
|
A list of Box repositories that are associated with the logged in Desktop user.
|
|
A URL string to a page providing additional login information.
|
|
A URL string to the logo displayed on the login panel.
|
|
Maximum size (in MB) of content sent to the server for conversion routines.
|
|
An int value holding the maximum number of documents that can be added with the multi-select add document
action.
|
|
An int value holding the maximum number of items that can be modified at one time.
|
|
An array of ecm.model.Message objects retrieved for this desktop.
|
|
A base URL string to use for searching for messages.
|
|
Mobile settings of allowing Mobile application user to access this desktop.
|
|
An object holding the mobile features.
|
|
A string value holding the IBM Content Navigator build number.
|
|
A string value holding the IBM Content Navigator release information.
|
|
An int value holding the IBM Content Navigator version number.
|
|
The timeout handler to use for all requests to the midtier.
|
|
Mobile settings to allow Mobile application to open documents in other applications.
|
|
A URL string to a page providing rules for password specification.
|
|
An object that contains settings assigned by custom plug-ins.
|
|
A boolean value indicating if the users can create an ad hoc search.
|
|
A boolean value indicating if the users can create a cross-repository search.
|
|
An array of ecm.model.Repository objects for this desktop.
|
|
A string value holding a repository identifier.
|
|
The timeout time to use for all requests to the midtier, in milliseconds.
|
|
The URL to use for access to the IBM Content Navigator services.
|
|
A boolean indicating if share is enabled.
|
|
Boolean indicating if the my email can be modified by the user on the share dialog.
|
|
The share repository id.
|
|
A boolean value indicating if the global toolbar should be shown in the layout or not.
|
|
A boolean value indicating if security should be displayed for documents and folders.
|
|
A boolean value indicating if security inheritance UI should be displayed for folders.
|
|
A boolean value that controls whether the status bar should be enabled.
|
|
A boolean value indicating if filmstrip view should be enabled for this desktop and false if it should not.
|
|
An instance of ecm.model.SyncServer used perform desktop, web and mobile sync.
|
|
An instance of ecm.model.TaskManager used perform task manager related services.
|
|
A string value holding a template name.
|
|
A string value indicating the theme that is used for the desktop.
|
|
An array of ecm.model.admin.UserActionMacroConfig objects holding the macros for this desktop.
|
|
The full, display user name for the user logged into the desktop.
|
|
The user Id for the user logged into the desktop.
|
|
The login name used to login to the desktop.
|
|
A boolean value indicating if a site login page should be used instead of the login dialog when desktop
authentication is required.
|
|
An instance of ecm.model.ValueFormatter used to format values for display.
|
|
An array of ecm.model.ViewerMapping objects defined for this desktop.
|
|
An array of ecm.model.Viewer objects defined for this desktop.
|
|
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.
|
|
Clear favorites cache.
|
|
Clears the messages list.
|
|
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.
|
|
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.
|
|
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)
|
|
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.
|
|
Retrieves an array of all the repository types contained in this desktop.
|
|
getRequestParam(name)
Retrieves the specified request parameter from the invocation URL.
|
|
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.
|
|
Returns a boolean true value if the container is logged in.
|
|
Returns true if the initial repository is connected.
|
|
isPluginLoaded(pluginId)
Return boolean true if the specified plugin is loaded
|
|
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.
|
|
An event function that is called when upload progress is changed.
|
|
An event function that is called when upload progress is completed.
|
|
onDesktopLoaded(response)
An event function invoked when the desktop has been loaded.
|
|
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.
|
|
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.
|
|
This event function is called when a message is added or the messages are cleared.
|
|
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.
|
|
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.
|
|
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)
- 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
actionsHandler
addDocFoldersToRepo
addPhotoFromMobile
adminFeature
applicationName
appServerOs
authenticationType
- 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
bannerBackgroundColor
bannerLogoUrl
bannerMenuColor
bookmarkLayout
- Since:
- 2.0.3
bookmarkLayoutWidget
- Since:
- 2.0.3
configuredLabels
connected
- Since:
- 2.0.2
container
culturalCollation
defaultFeature
defaultLayoutRepositories
- work - the default repository for workflow
- teamspaces - the default repository for teamspaces
- others - the default repository for browse, search and other features.
defaultRepositoryId
- Since:
- 2.0.2
desktopLoaded
dirtyMessage
disableAutocomplete
disableCookies
documentId
emailLink
emailServiceEnabled
- Since:
- 2.0.3.8
enableThumbnails
encryptionKey
- Since:
- 2.0.3
favorites
features
fileIntoFolder
fileTypes
fromEmailModifiable
- Since:
- 2.0.3.8
hasBoxRepositories
- Since:
- 2.0.3.5
helpContext
helpSettingsUrl
- Since:
- 2.0.3
helpTaxonomy
- Since:
- 2.0.3
helpUrl
helpWelcomeFile
- Since:
- 2.0.3
hideEntryTemplateNotFoundWarning
- Since:
- 2.0.3.5
layout
layoutDijit
linkedBoxRepositories
- Since:
- 2.0.3.5
loginInformationUrl
loginLogoUrl
maxConversionSize
- Since:
- 2.0.3
maxNumberDocToAdd
maxNumberDocToModify
messages
messageSearchUrl
mobileAppAccess
mobileFeatures
navigatorBuild
navigatorRelease
navigatorVersionNumber
- Since:
- 2.0.3
onRequestTimeout
openActions
- Since:
- 2.0.2 A two-level map containing all of the open actions available for this Desktop.
openDocFromOtherApp
passwordRulesUrl
pluginSettings
Example JSON: "pluginSettings": { "ExamplePlugin": { "ExampleSetting1": "Example value", "ExampleSetting2": 5 } }
- Since:
- 2.0.3.5
preventCreateNewSearch
preventCreateNewUnifiedSearch
repositories
repositoryId
requestTimeout
servicesUrl
shareEnabled
- Since:
- 2.0.3.5
shareMyEmailModifiable
- Since:
- 2.0.3.5
shareRepositoryId
- Since:
- 2.0.3.5
showGlobalToolbar
showSecurity
showSecurityInheritanceUI
showStatusbar
- Since:
- 2.0.3
showViewFilmstrip
syncServer
- Since:
- 2.0.3
taskManager
- Since:
- 2.0.2
templateName
theme
userActionMacros
userDisplayName
- Since:
- 2.0.2
userId
- Since:
- 2.0.2
userLoginName
- Since:
- 2.0.3.8
useSiteLoginPage
- Since:
- 2.0.3.3
valueFormatter
viewerMappings
viewers
viewersCache
Method Detail
addFavorite(favorite, callback)
- 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)
- Parameters:
- feature
- The ecm.model.Feature to add to the desktop layout.
addMessage(message)
- Parameters:
- message
- An instance of ecm.model.Message for the message being added.
clearFavorites()
clearMessages()
clearSyncItems()
- Since:
- 2.0.3.5
copyDesktop(desktop)
- Parameters:
- desktop
- A ecm.model.Desktop object to clone.
createAdminFeature(repositoryJSON)
- Parameters:
- repositoryJSON
- A JSON object holding the repository information.
createRepository(repositoryJSON)
- Parameters:
- repositoryJSON
getActionsHandler(callback)
- Parameters:
- callback
- Required to support asynchronous loading.
getBookmarkLayout(callback, args)
- 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)
- Parameters:
- callback
- A callback function that is called with an array of configured label values.
getConfiguredLabelsvalue(key)
- Parameters:
- key
- A string value holding the key of the string to return.
getCustomLabel(name)
- Parameters:
- name
- A string value holding the string identifer to look for.
getFeature(feature)
- Parameters:
- feature
- The ecm.model.Feature to retrieve from the desktop layout.
getFeatureById(featureId)
- Parameters:
- featureId
- The id of the feature to retrieve from the desktop layout.
getHelpContext()
- Since:
- 2.0.3
getHelpUrl(forPage)
- Parameters:
- forPage
- Since:
- 2.0.3
getLayout(callback)
- Parameters:
- callback
- Required to use getLayout with the asynchronous loader.
getLoadedViewerClass(viewer)
- Parameters:
- viewer
getMessageSearchUrl()
- Since:
- 2.0.3
getPreviewersForItem(item, explicitMatchRequired, callback, contextRequire)
- 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)
- Parameters:
- repositoryId
getRepositoryByName(name, domainId)
- 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)
- 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()
- Since:
- 2.0.3.3
- Returns:
- An array of repository types.
getRequestParam(name)
- Parameters:
- name
- The name of the parameter to retrieve.
getServicesUrl()
- 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)
- Parameters:
- viewerId
- A string value holding the viewer identifier.
getViewerForItem(item, explicitMatchRequired)
- 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)
- 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()
isLoggedIn()
isPluginLoaded(pluginId)
- Parameters:
- pluginId
- A string value holding the plugin Identifier
isReloading()
- Since:
- 2.0.3.3
loadDesktop(desktopId, callback, synchronous, useLastCache)
- 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)
- Parameters:
- callback
- A callback function for the caller to work with the list of favorites return from the server.
loadMenuActions(actionListSuffix, callback, errorback)
- 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)
- 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)
- Parameters:
- loadedCallback
- viewerClasses
- contextRequire
logoff()
- Since:
- 2.0.2
logOffRepositories(response)
- Parameters:
- response
- A response parameter.
logon(password, callback, reqParams, reqHeaders)
- 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)
- 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)
- Parameters:
- evt
onCompleteUploadProgress(evt)
- Parameters:
- evt
onDesktopLoaded(response)
- Parameters:
- response
- The response used to initiate the desktop (optional).
onDisplayBatchStatusDialog()
onDisplayStatusDialog(statusDialog)
- Parameters:
- statusDialog
onFavoriteAdded(favorite)
- Parameters:
- favorite
- A ecm.model.Favorite object that was added to the list.
onFavoritesRemoved(favoritesRemoved)
- Parameters:
- favoritesRemoved
- An array of strings holding the identifiers of the favorite items that have been removed.
onFavoriteUpdated(favorite)
- Parameters:
- favorite
- A ecm.model.Favorite object to update.
onHideBatchStatusDialog()
onHideStatusDialog(statusDialog)
- Parameters:
- statusDialog
onLogin(repository)
- Parameters:
- repository
- An instance of ecm.model.Repository for the initial repository connected.
onLogout(repository)
- Parameters:
- repository
- The initial repository, now disconnected.
onMessageAdded(message)
- Parameters:
- message
- An instance of ecm.model.Message for the last message added.
onMessagesChanged()
onPluginCSSLoaded()
- Since:
- 2.0.2.1
onRequestCompleted(request)
- Parameters:
- request
onRequestStarted(request)
- Parameters:
- request
onSessionExpired(request, error)
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)
- Parameters:
- syncItem
- A ecm.model.SyncItem object to update.
onTeamspacesListChanged()
onTeamspacesValueChanged(id, teamspaceStringValue)
- Parameters:
- id
- A string value holding the repository identifer.
- teamspaceStringValue
- A boolean value set to true if the teamspace if enabled.
refresh()
refreshActionsList()
reloadDesktop(logoutUrl)
- 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)
- 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)
- Parameters:
- feature
- The ecm.model.Feature to remove from the desktop layout.
setActionsHandler(actionsHandler)
- Parameters:
- actionsHandler
- An object containing the action functions. See ecm.widget.layout.CommonActionsHandler.
setServicesUrl(url)
/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)
- Parameters:
- favorite
- A ecm.model.Favorite object to update.
- callback
- A callback function called after the favorite item has been updated.
updateSyncItem(favorite, callback)
- 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