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.6.308
SyntaxThe IReplicator 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.) |
| DoReplication |
Gets and sets whether to enable replication for this replicator.
|
| 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.) |
| PublishingTargetDirectory |
Gets the full path to the folder of the publishing target to which this replicator belongs.
|
| PublishingTargetFolderName |
Gets the Folder name of the Publishing Target to which this replicator belongs.
|
| PublishingTargetName |
Gets the name of the Publishing Target to which this replicator belongs.
|
| ReplicationCompleted |
Gets whether all Replication Targets that belong to this replicator have finished replicating.
|
| ReplicationStarted |
Gets whether the replication has started on this replicator
|
| 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.) |
| SimultaneousReplication |
Gets and sets whether to simultaneously or sequentially perform replications on its Targets.
|
| StartTime |
Gets the Starting Date/Time of last-submitted replication task.
|
| SubmitUserID |
Gets of the user ID of the User that last submitted a publishing or replication task.
|
Methods| Name | Description | |
|---|---|---|
 | AddTarget |
Adds a new Replication Target to collection.
|
| CancelReplication |
Cancels all replications.
|
| CancelReplicationSession |
Cancels replication for a specific Replication Target. |
| Clear |
Removes all Replication Targets from collection.
|
| RemoveTarget |
Removes a Replication Target from collection.
|
| ReorderTargets |
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.
|
| Replicate |
Starts replication on all Replication Targets.
|
| ReplicationTaskMonitors |
Retrieves the collection of monitor objects for the Replication Targets that belongs to this replicator,
in a paginated fashion.
|
| Target |
Retrieves a Replicator Target by its unique ID.
|
| TargetCount |
Gets the count of the collection of Replication Targets that belong to this replicator.
|
| Targets |
Retrieves the collection of Replication Targets that belongs to this replicator, in a paginated fashion.
|
| Touch |
Updated the entity's LastModified value to the current time.
(Inherited from IEntity.) |
| 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