Class ecm.model.admin.DesktopConfig
Extends
ecm.model.admin._ConfigurationObject.
Represents the configuration information for a desktop. This information includes the following
information for the desktop:
- URLs to login information and password rules
- Banner configuration
- Repositories that are supported by the desktop, including the various default repositories
- The servers that this desktop connects to
- The layout that is used for this desktop
- The features that are available in this desktop
- A flag that indicates whether this desktop is the default desktop
- A flag indicating that the desktop has access control enabled
Defined in: <ecm\model\admin\DesktopConfig.js>.
Constructor Summary
| Constructor Attributes | Constructor Name and Description |
|---|---|
Field Summary
| Field Attributes | Field Name and Description |
|---|---|
Method Summary
Field Detail
EMAIL_SERVICE_ENABLED
- Since:
- 2.0.3.8
FROM_EMAIL_MODIFIABLE
- Since:
- 2.0.3.8
SHARE_ENABLED
- Since:
- 2.0.3.5
SHARE_MY_EMAIL_MODIFIABLE
- Since:
- 2.0.3.5
SHARE_REPOSITORY
- Since:
- 2.0.3.5
SYNC_ENABLED
- Since:
- 2.0.3
USE_FROM_EMAIL_AS_SENDER
- Since:
- 2.0.3.8
Method Detail
constructor(id, name)
- Parameters:
- id
- name
<static> ecm.model.admin.DesktopConfig.DesktopConfig.createDesktopConfig(id)
Static function that constructs a desktop config object.
- Parameters:
- id
- Desktop identifier.
getAddDocFoldersToRepo()
getAddPhotoFromMobile()
getAddWithEntryTemplateOnly()
getAppendPathComponent()
getApplicationName()
getApplicationNameLabelIds()
getApplicationNameLabels()
getApplicationNameLabelValues()
getApplicationSpaceLabels()
getApplicationSpacesLabelIds()
getApplicationSpacesLabelValues()
getAuthenticationType()
getBannerApplicationNameColor()
getBannerBackgroundColor()
getBannerLogoUrl()
getBannerMenuColor()
getCheckoutDocumentAfterAdd()
- Since:
- 2.0.3.5
getCheckoutOnOpenDoc()
getCloseTaskPaneOnOpen()
- Since:
- 2.0.3
getControlThreshold()
- Since:
- 2.0.3.6
getDefault()
getDefaultFeature()
getDefaultRepository()
getDeleteEmailOnAdd()
getDeleteLocalCopy()
getDeleteLocalCopyRuntimeState()
getDeleteLocalOnAdd()
getDeleteLocalOnCheckin()
getDeleteLocalOnSave()
getDeleteOpenDocsAfterClose()
getDescription()
getDesktopFeatures()
- Since:
- 2.0.3
getDisableDocumentTypeFiltering()
- Since:
- 2.0.3
getEditGroupAddButtonSetting()
- Since:
- 2.0.3
getEmailServiceEnabled()
- Since:
- 2.0.3.8
getEnableAllPlugins()
- Since:
- 2.0.3.7
getEnableFileTracking()
getEnableHideTimePortion()
getEnablePropMappingForAdd()
getEnableTimeZone()
getEntryTemplatesDefaultRepository()
getEnvironmentVariable()
getFeatures()
getFileIntoFolder()
getFileTrackingLocation()
getFromEmailModifiable()
- Since:
- 2.0.3.8
getHelpUrl()
getHideEntryTemplateNotFoundWarning()
getHideSaveDocument()
- Since:
- 2.0.3.1
getHideSearchActions()
- Since:
- 2.0.3.5
getIndicateManagedEmailOnAdd()
- Since:
- 2.0.3
getKCHelpContext()
- Since:
- 2.0.3
getKCHelpTaxonomy()
- Since:
- 2.0.3
getKCHelpWelcome()
- Since:
- 2.0.3
getLayout()
getLayoutActionHandler()
getLayoutLogFile()
getLoginInformationUrl()
getLoginLogoUrl()
getMaxConversionSize()
getMaxNumberDocToAdd()
getMaxNumberDocToModify()
getMessageSearchUrl()
getMobileAppAccess()
getMobileBrandingMainColor()
- Since:
- 2.0.3.5
getMobileBrandingSecondaryColor()
getMobileEmailAddress()
getMobileFeatures()
getMobileFeaturesInterfaceText()
getMobileMaaS360DeveloperID()
getMobileMaaS360Enabled()
getMobileMaaS360LicenseKey()
getName()
getOfficeBidiSupportFlag()
- Since:
- 2.0.3
getOfficeCustomCommandGroupName()
- Since:
- 2.0.3
getOfficeCustomCommands()
- Since:
- 2.0.3
getOfficeTextDirection()
- Since:
- 2.0.3
getOpenDocFromOtherApp()
getOpenFile()
getOtherFeaturesDefaultRepository()
getOutlookPropertyRemembrance()
- Since:
- 2.0.3.8
getOverWriteFile()
getOverWriteFileRuntimeState()
getPasswordRulesUrl()
getPluginIds()
- Since:
- 2.0.3.7
getPreventCreateNewSearch()
getPreventCreateNewUnifiedSearch()
getPromptCloseOfficeIfDocCheckout()
getPromptForPropsOnAdd()
getQualifiedPath()
getRedactionAddDocumentMode()
- Since:
- 2.0.3.7
getRedactionSaveMode()
- Since:
- 2.0.3.7
getRepositoryObjects(callback)
- Parameters:
- callback
getRibbonTabLabel()
- Since:
- 2.0.3
getSendEmailAsLinkOnly()
getServerObjects(callback)
- Parameters:
- callback
getShareEnabled()
- Since:
- 2.0.3.5
getShareMyEmailModifiable()
- Since:
- 2.0.3.5
getSharePointUrlData()
since 2.0.3
getSharePointUrlIds()
- Since:
- 2.0.3
getShareRepository()
- Since:
- 2.0.3.5
getShowDetailsRecentlyUsed()
- Since:
- 2.0.3.5
getShowFieldHoverHelp()
getShowGlobalToolbar()
getShowNoPermissionsWarning()
- Since:
- 2.0.3.5
getShowSecurity()
getShowSecurityInheritanceUI()
getShowStatusbar()
- Since:
- 2.0.3
getShowThumbnails()
getShowViewFilmstrip()
getSupportWorkflowNotification()
getSyncEnabled()
- Since:
- 2.0.3
getTeamspacesDefaultRepository()
getTheme()
getTimeZoneUTCOffset()
getUseFromEmailAsSender()
- Since:
- 2.0.3.8
getViewer()
getWorkDefaultRepository()
isAccessControlEnabled()
- Since:
- 2.0.2
isValid()
isWarning()
- Since:
- 2.0.3.6
setAccessControlEnabled(enabled)
- Parameters:
- enabled
- Since:
- 2.0.2
setAddDocFoldersToRepo(addDocFoldersToRepo)
- Parameters:
- addDocFoldersToRepo
setAddPhotoFromMobile(addPhotoFromMobile)
- Parameters:
- addPhotoFromMobile
setAddWithEntryTemplateOnly(addWithEntryTemplateOnly)
- Parameters:
- addWithEntryTemplateOnly
setAppendPathComponent(value)
- Parameters:
- value
setApplicationName(applicationName)
- Parameters:
- applicationName
setApplicationNameLabels(values)
- Parameters:
- values
setApplicationNameLabelsParam(values, ids)
- Parameters:
- values
- ids
setApplicationSpaceLabels(values)
- Parameters:
- values
setApplicationSpacesLabelsParam(values, ids)
- Parameters:
- values
- ids
setAuthenticationType(authType)
- Parameters:
- authType
setBannerApplicationNameColor(bannerApplicationNameColor)
- Parameters:
- bannerApplicationNameColor
setBannerBackgroundColor(bannerBackgroundColor)
- Parameters:
- bannerBackgroundColor
setBannerLogoUrl(bannerLogoUrl)
- Parameters:
- bannerLogoUrl
setBannerMenuColor(bannerMenuColor)
- Parameters:
- bannerMenuColor
setCheckoutDocumentAfterAdd(checkoutDocumentAfterAdd)
- Parameters:
- checkoutDocumentAfterAdd
- Since:
- 2.0.3.5
setCheckoutOnOpenDoc(checkoutOnOpenDoc)
- Parameters:
- checkoutOnOpenDoc
setCloseTaskPaneOnOpen(closeTaskPaneOnOpen)
- Parameters:
- closeTaskPaneOnOpen
- Since:
- 2.0.3
setControlThreshold(value)
- Parameters:
- value
- Since:
- 2.0.3.6
setDefault(isDefault)
- Parameters:
- isDefault
setDefaultFeature(defaultFeature)
- Parameters:
- defaultFeature
setDefaultRepository(defaultRepository)
- Parameters:
- defaultRepository
setDeleteEmailOnAdd(deleteEmailOnAdd)
- Parameters:
- deleteEmailOnAdd
setDeleteLocalCopy(value)
- Parameters:
- value
setDeleteLocalCopyRuntimeState(value)
- Parameters:
- value
setDeleteLocalOnAdd(deleteLocalOnAdd)
- Parameters:
- deleteLocalOnAdd
setDeleteLocalOnCheckin(deleteLocalOnCheckin)
- Parameters:
- deleteLocalOnCheckin
setDeleteLocalOnSave(deleteLocalOnSave)
- Parameters:
- deleteLocalOnSave
setDeleteOpenDocsAfterClose(deleteOpenDocsAfterClose)
- Parameters:
- deleteOpenDocsAfterClose
setDescription(description)
- Parameters:
- description
setDesktopFeatures(features)
- Parameters:
- features
- Since:
- 2.0.3
setDisableDocumentTypeFiltering(disableDocumentTypeFiltering)
- Parameters:
- disableDocumentTypeFiltering
- Since:
- 2.0.3
setEditGroupAddButtonSetting(editGroupAddButtonSetting)
- Parameters:
- editGroupAddButtonSetting
- Since:
- 2.0.3
setEmailServiceEnabled(emailServiceEnabled)
- Parameters:
- emailServiceEnabled
- Since:
- 2.0.3.8
setEnableAllPlugins(value)
- Parameters:
- value
- Since:
- 2.0.3.7
setEnableFileTracking(value)
- Parameters:
- value
setEnableHideTimePortion(value)
- Parameters:
- value
setEnablePropMappingForAdd(enablePropMappingOnAdd)
- Parameters:
- enablePropMappingOnAdd
setEnableTimeZone(value)
- Parameters:
- value
setEntryTemplatesDefaultRepository(defaultRepository)
- Parameters:
- defaultRepository
setEnvironmentVariable(value)
- Parameters:
- value
setFeatures(features)
- Parameters:
- features
setFileIntoFolder(fileIntoFolder)
- Parameters:
- fileIntoFolder
setFileTrackingLocation(loc)
- Parameters:
- loc
setFromEmailModifiable(fromEmailModifiable)
- Parameters:
- fromEmailModifiable
- Since:
- 2.0.3.8
setHelpUrl(helpUrl)
- Parameters:
- helpUrl
setHideEntryTemplateNotFoundWarning(values)
- Parameters:
- values
setHideSaveDocument(hideSaveDocument)
- Parameters:
- hideSaveDocument
- Since:
- 2.0.3.1
setHideSearchActions(hideSearchActions)
- Parameters:
- hideSearchActions
- Since:
- 2.0.3.5
setIndicateManagedEmailOnAdd(indicateManagedEmailOnAdd)
- Parameters:
- indicateManagedEmailOnAdd
- Since:
- 2.0.3
setKCHelpContext(context)
- Parameters:
- context
- Since:
- 2.0.3
setKCHelpTaxonomy(taxonomy)
- Parameters:
- taxonomy
- Since:
- 2.0.3
setKCHelpWelcome(welcome)
- Parameters:
- welcome
- Since:
- 2.0.3
setLayout(layout)
- Parameters:
- layout
setLayoutActionHandler(layoutActionHandler)
- Parameters:
- layoutActionHandler
setLayoutLogFile(logFile)
- Parameters:
- logFile
setLoginInformationUrl(loginInformationUrl)
- Parameters:
- loginInformationUrl
setLoginLogoUrl(loginLogoUrl)
- Parameters:
- loginLogoUrl
setMaxConversionSize(value)
- Parameters:
- value
setMaxNumberDocToAdd(value)
- Parameters:
- value
setMaxNumberDocToModify(value)
- Parameters:
- value
setMessageSearchUrl(messageSearchUrl)
- Parameters:
- messageSearchUrl
setMobileAppAccess(mobileAppAccess)
- Parameters:
- mobileAppAccess
setMobileBrandingMainColor(value)
- Parameters:
- value
setMobileBrandingSecondaryColor(value)
- Parameters:
- value
setMobileEmailAddress(value)
- Parameters:
- value
setMobileFeatures(features)
- Parameters:
- features
setMobileFeaturesInterfaceText(mobileTexts)
- Parameters:
- mobileTexts
setMobileMaaS360DeveloperID(value)
- Parameters:
- value
setMobileMaaS360Enabled(enabled)
- Parameters:
- enabled
setMobileMaaS360LicenseKey(value)
- Parameters:
- value
setName(name)
- Parameters:
- name
setOfficeBidiSupportFlag(officeBidiSupportFlag)
- Parameters:
- officeBidiSupportFlag
- Since:
- 2.0.3
setOfficeCustomCommandGroupName(officeCustomCommandGroupName)
- Parameters:
- officeCustomCommandGroupName
- Since:
- 2.0.3
setOfficeCustomCommands(officeCustomCommands)
- Parameters:
- officeCustomCommands
- Since:
- 2.0.3
setOfficeTextDirection(officeTextDirection)
- Parameters:
- officeTextDirection
- Since:
- 2.0.3
setOpenDocFromOtherApp(openDocFromOtherApp)
- Parameters:
- openDocFromOtherApp
setOpenFile(value)
- Parameters:
- value
setOtherFeaturesDefaultRepository(defaultRepository)
- Parameters:
- defaultRepository
setOutlookPropertyRemembrance(outlookPropertyRemembrance)
- Parameters:
- outlookPropertyRemembrance
- Since:
- 2.0.3.8
setOverWriteFile(value)
- Parameters:
- value
setOverWriteFileRuntimeState(value)
- Parameters:
- value
setPasswordRulesUrl(passwordRulesUrl)
- Parameters:
- passwordRulesUrl
setPluginIds(pluginIds)
- Parameters:
- pluginIds
- Since:
- 2.0.3.7
setPreventCreateNewSearch(values)
- Parameters:
- values
setPreventCreateNewUnifiedSearch(values)
- Parameters:
- values
setPromptCloseOfficeIfDocCheckout(promptCloseOffice)
- Parameters:
- promptCloseOffice
setPromptForPropsOnAdd(promptForPropsOnAdd)
- Parameters:
- promptForPropsOnAdd
setQualifiedPath(value)
- Parameters:
- value
setRedactionAddDocumentMode(value)
- Parameters:
- value
- Since:
- 2.0.3.7
setRedactionSaveMode(value)
- Parameters:
- value
- Since:
- 2.0.3.7
setRibbonTabLabel(ribbonBarTitle)
- Parameters:
- ribbonBarTitle
- Since:
- 2.0.3
setSendEmailAsLinkOnly(sendEmailAsLinkOnly)
- Parameters:
- sendEmailAsLinkOnly
setShareEnabled(enabled)
- Parameters:
- enabled
- Since:
- 2.0.3.5
setShareMyEmailModifiable(enabled)
- Parameters:
- enabled
- Since:
- 2.0.3.5
setSharePointUrlData(sharePointUrlData)
since 2.0.3
- Parameters:
- sharePointUrlData
setSharePointUrlIds(sharePointUrlIds)
- Parameters:
- sharePointUrlIds
- Since:
- 2.0.3
setShareRepository(repository)
- Parameters:
- repository
- Since:
- 2.0.3.5
setShowDetailsRecentlyUsed(showDetailsRecentlyUsed)
- Parameters:
- showDetailsRecentlyUsed
- Since:
- 2.0.3.5
setShowFieldHoverHelp(showFieldHoverHelp)
- Parameters:
- showFieldHoverHelp
setShowGlobalToolbar(showGlobalToolbar)
- Parameters:
- showGlobalToolbar
setShowNoPermissionsWarning(showNoPermissionsWarning)
- Parameters:
- showNoPermissionsWarning
- Since:
- 2.0.3.5
setShowSecurity(showSecurity)
- Parameters:
- showSecurity
setShowSecurityInheritanceUI(showSecurityInheritanceUI)
- Parameters:
- showSecurityInheritanceUI
setShowStatusbar(showStatusbar)
- Parameters:
- showStatusbar
- Since:
- 2.0.3
setShowThumbnails(showThumbnails)
- Parameters:
- showThumbnails
setShowViewFilmstrip(showViewFilmstrip)
- Parameters:
- showViewFilmstrip
setSupportWorkflowNotification(values)
- Parameters:
- values
setSyncEnabled(syncEnabled)
- Parameters:
- syncEnabled
- Since:
- 2.0.3
setTeamspacesDefaultRepository(defaultRepository)
- Parameters:
- defaultRepository
setTheme(theme)
- Parameters:
- theme
setTimeZoneUTCOffset(value)
- Parameters:
- value
setUseFromEmailAsSender(useFromEmailAsSender)
- Parameters:
- useFromEmailAsSender
- Since:
- 2.0.3.8
setValid(isValid)
- Parameters:
- isValid
setViewer(viewer)
- Parameters:
- viewer
setWarning(isWarning)
- Parameters:
- isWarning
- Since:
- 2.0.3.6
setWorkDefaultRepository(defaultRepository)
- Parameters:
- defaultRepository
updateFeaturesList(featuresData, featuresInterfaceTestData, callback, extraParams)
- Parameters:
- featuresData
- featuresInterfaceTestData
- callback
- extraParams