IUrlMap Interface |
Represents a collection of a Page's URLs on a specific Publishing Target.
Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
SyntaxThe IUrlMap type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Archived |
Gets/sets the archived value of this entity
(Inherited from IEntity.) |
| Created |
Gets the entity's creation date.
(Inherited from IEntity.) |
| CreationUser |
Gets the ID of the User who created this entity.
(Inherited from IEntity.) |
| LastModified |
Gets the date when the entity was most recently modified.
(Inherited from IEntity.) |
| LastModifiedUser |
Gets the ID of the User who lasted edited the entity.
(Inherited from IEntity.) |
| Manager |
Gets the manager that retrieved this entity instance.
(Inherited from IEntityTManager.) |
| PublishingTargetID |
Gets the ID of the Publishing Target to which this collection belongs.
(Inherited from IPathMap.) |
| Session |
Gets the session that retrieved this entity. An entity is always session-specific.
(Inherited from IEntity.) |
| SessionId |
Gets the unique ID of the session that retrieved this entity.
(Inherited from IEntity.) |
Methods| Name | Description | |
|---|---|---|
 | AddOrUpdateCustomUrl |
Add or update the url map entry with a new custom path.
|
| Archive |
Archive the specified path map entries.
(Inherited from IPathMap.) |
| Delete |
Delete the specified path map entries.
(Inherited from IPathMap.) |
| Item |
Returns the IUrlMapPageEntry for the requested content item
|
| ItemByID |
Returns the IUrlMapPageEntry for the requested content ID
|
| ItemByPath |
Returns the IUrlMapPageEntry for the requested content path
|
 | Rebuild(String, Boolean, IStructuredUrlSettings, IUser, Boolean) |
Rebuilds the complete collection of URL maps and outputs the resulting XML file to a specific location.
|
| Rebuild(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.
|
| Touch |
Updated the entity's LastModified value to the current time.
(Inherited from IEntity.) |
| UnArchive |
Unarchive the specified path map entries.
(Inherited from IPathMap.) |
| ValidateData |
Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity.) |
| ValidateUserPermission |
Validates the user permission on the current entity. Implemented by concrete inheriting types.
It is called automatically upon saving an entity.
(Inherited from IEntity.) |
Events| Name | Description | |
|---|---|---|
 | AfterEntitySave |
This event is fired after a Entity object is saved.
(Inherited from IEntityEvents.) |
| BeforeEntitySave |
This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents.) |
See Also