Click or drag to resize

IReplicator Interface


Represents the replication mechanism of a Publishing Target. The Replicator object itself contains the collection of Replication Targets and is in charge of managing them.

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.3.169
Syntax
public interface IReplicator : IEntity<IPublishingManager>, 
	IEntity, IEntityEvents

The IReplicator type exposes the following members.

Properties
  NameDescription
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 propertyDoReplication
Gets and sets whether to enable replication for this replicator.
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 propertyName
Gets and sets the entity's name.
(Inherited from IEntity.)
Public propertyPublishingTargetDirectory
Gets the full path to the folder of the publishing target to which this replicator belongs.
Public propertyPublishingTargetFolderName
Gets the Folder name of the Publishing Target to which this replicator belongs.
Public propertyPublishingTargetName
Gets the name of the Publishing Target to which this replicator belongs.
Public propertyReplicationCompleted
Gets whether all Replication Targets that belong to this replicator have finished replicating.
Public propertyReplicationStarted
Gets whether the replication has started on this replicator
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.)
Public propertySimultaneousReplication
Gets and sets whether to simultaneously or sequentially perform replications on its Targets.
Public propertyStartTime
Gets the Starting Date/Time of last-submitted replication task.
Public propertySubmitUserID
Gets of the user ID of the User that last submitted a publishing or replication task.
Top
Methods
  NameDescription
Public methodAddTarget
Adds a new Replication Target to collection.
Public methodCancelReplication
Cancels all replications.
Public methodCancelReplicationSession
Cancels replication for a specific Replication Target.
Public methodClear
Removes all Replication Targets from collection.
Public methodRemoveTarget
Removes a Replication Target from collection.
Public methodReorderTargets
Reorder the sequence of Replicator Targets in the collection. When this replicator is configured to replicate sequentially, this method affects which Target performs replication first.
Public methodReplicate
Starts replication on all Replication Targets.
Public methodReplicationTaskMonitors
Retrieves the collection of monitor objects for the Replication Targets that belongs to this replicator, in a paginated fashion.
Public methodTarget
Retrieves a Replicator Target by its unique ID.
Public methodTargetCount
Gets the count of the collection of Replication Targets that belong to this replicator.
Public methodTargets
Retrieves the collection of Replication Targets that belongs to this replicator, in a paginated fashion.
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