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
)
Function AddOrUpdateCustomUrl (
action As String,
page As IPage,
newPath As String,
Optional originalPath As String = "",
Optional type As EnumUrlMapPageHistoryType = EnumUrlMapPageHistoryType.Custom,
Optional canonical As Boolean = false,
Optional requireSSL As Boolean = false
) As IUrlMapPageHistoryEntry
IUrlMapPageHistoryEntry^ AddOrUpdateCustomUrl(
String^ action,
IPage^ page,
String^ newPath,
String^ originalPath = L"",
EnumUrlMapPageHistoryType type = EnumUrlMapPageHistoryType::Custom,
bool canonical = false,
bool requireSSL = false
)
abstract AddOrUpdateCustomUrl :
action : string *
page : IPage *
newPath : string *
?originalPath : string *
?type : EnumUrlMapPageHistoryType *
?canonical : bool *
?requireSSL : bool
(* Defaults:
let _originalPath = defaultArg originalPath ""
let _type = defaultArg type EnumUrlMapPageHistoryType.Custom
let _canonical = defaultArg canonical false
let _requireSSL = defaultArg requireSSL false
*)
-> IUrlMapPageHistoryEntry
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:
IUrlMapPageHistoryEntryReturns the
urlmap entry for the new Custom URL
See Also