Click or drag to resize

IUrlMapAddOrUpdateCustomUrl Method


Add or update the url map entry with a new custom path.

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
Syntax
IUrlMapPageHistoryEntry AddOrUpdateCustomUrl(
	string action,
	IPage page,
	string newPath,
	string originalPath = "",
	EnumUrlMapPageHistoryType type = EnumUrlMapPageHistoryType.Custom,
	bool canonical = false,
	bool requireSSL = false
)

Parameters

action
Type: SystemString
add, move, edit, or delete
page
Type: Ingeniux.CMSIPage
CMS IPage object to operate on
newPath
Type: SystemString
New SURL path for the page
originalPath (Optional)
Type: SystemString
Original path (if moving)
type (Optional)
Type: Ingeniux.CMS.EnumsEnumUrlMapPageHistoryType
Type of url entry, usually Custom
canonical (Optional)
Type: SystemBoolean
If this new custom url is to be treated as the current primary SURL
requireSSL (Optional)
Type: SystemBoolean
Require custom URL to be HTTPS

Return Value

Type: IUrlMapPageHistoryEntry
Returns the urlmap entry for the new Custom URL
See Also