Redirects (Component)

The Redirects object manages the URL redirects. If redirects is enabled permanent redirects are automatically created when page or document is moved or renamed, or a subsite is renamed. Redirects can also be created manually for Legacy URL and Vanity URL using this component.

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

Methods marked below with [C] may be customized at the site level

Methods:

checkURL [C] Given the original URL, returns a structure with the redirect information.
create [L] [C] Creates a new redirect entry and returns its unique id.
delete [L] [C] Deletes one or more specified redirect entries.
deleteExpired [L] [C] Deletes all expired redirect entries.
enableSupport [L] [C] Enables the redirect support for the current site.
getList [C] Returns zero or more records describing the existing redirect entries, based on the passed filter criteria.
getListForPage [C] Returns zero or more records describing the existing redirect entries for the specified page.
isEnabled [C] Returns true if the redirect support is enabled for the current site, otherwise false.
updateAuto [L] [C] Updates an existing automatically created redirect entry.
updateManual [L] [C] Updates an existing manually created redirect entry.