SiteSettings (Component)

The SiteSettings object lets you save and return information on site properties. Examples are page properties, performance characteristics and reporting, the root URL, transaction log, and UI scalability.

Methods marked below with [L] may be logged at the site level (if transaction logging is licensed and enabled by the administrator)

Customization is not supported for this component.

Methods:

getCachedQueriesCounts	Returns the counts of cached queries such as page index queries, custom element queries, etc.
getCacheProperties	Returns the default cache properties for the site.
getCaptchaSettings	Returns a structure describing the settings for captcha fields.
getEditorLocation	Returns structure containing the server relative path and physical directory to editor.js file downloaded from ckeditor.
getMisc	Returns a structure that contains information on the current site settings; for example, emailing log entries, retaining usage information, publication content approval, and so on.
getPagePropsUI	Returns a structure the describes UI Properties settings for the Page Creation dialog box.
getPerformance	Returns a structure the describes the site's performance settings.
getPerformanceReporting	Returns a Boolean flag indicating is performance reporting is enabled for the current user on the current site.
getRegisteredURLPropsUI	Returns a structure containing information on the UI Properties settings for the registered URL dialog box.
getUIScalability	Returns a structure containing information about this site's UI scalability settings.
getUploadedDocPropsUI	Returns a SiteSettings_GetNonPagePropsUI_Result structure containing information about UI Properties settings for the Uploaded Document dialog box.
getWebPImageConversionSettings	Returns a structure describing the default settings for WebP image support.
saveCacheProperties [L]	Saves the default cache properties for the site.
saveCaptchaSettings [L]	Saves the settings for captcha fields.
saveEditorLocation [L]	Saves the path and directory of ckeditor.js file to access ckeditor.
saveMisc [L]	Saves miscellaneous settings for the site such at retaining usage logs, allowing images to be resized, and so on.
savePagePropsUI [L]	Saves a site's page creation UI settings.
savePerformance [L]	Saves the current site's performance settings.
saveRegisteredURLPropsUI [L]	Saves the UI settings for the Registered URL dialog box.
saveUIScalability [L]	Saves the current site's UI scalability settings.
saveUploadedDocPropsUI [L]	Saves UI settings information for the Uploaded Document dialog box. This information defines the UI properties that CommonSpot displays.
saveWebPImageConversionSettings [L]	Saves the default site-wide settings for WebP image support.
setPerformanceReporting [L]	Either enables or disables performance reporting for the current user on the current site.