Click or drag to resize

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.492
Syntax
public interface IUrlMap : IEntity<IPublishingManager>, 
	IEntity, IEntityEvents, IPathMap

The IUrlMap type exposes the following members.

Properties
 NameDescription
Public propertyArchived Gets/sets the archived value of this entity
(Inherited from IEntity)
Public propertyCreated Gets the entity's creation date.
(Inherited from IEntity)
Public propertyCreationUser Gets the ID of the User who created this entity.
(Inherited from IEntity)
Public propertyLastModified Gets the date when the entity was most recently modified.
(Inherited from IEntity)
Public propertyLastModifiedUser Gets the ID of the User who lasted edited the entity.
(Inherited from IEntity)
Public propertyManager Gets the manager that retrieved this entity instance.
(Inherited from IEntityTManager)
Public propertyPublishingTargetID Gets the ID of the Publishing Target to which this collection belongs.
(Inherited from IPathMap)
Public propertySession Gets the session that retrieved this entity. An entity is always session-specific.
(Inherited from IEntity)
Public propertySessionId Gets the unique ID of the session that retrieved this entity.
(Inherited from IEntity)
Top
Methods
 NameDescription
Public methodAddOrUpdateCustomUrl Add or update the url map entry with a new custom path.
Public methodArchive Archive the specified path map entries.
(Inherited from IPathMap)
Public methodClearAliasEntries Delete all alias entries.
Public methodDelete Delete the specified path map entries.
(Inherited from IPathMap)
Public methodItem Returns the IUrlMapPageEntry for the requested content item
Public methodItemByID Returns the IUrlMapPageEntry for the requested content ID
Public methodItemByPath Returns the IUrlMapPageEntry for the requested content path
Public methodItemsByAliasedContentId 
Public methodCode exampleRebuild(String, Boolean, IStructuredUrlSettings, IUser, Boolean, DictionaryString, AliasMetaData) Rebuilds the complete collection of URL maps and outputs the resulting XML file to a specific location.
Public methodCode exampleRebuild(String, Boolean, IStructuredUrlSettings, IUser, DictionaryString, Int32, Boolean, String, DictionaryString, AliasMetaData) Rebuilds the complete collection of URL maps and outputs the XML file to a specific location, with an explicitly specified list of marked Pages.
Public methodTouch Updated the entity's LastModified value to the current time.
(Inherited from IEntity)
Public methodUnArchive Unarchive the specified path map entries.
(Inherited from IPathMap)
Public methodValidateData Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity)
Public methodValidateUserPermission Validates the user permission on the current entity. Implemented by concrete inheriting types. It is called automatically upon saving an entity.
(Inherited from IEntity)
Top
Events
 NameDescription
Public eventAfterEntitySave This event is fired after a Entity object is saved.
(Inherited from IEntityEvents)
Public eventBeforeEntitySave This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents)
Top
See Also