Page.rename (Method)

Renames the specified page.

Returns:

FileName_ValidURL_EmptyString (specialcase)

Arguments:

Name Type Required Description
id RealPageID_NonBaseTemplate Required A page's ID.
name PageName Required The name of the page.
title PlainText_255 Optional. Defaults to an empty string. The internal CommonSpot title of the page. If an empty string the title will not be changed.
caption PlainText_255 Optional. Defaults to an empty string. The title and title bar caption of the page. If an empty string will not be changed.
description String Optional. Defaults to an empty string. The description of the page.
addPermanentRedirect Boolean Optional. Defaults to '1'. Boolean flag which when set indicates that a permanent redirect entry will be added.
rebuildCache Boolean Optional. Defaults to 'true'. True (default) indicates that cache should be rebuilt and the page reindexed after saving updates. If false, cache will be invalidated but not rebuilt, and no reindex operation will be initiated.

Context:

License Requirements None
Permission Requirements page:Admin
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 This method may be customized at the site level

Error Codes:

Code Error Message
1000400 The length of the name cannot exceed $1 characters.
1000401 The length of the title cannot exceed $1 characters.
1000402 The title bar caption and the page title cannot be same.
1000410 Another CommonSpot content object with the specified $1 already exists.

Notes:

None