IUrlMapRebuild Method (String, Boolean, IStructuredUrlSettings, IUser, DictionaryString, Int32, Boolean, String)
|
Rebuilds the complete collection of URL maps and outputs the XML file to a specific location, with an explicitly specified list of marked
Pages.
Namespace:
Ingeniux.CMS
Assembly:
Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
Syntax void Rebuild(
string publishFolder,
bool primeTarget,
IStructuredUrlSettings surlSettings,
IUser user,
Dictionary<string, int> markedPages,
bool incremental = false,
string publishingTargetId = ""
)
Sub Rebuild (
publishFolder As String,
primeTarget As Boolean,
surlSettings As IStructuredUrlSettings,
user As IUser,
markedPages As Dictionary(Of String, Integer),
Optional incremental As Boolean = false,
Optional publishingTargetId As String = ""
)
void Rebuild(
String^ publishFolder,
bool primeTarget,
IStructuredUrlSettings^ surlSettings,
IUser^ user,
Dictionary<String^, int>^ markedPages,
bool incremental = false,
String^ publishingTargetId = L""
)
abstract Rebuild :
publishFolder : string *
primeTarget : bool *
surlSettings : IStructuredUrlSettings *
user : IUser *
markedPages : Dictionary<string, int> *
?incremental : bool *
?publishingTargetId : string
(* Defaults:
let _incremental = defaultArg incremental false
let _publishingTargetId = defaultArg publishingTargetId ""
*)
-> unit
Parameters
- publishFolder
- Type: SystemString
The full path of the Folder in which to place the generated URL map XML file - primeTarget
- Type: SystemBoolean
Determines the name of the URL map XML file. When true, the file name is just "urlmap.xml"; when false, the file name is this entity's unique ID plus ".xml" - surlSettings
- Type: Ingeniux.CMSIStructuredUrlSettings
The structured URL settings. These typically come from the Publishing Target that
this collection belongs to. Exposed as parameter so it can be customized. - user
- Type: Ingeniux.CMSIUser
The User that will perform the rebuild - markedPages
- Type: System.Collections.GenericDictionaryString, Int32
Dictionary of marked Pages for the given Publishing Target.
The keys of the dictionary are xIDs; the values are marked version numbers. - incremental (Optional)
- Type: SystemBoolean
Whether the rebuild is incremental or full - publishingTargetId (Optional)
- Type: SystemString
ID of the publishing target being rebuilt for to properly fetch marked version names in SURL generation
Remarks
The generated URL maps file will be placed in the App_Data/pub/[pub target folder]/settings folder.
Examples
Generated urlmap.xml example:
<?xml version="1.0" encoding="utf-8"?>
<Site HomePageID="x2" ForceLowerCaseURL="false" AutoRedirectCanonicalURL="true" EnabledExtensions="" URLExtension="" UseStructuredURL="true">
<Page ID="x11" Path="/Champlain" Schema="CaseStudy" />
<Page ID="x12" Path="/Mica" Schema="CaseStudy" />
<Page ID="x13" Path="/Midwestern" Schema="CaseStudy" />
<Page ID="x14" Path="/Company/News" Schema="NewsandEventsFront" />
<Page ID="x15" Path="/Company/News/News-Archive" Schema="NewsArchive" />
<Page ID="x17" Path="/Company/News/News-Archive/Ingeniux-Announces-Dates-for-2014-User-Conference" Schema="NewsDetail" />
<Page ID="x2" Path="/" Schema="Home" />
<Page ID="x28" Path="/Company" Schema="SectionDetail" />
<Page ID="x34" Path="/Products" Schema="ProductFront" />
<Page ID="x35" Path="/Products/Cartella-x35" Schema="ProductDetail">
<Renamed Path="/Products/Cartella" Canonical="true" />
</Page>
<Page ID="x41" Path="/Solutions" Schema="SolutionsFront" />
<Page ID="x43" Path="/Products/Cartella-x43" Schema="ProductDetail" />
<Page ID="x44" Path="/Products/CMS" Schema="ProductDetail" />
<Page ID="x47" Path="/Solutions/Mainstream" Schema="SolutionsDetail" />
</Site>
See Also