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
	ecm.model.admin.DesktopConfig()

Field Summary

Field Attributes	Field Name and Description
	ALLOW_EMAIL_ATTACHMENTS
	AUDIT_HISTORY_ENABLED_ON_DESKTOP
	AUTO_CC_SENDER
	EDIT_MAC_CLIENT_INSTALLER_AVAILABLE
	EDIT_WIN_CLIENT_INSTALLER_AVAILABLE
	EMAIL_CLIENT_APP
	EMAIL_CLIENT_ENABLED
	EMAIL_SERVICE_ENABLED
	FROM_EMAIL_MODIFIABLE
	MOBILEQR_ENABLED
	SHARE_ENABLED
	SHARE_MY_EMAIL_MODIFIABLE
	SHARE_REPOSITORY
	STREAMLINE_ENABLED
	SYNC_ENABLED
	USE_FROM_EMAIL_AS_SENDER

Method Summary

Method Attributes	Method Name and Description
	constructor(id, name)
<static>	ecm.model.admin.DesktopConfig.DesktopConfig.createDesktopConfig(id) Static function that constructs a desktop config object.
	getAddDocFoldersToRepo()
	getAddPhotoFromMobile()
	getAddWithEntryTemplateOnly()
	getAdminRoleConfig(callback)
	getAdminRoleId()
	getAllowCollaborativeEditing()
	getAllowEmailAttachments()
	getApplicationName()
	getApplicationNameLabelIds()
	getApplicationNameLabels()
	getApplicationNameLabelValues()
	getApplicationSpaceLabels()
	getApplicationSpacesLabelIds()
	getApplicationSpacesLabelValues()
	getAsperaEnabled()
	getAsperaShowLink()
	getAuditHistoryEnabledOnDesktop()
	getAuthenticationType()
	getAutoCCSender()
	getBannerApplicationNameColor()
	getBannerBackgroundColor()
	getBannerLogoUrl()
	getBannerMenuColor()
	getCheckoutDocumentAfterAdd()
	getCheckoutOnOpenDoc()
	getCloseTaskPaneOnOpen()
	getContentElementNavigation()
	getControlThreshold()
	getDefault()
	getDefaultFeature()
	getDefaultRepository()
	getDeleteEmailOnAdd()
	getDeleteLocalOnAdd()
	getDeleteLocalOnCheckin()
	getDeleteLocalOnSave()
	getDeleteOpenDocsAfterClose()
	getDescription()
	getDesktopFeatures()
	getDesktopType()
	getDesktopVirtualCustomSettings()
	getDisableDocumentTypeFiltering()
	getDocumentAddMode()
	getEditGroupAddButtonSetting()
	getEditMacClientInstallerAvailable()
	getEditWinClientInstallerAvailable()
	getEmailClientApp()
	getEmailClientEnabled()
	getEmailServiceEnabled()
	getEnableAllPlugins()
	getEnableHideTimePortion()
	getEnablePropMappingForAdd()
	getEnableTimeZone()
	getEntryTemplatesDefaultRepository()
	getFeatures()
	getFileIntoFolder()
	getFromEmailModifiable()
	getHelpUrl()
	getHideEntryTemplateNotFoundWarning()
	getHideSaveDocument()
	getHideSearchActions()
	getIndicateManagedEmailOnAdd()
	getKCHelpContext()
	getKCHelpTaxonomy()
	getKCHelpWelcome()
	getLayout()
	getLayoutActionHandler()
	getLayoutLogFile()
	getLoginInformationUrl()
	getLoginLogoUrl()
	getMaxConversionSize()
	getMaxNumberDocToAdd()
	getMaxNumberDocToModify()
	getMaxNumberDocToPrint()
	getMergeSplitEnabled()
	getMergeSplitShowCheckIn()
	getMessageSearchUrl()
	getMobileAppAccess()
	getMobileBrandingDarkModeMainColor()
	getMobileBrandingDarkModeSecondaryColor()
	getMobileBrandingMainColor()
	getMobileBrandingSecondaryColor()
	getMobileDownloadEnabled()
	getMobileEmailAddress()
	getMobileFeatures()
	getMobileFeaturesInterfaceText()
	getMobileMaaS360DeveloperID()
	getMobileMaaS360Enabled()
	getMobileMaaS360LicenseKey()
	getMobileQREnabled()
	getName()
	getOfficeBidiSupportFlag()
	getOfficeCustomCommandGroupName()
	getOfficeCustomCommands()
	getOfficeOnlineEnabled()
	getOfficeTextDirection()
	getOpenDocFromOtherApp()
	getOtherFeaturesDefaultRepository()
	getOutlookPropertyRemembrance()
	getOutlookUseEmailAddresses()
	getOverwriteLocalOnCheckout()
	getPasswordRulesUrl()
	getPluginIds()
	getPreventCreateNewSearch()
	getPreventCreateNewUnifiedSearch()
	getPrintServiceEnabled()
	getPromptCloseOfficeIfDocCheckout()
	getPromptForPropsOnAdd()
	getRedactionAddDocumentMode()
	getRedactionSaveMode()
	getRepositoryObjects(callback)
	getRibbonTabLabel()
	getSendEmailAsLinkOnly()
	getServerObjects(callback)
	getShareEnabled()
	getShareMyEmailModifiable()
	getSharePointUrlData() since 2.0.3
	getSharePointUrlIds()
	getShareRepository()
	getShowContentListCheckbox()
	getShowDetailsRecentlyUsed()
	getShowFieldHoverHelp()
	getShowGlobalToolbar()
	getShowNoPermissionsWarning()
	getShowOnlyRoleSecurity()
	getShowPrimaryDocumentOnly()
	getShowRoleSecurity()
	getShowSecurity()
	getShowSecurityInheritanceUI()
	getShowStatusbar()
	getShowThumbnails()
	getShowViewFilmstrip()
	getStreamlineEnabled()
	getSupportWorkflowNotification()
	getSyncEnabled()
	getTeamspacesDefaultRepository()
	getTheme()
	getTimeZoneUTCOffset()
	getTypeString() Returns the display name of the desktop type.
	getUseFromEmailAsSender()
	getValue(attribute)
	getViewer()
	getViewInDialog()
	getWorkDefaultRepository()
	isAccessControlEnabled()
	isRoleBasedAdminEnabled()
	isValid()
	isWarning()
	setAccessControlEnabled(enabled)
	setAddDocFoldersToRepo(addDocFoldersToRepo)
	setAddPhotoFromMobile(addPhotoFromMobile)
	setAddWithEntryTemplateOnly(addWithEntryTemplateOnly)
	setAdminRoleId(adminRoleId)
	setAllowCollaborativeEditing(allowCollaborativeEditing)
	setAllowEmailAttachments(allowEmailAttachments)
	setApplicationName(applicationName)
	setApplicationNameLabels(values)
	setApplicationNameLabelsParam(values, ids)
	setApplicationSpaceLabels(values)
	setApplicationSpacesLabelsParam(values, ids)
	setAsperaEnabled(enabled)
	setAsperaShowLink(enabled)
	setAuditHistoryEnabledOnDesktop(auditHistoryEnabledOnDesktop)
	setAuthenticationType(authType)
	setAutoCCSender(autoCCSender)
	setBannerApplicationNameColor(bannerApplicationNameColor)
	setBannerBackgroundColor(bannerBackgroundColor)
	setBannerLogoUrl(bannerLogoUrl)
	setBannerMenuColor(bannerMenuColor)
	setCheckoutDocumentAfterAdd(checkoutDocumentAfterAdd)
	setCheckoutOnOpenDoc(checkoutOnOpenDoc)
	setCloseTaskPaneOnOpen(closeTaskPaneOnOpen)
	setContentElementNavigation(value)
	setControlThreshold(value)
	setDefault(isDefault)
	setDefaultFeature(defaultFeature)
	setDefaultRepository(defaultRepository)
	setDeleteEmailOnAdd(deleteEmailOnAdd)
	setDeleteLocalOnAdd(deleteLocalOnAdd)
	setDeleteLocalOnCheckin(deleteLocalOnCheckin)
	setDeleteLocalOnSave(deleteLocalOnSave)
	setDeleteOpenDocsAfterClose(deleteOpenDocsAfterClose)
	setDescription(description)
	setDesktopFeatures(features)
	setDesktopType(desktopType)
	setDesktopVirtualCustomSettings(desktopVirtualCustomSettings)
	setDisableDocumentTypeFiltering(disableDocumentTypeFiltering)
	setDocumentAddMode(value)
	setEditGroupAddButtonSetting(editGroupAddButtonSetting)
	setEmailClientApp(emailClientApp)
	setEmailClientEnabled(emailClientEnabled)
	setEmailServiceEnabled(emailServiceEnabled)
	setEnableAllPlugins(value)
	setEnableHideTimePortion(value)
	setEnablePropMappingForAdd(enablePropMappingOnAdd)
	setEnableTimeZone(value)
	setEntryTemplatesDefaultRepository(defaultRepository)
	setFeatures(features)
	setFileIntoFolder(fileIntoFolder)
	setFromEmailModifiable(fromEmailModifiable)
	setHelpUrl(helpUrl)
	setHideEntryTemplateNotFoundWarning(values)
	setHideSaveDocument(hideSaveDocument)
	setHideSearchActions(hideSearchActions)
	setIndicateManagedEmailOnAdd(indicateManagedEmailOnAdd)
	setKCHelpContext(context)
	setKCHelpTaxonomy(taxonomy)
	setKCHelpWelcome(welcome)
	setLayout(layout)
	setLayoutActionHandler(layoutActionHandler)
	setLayoutLogFile(logFile)
	setLoginInformationUrl(loginInformationUrl)
	setLoginLogoUrl(loginLogoUrl)
	setMaxConversionSize(value)
	setMaxNumberDocToAdd(value)
	setMaxNumberDocToModify(value)
	setMaxNumberDocToPrint(value)
	setMergeSplitEnabled(enabled)
	setMergeSplitShowCheckIn(show)
	setMessageSearchUrl(messageSearchUrl)
	setMobileAppAccess(mobileAppAccess)
	setMobileBrandingDarkModeMainColor(value)
	setMobileBrandingDarkModeSecondaryColor(value)
	setMobileBrandingMainColor(value)
	setMobileBrandingSecondaryColor(value)
	setMobileDownloadEnabled(enabled)
	setMobileEmailAddress(value)
	setMobileFeatures(features)
	setMobileFeaturesInterfaceText(mobileTexts)
	setMobileMaaS360DeveloperID(value)
	setMobileMaaS360Enabled(enabled)
	setMobileMaaS360LicenseKey(value)
	setMobileQREnabled(mobileQREnabled)
	setName(name)
	setOfficeBidiSupportFlag(officeBidiSupportFlag)
	setOfficeCustomCommandGroupName(officeCustomCommandGroupName)
	setOfficeCustomCommands(officeCustomCommands)
	setOfficeOnlineEnabled(officeOnlineEnabled)
	setOfficeTextDirection(officeTextDirection)
	setOpenDocFromOtherApp(openDocFromOtherApp)
	setOtherFeaturesDefaultRepository(defaultRepository)
	setOutlookPropertyRemembrance(outlookPropertyRemembrance)
	setOutlookUseEmailAddresses(outlookUseEmailAddresses)
	setOverwriteLocalOnCheckout(overwriteLocalOnCheckout)
	setPasswordRulesUrl(passwordRulesUrl)
	setPluginIds(pluginIds)
	setPreventCreateNewSearch(values)
	setPreventCreateNewUnifiedSearch(values)
	setPrintServiceEnabled(printServiceEnabled)
	setPromptCloseOfficeIfDocCheckout(promptCloseOffice)
	setPromptForPropsOnAdd(promptForPropsOnAdd)
	setRedactionAddDocumentMode(value)
	setRedactionSaveMode(value)
	setRibbonTabLabel(ribbonBarTitle)
	setRoleBasedAdminEnabled(enabled)
	setSendEmailAsLinkOnly(sendEmailAsLinkOnly)
	setShareEnabled(enabled)
	setShareMyEmailModifiable(enabled)
	setSharePointUrlData(sharePointUrlData) since 2.0.3
	setSharePointUrlIds(sharePointUrlIds)
	setShareRepository(repository)
	setShowContentListCheckbox(showContentListCheckbox)
	setShowDetailsRecentlyUsed(showDetailsRecentlyUsed)
	setShowFieldHoverHelp(showFieldHoverHelp)
	setShowGlobalToolbar(showGlobalToolbar)
	setShowNoPermissionsWarning(showNoPermissionsWarning)
	setShowOnlyRoleSecurity(values)
	setShowPrimaryDocumentOnly(values)
	setShowRoleSecurity(values)
	setShowSecurity(showSecurity)
	setShowSecurityInheritanceUI(showSecurityInheritanceUI)
	setShowStatusbar(showStatusbar)
	setShowThumbnails(showThumbnails)
	setShowViewFilmstrip(showViewFilmstrip)
	setStreamlineEnabled(streamlineEnabled)
	setSupportWorkflowNotification(values)
	setSyncEnabled(syncEnabled)
	setTeamspacesDefaultRepository(defaultRepository)
	setTheme(theme)
	setTimeZoneUTCOffset(value)
	setUseFromEmailAsSender(useFromEmailAsSender)
	setValid(isValid)
	setViewer(viewer)
	setViewInDialog(values)
	setWarning(isWarning)
	setWorkDefaultRepository(defaultRepository)
	updateFeaturesList(featuresData, featuresInterfaceTestData, callback, extraParams)

Field Detail

ALLOW_EMAIL_ATTACHMENTS

Since:

3.0.10

---

AUDIT_HISTORY_ENABLED_ON_DESKTOP

Since:

3.0.9

---

AUTO_CC_SENDER

Since:

3.0.9

---

EDIT_MAC_CLIENT_INSTALLER_AVAILABLE

Since:

3.0.3

---

EDIT_WIN_CLIENT_INSTALLER_AVAILABLE

Since:

3.0.1

---

EMAIL_CLIENT_APP

Since:

3.0.10

---

EMAIL_CLIENT_ENABLED

Since:

3.0.10

---

EMAIL_SERVICE_ENABLED

Since:

2.0.3.8

---

FROM_EMAIL_MODIFIABLE

Since:

2.0.3.8

---

MOBILEQR_ENABLED

Since:

3.0.1

---

SHARE_ENABLED

Since:

2.0.3.5

---

SHARE_MY_EMAIL_MODIFIABLE

Since:

2.0.3.5

---

SHARE_REPOSITORY

Since:

2.0.3.5

---

STREAMLINE_ENABLED

Since:

2.0.3.8

---

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)

Parameters:

id

Desktop identifier.

---

getAddDocFoldersToRepo()

---

getAddPhotoFromMobile()

---

getAddWithEntryTemplateOnly()

---

getAdminRoleConfig(callback)

Parameters:

callback

Since:

3.0.3

---

getAdminRoleId()

Since:

3.0.3

---

getAllowCollaborativeEditing()

Since:

3.0

---

getAllowEmailAttachments()

Since:

3.0.10

---

getApplicationName()

---

getApplicationNameLabelIds()

---

getApplicationNameLabels()

---

getApplicationNameLabelValues()

---

getApplicationSpaceLabels()

---

getApplicationSpacesLabelIds()

---

getApplicationSpacesLabelValues()

---

getAsperaEnabled()

Since:

3.0.4

---

getAsperaShowLink()

Since:

3.0.9

---

getAuditHistoryEnabledOnDesktop()

Since:

3.0.9

---

getAuthenticationType()

---

getAutoCCSender()

Since:

3.0.9

---

getBannerApplicationNameColor()

---

getBannerBackgroundColor()

---

getBannerLogoUrl()

---

getBannerMenuColor()

---

getCheckoutDocumentAfterAdd()

Since:

2.0.3.5

---

getCheckoutOnOpenDoc()

---

getCloseTaskPaneOnOpen()

Since:

2.0.3

---

getContentElementNavigation()

Since:

3.0.9

---

getControlThreshold()

Since:

2.0.3.6

---

getDefault()

---

getDefaultFeature()

---

getDefaultRepository()

---

getDeleteEmailOnAdd()

---

getDeleteLocalOnAdd()

---

getDeleteLocalOnCheckin()

---

getDeleteLocalOnSave()

---

getDeleteOpenDocsAfterClose()

---

getDescription()

---

getDesktopFeatures()

Since:

2.0.3

---

getDesktopType()

Since:

3.0.5

---

getDesktopVirtualCustomSettings()

Since:

3.0.8

---

getDisableDocumentTypeFiltering()

Since:

2.0.3

---

getDocumentAddMode()

Since:

3.0.1

---

getEditGroupAddButtonSetting()

Since:

2.0.3

---

getEditMacClientInstallerAvailable()

Since:

3.0.3

---

getEditWinClientInstallerAvailable()

Since:

3.0.1

---

getEmailClientApp()

Since:

3.0.10

---

getEmailClientEnabled()

Since:

3.0.10

---

getEmailServiceEnabled()

Since:

2.0.3.8

---

getEnableAllPlugins()

Since:

2.0.3.7

---

getEnableHideTimePortion()

---

getEnablePropMappingForAdd()

---

getEnableTimeZone()

---

getEntryTemplatesDefaultRepository()

---

getFeatures()

---

getFileIntoFolder()

---

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()

---

getMaxNumberDocToPrint()

Since:

3.0.3

---

getMergeSplitEnabled()

Since:

3.0.1

---

getMergeSplitShowCheckIn()

Since:

3.0.1

---

getMessageSearchUrl()

---

getMobileAppAccess()

---

getMobileBrandingDarkModeMainColor()

Since:

3.0.10

---

getMobileBrandingDarkModeSecondaryColor()

---

getMobileBrandingMainColor()

Since:

2.0.3.5

---

getMobileBrandingSecondaryColor()

---

getMobileDownloadEnabled()

Since:

3.0.9 IF1

---

getMobileEmailAddress()

---

getMobileFeatures()

---

getMobileFeaturesInterfaceText()

---

getMobileMaaS360DeveloperID()

---

getMobileMaaS360Enabled()

Since:

2.0.3.5

---

getMobileMaaS360LicenseKey()

---

getMobileQREnabled()

Since:

3.0.1

---

getName()

---

getOfficeBidiSupportFlag()

Since:

2.0.3

---

getOfficeCustomCommandGroupName()

Since:

2.0.3

---

getOfficeCustomCommands()

Since:

2.0.3

---

getOfficeOnlineEnabled()

Since:

3.0

---

getOfficeTextDirection()

Since:

2.0.3

---

getOpenDocFromOtherApp()

---

getOtherFeaturesDefaultRepository()

---

getOutlookPropertyRemembrance()

Since:

3.0

---

getOutlookUseEmailAddresses()

Since:

3.0.7

---

getOverwriteLocalOnCheckout()

---

getPasswordRulesUrl()

---

getPluginIds()

Since:

2.0.3.7

---

getPreventCreateNewSearch()

---

getPreventCreateNewUnifiedSearch()

---

getPrintServiceEnabled()

Since:

3.0.2

---

getPromptCloseOfficeIfDocCheckout()

---

getPromptForPropsOnAdd()

---

getRedactionAddDocumentMode()

Deprecated:

3.0.1 Use getDocumentAddMode() instead.

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()

---

getSharePointUrlIds()

Since:

2.0.3

---

getShareRepository()

Since:

2.0.3.5

---

getShowContentListCheckbox()

Since:

3.0.6

---

getShowDetailsRecentlyUsed()

Since:

2.0.3.5

---

getShowFieldHoverHelp()

---

getShowGlobalToolbar()

---

getShowNoPermissionsWarning()

Since:

2.0.3.5

---

getShowOnlyRoleSecurity()

---

getShowPrimaryDocumentOnly()

---

getShowRoleSecurity()

---

getShowSecurity()

---

getShowSecurityInheritanceUI()

---

getShowStatusbar()

Since:

2.0.3

---

getShowThumbnails()

---

getShowViewFilmstrip()

---

getStreamlineEnabled()

Since:

2.0.3.8

---

getSupportWorkflowNotification()

---

getSyncEnabled()

Since:

2.0.3

---

getTeamspacesDefaultRepository()

---

getTheme()

---

getTimeZoneUTCOffset()

---

getTypeString()

---

getUseFromEmailAsSender()

Since:

2.0.3.8

---

getValue(attribute)

Parameters:

attribute

---

getViewer()

---

getViewInDialog()

---

getWorkDefaultRepository()

---

isAccessControlEnabled()

Since:

2.0.2

---

isRoleBasedAdminEnabled()

Since:

3.0.3

---

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

---

setAdminRoleId(adminRoleId)

Parameters:

adminRoleId

Since:

3.0.3

---

setAllowCollaborativeEditing(allowCollaborativeEditing)

Parameters:

allowCollaborativeEditing

Since:

3.0

---

setAllowEmailAttachments(allowEmailAttachments)

Parameters:

allowEmailAttachments

Since:

3.0.10

---

setApplicationName(applicationName)

Parameters:

applicationName

---

setApplicationNameLabels(values)

Parameters:

values

---

setApplicationNameLabelsParam(values, ids)

Parameters:

values

ids

---

setApplicationSpaceLabels(values)

Parameters:

values

---

setApplicationSpacesLabelsParam(values, ids)

Parameters:

values

ids

---

setAsperaEnabled(enabled)

Parameters:

enabled

Since:

3.0.4

---

setAsperaShowLink(enabled)

Parameters:

enabled

Since:

3.0.9

---

setAuditHistoryEnabledOnDesktop(auditHistoryEnabledOnDesktop)

Parameters:

auditHistoryEnabledOnDesktop

Since:

3.0.9

---

setAuthenticationType(authType)

Parameters:

authType

---

setAutoCCSender(autoCCSender)

Parameters:

autoCCSender

Since:

3.0.9

---

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

---

setContentElementNavigation(value)

Parameters:

value

Since:

3.0.9

---

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

---

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

---

setDesktopType(desktopType)

Parameters:

desktopType

Since:

3.0.5

---

setDesktopVirtualCustomSettings(desktopVirtualCustomSettings)

Parameters:

desktopVirtualCustomSettings

Since:

3.0.8

---

setDisableDocumentTypeFiltering(disableDocumentTypeFiltering)

Parameters:

disableDocumentTypeFiltering

Since:

2.0.3

---

setDocumentAddMode(value)

Parameters:

value

Since:

3.0.1

---

setEditGroupAddButtonSetting(editGroupAddButtonSetting)

Parameters:

editGroupAddButtonSetting

Since:

2.0.3

---

setEmailClientApp(emailClientApp)

Parameters:

emailClientApp

Since:

3.0.10

---

setEmailClientEnabled(emailClientEnabled)

Parameters:

emailClientEnabled

Since:

3.0.10

---

setEmailServiceEnabled(emailServiceEnabled)

Parameters:

emailServiceEnabled

Since:

2.0.3.8

---

setEnableAllPlugins(value)

Parameters:

value

Since:

2.0.3.7

---

setEnableHideTimePortion(value)

Parameters:

value

---

setEnablePropMappingForAdd(enablePropMappingOnAdd)

Parameters:

enablePropMappingOnAdd

---

setEnableTimeZone(value)

Parameters:

value

---

setEntryTemplatesDefaultRepository(defaultRepository)

Parameters:

defaultRepository

---

setFeatures(features)

Parameters:

features

---

setFileIntoFolder(fileIntoFolder)

Parameters:

fileIntoFolder

---

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

---

setMaxNumberDocToPrint(value)

Parameters:

value

Since:

3.0.3

---

setMergeSplitEnabled(enabled)

Parameters:

enabled

Since:

3.0.1

---

setMergeSplitShowCheckIn(show)

Parameters:

show

Since:

3.0.1

---

setMessageSearchUrl(messageSearchUrl)

Parameters:

messageSearchUrl

---

setMobileAppAccess(mobileAppAccess)

Parameters:

mobileAppAccess

---

setMobileBrandingDarkModeMainColor(value)

Parameters:

value

---

setMobileBrandingDarkModeSecondaryColor(value)

Parameters:

value

---

setMobileBrandingMainColor(value)

Parameters:

value

---

setMobileBrandingSecondaryColor(value)

Parameters:

value

---

setMobileDownloadEnabled(enabled)

Parameters:

enabled

---

setMobileEmailAddress(value)

Parameters:

value

---

setMobileFeatures(features)

Parameters:

features

---

setMobileFeaturesInterfaceText(mobileTexts)

Parameters:

mobileTexts

---

setMobileMaaS360DeveloperID(value)

Parameters:

value

---

setMobileMaaS360Enabled(enabled)

Parameters:

enabled

---

setMobileMaaS360LicenseKey(value)

Parameters:

value

---

setMobileQREnabled(mobileQREnabled)

Parameters:

mobileQREnabled

Since:

3.0.1

---

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

---

setOfficeOnlineEnabled(officeOnlineEnabled)

Parameters:

officeOnlineEnabled

Since:

3.0

---

setOfficeTextDirection(officeTextDirection)

Parameters:

officeTextDirection

Since:

2.0.3

---

setOpenDocFromOtherApp(openDocFromOtherApp)

Parameters:

openDocFromOtherApp

---

setOtherFeaturesDefaultRepository(defaultRepository)

Parameters:

defaultRepository

---

setOutlookPropertyRemembrance(outlookPropertyRemembrance)

Parameters:

outlookPropertyRemembrance

Since:

3.0

---

setOutlookUseEmailAddresses(outlookUseEmailAddresses)

Parameters:

outlookUseEmailAddresses

Since:

3.0.7

---

setOverwriteLocalOnCheckout(overwriteLocalOnCheckout)

Parameters:

overwriteLocalOnCheckout

---

setPasswordRulesUrl(passwordRulesUrl)

Parameters:

passwordRulesUrl

---

setPluginIds(pluginIds)

Parameters:

pluginIds

Since:

2.0.3.7

---

setPreventCreateNewSearch(values)

Parameters:

values

---

setPreventCreateNewUnifiedSearch(values)

Parameters:

values

---

setPrintServiceEnabled(printServiceEnabled)

Parameters:

printServiceEnabled

Since:

3.0.2

---

setPromptCloseOfficeIfDocCheckout(promptCloseOffice)

Parameters:

promptCloseOffice

---

setPromptForPropsOnAdd(promptForPropsOnAdd)

Parameters:

promptForPropsOnAdd

---

setRedactionAddDocumentMode(value)

Parameters:

value

Deprecated:

3.0.1 Use setDocumentAddMode(value) instead.

Since:

2.0.3.7

---

setRedactionSaveMode(value)

Parameters:

value

Since:

2.0.3.7

---

setRibbonTabLabel(ribbonBarTitle)

Parameters:

ribbonBarTitle

Since:

2.0.3

---

setRoleBasedAdminEnabled(enabled)

Parameters:

enabled

Since:

3.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)

Parameters:

sharePointUrlData

---

setSharePointUrlIds(sharePointUrlIds)

Parameters:

sharePointUrlIds

Since:

2.0.3

---

setShareRepository(repository)

Parameters:

repository

Since:

2.0.3.5

---

setShowContentListCheckbox(showContentListCheckbox)

Parameters:

showContentListCheckbox

Since:

3.0.6

---

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

---

setShowOnlyRoleSecurity(values)

Parameters:

values

---

setShowPrimaryDocumentOnly(values)

Parameters:

values

---

setShowRoleSecurity(values)

Parameters:

values

---

setShowSecurity(showSecurity)

Parameters:

showSecurity

---

setShowSecurityInheritanceUI(showSecurityInheritanceUI)

Parameters:

showSecurityInheritanceUI

---

setShowStatusbar(showStatusbar)

Parameters:

showStatusbar

Since:

2.0.3

---

setShowThumbnails(showThumbnails)

Parameters:

showThumbnails

---

setShowViewFilmstrip(showViewFilmstrip)

Parameters:

showViewFilmstrip

---

setStreamlineEnabled(streamlineEnabled)

Parameters:

streamlineEnabled

Since:

2.0.3.8

---

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

---

setViewInDialog(values)

Parameters:

values

---

setWarning(isWarning)

Parameters:

isWarning

Since:

2.0.3.6

---

setWorkDefaultRepository(defaultRepository)

Parameters:

defaultRepository

---

updateFeaturesList(featuresData, featuresInterfaceTestData, callback, extraParams)

Parameters:

featuresData

featuresInterfaceTestData

callback

extraParams

---