SiteSettings.savePerformance (Method)
Saves the current site's performance settings.
Returns:
Void
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| option | PerformanceOption | Required | A number or constant specifying the current site's performance option, as follows: 0 ('author') - Creates the best authoring experience as the perceived time for publishing changes on an authoring server will be the fastest. However, this creates the worst read mode experience as all pages that include page indexes and custom elements will take longer to load since the element level cache file will need to be built. 1 ('read/edit') - Creates a mixed authoring experience. While Content Edits to existing pages will not take that long, all other edits will take longer to execute. The read mode experience should be acceptable as CommonSpot will not clear all of the page index and custom element cache files all of the time. This means that pages remain cached for longer. 2 ('read/author') - Creates a good authoring experience as page edits and other content changes do not take a long time to execute. The read mode experience may be slightly worse than with 'read/edit', depending on how many content changes other than existing page edits are performed. 2 ('read') - Creates the worst authoring experience as each content edit takes longer to execute as all page index and custom element queries are run. However, it provides the best read mode performance as page index and custom element cache clears are minimized. 3 ('custom') - Provides the best performance for reading, editing, and creating new content. No automatic updates are done for page indexes or custom elements, so custom code and/or background jobs are required to keep them up-to-date. |
| avgAuthorModePageLoadTime | NonNegativeInteger | Required | If CommonSpot is in author mode, this is the average time in seconds that CommonSpot takes to reload a page. |
Context:
| License Requirements | None |
| Permission Requirements | site:SiteAdmin |
| Deny Context | None |
| Require Context | AuthoringEnabled |
| Author Lock | (not required) |
| Transaction Logging | If transaction logging is enabled at the site level, calls to this method will be logged |
| Customization | Customization is not supported for this method. |
Error Codes:
None
Notes:
None