IFileReplicationTarget Interface |
Represents a file location for published files to be replicated to, as well as corresponding settings for this location.
Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
SyntaxThe IFileReplicationTarget type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Archived |
Gets/sets the archived value of this entity
(Inherited from IEntity.) |
| ChangeDetectionOnContent |
Gets/sets a true or false value indicating whether to compare file content before replication.
|
| Created |
Gets the entity's creation date.
(Inherited from IEntity.) |
| CreationUser |
Gets the ID of the User who created this entity.
(Inherited from IEntity.) |
| Description |
Gets and sets the detailed description of this target.
(Inherited from IReplicationTarget.) |
| Disabled |
Gets and sets whether this target is disabled. Disabled targets cannot perform replications.
(Inherited from IReplicationTarget.) |
| ImpersonatePassword |
Gets/sets the password of the user with access to the UNC path.
|
 | ImpersonateUserDomain |
Gets/sets the domain name of the shared location for the UNC path.
|
| ImpersonateUserName |
Gets/sets the name of the user with access to the UNC path.
|
| 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.) |
| PostReplicationCommand |
Gets and sets the commands that are executed after replication on this target. Use standard Command Prompts (DOS) command syntax.
(Inherited from IReplicationTarget.) |
| PostReplicationCommandTimeout |
Gets and sets the timeout (in seconds) for PostReplicationCommand.
(Inherited from IReplicationTarget.) |
| PreReplicationCommand |
Gets and sets the commands that are executed before replication on this target. Uses standard Command Prompts (DOS) command syntax.
(Inherited from IReplicationTarget.) |
| PreReplicationCommandTimeout |
Gets and sets the timeout (in seconds) for PreReplicationCommand.
(Inherited from IReplicationTarget.) |
| PublishingTargetDirectory |
Gets the full path of the Publishing Target Folder to which this replication target belongs.
(Inherited from IReplicationTarget.) |
| Replicating |
Gets whether this target is currently performing a replication.
(Inherited from IReplicationTarget.) |
| RepTaskDetails |
Gets the details of the last-completed replication.
(Inherited from IReplicationTarget.) |
| RepTaskMonitor |
Gets the Monitor object that tracks an ongoing replication. This object will stick around.
(Inherited from IReplicationTarget.) |
| 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.) |
| TargetLocation |
Gets/sets the file path where published content will be replicated to.
|
| Type |
Gets the full Type name of the target.
(Inherited from IReplicationTarget.) |
| UseCommands |
Gets and sets whether to execute the PreReplicationCommand and
PostReplicationCommand.
(Inherited from IReplicationTarget.) |
| UseImpersonation |
Gets/sets a true or false value indicating whether to connect to a universal naming convention (UNC) path using a different user account. The default value is false.
|
| UseWriteThrough |
Gets and sets if the system should write through any intermediate cache and go directly to disk during replication.
(Inherited from IReplicationTarget.) |
Methods| Name | Description | |
|---|---|---|
 | AddAdditionalLocation |
Adds a new Additional Location to this replication target.
(Inherited from IReplicationTarget.) |
| AddCleanupExemption |
Adds a new Cleanup Exempt Location to this replication target.
(Inherited from IReplicationTarget.) |
| AddExemptLocation |
Adds a new Exempt Location to this replication target.
(Inherited from IReplicationTarget.) |
| AdditionalLocations |
Retrieves the collection of Additional Locations for this replication target, in a paginated fashion.
(Inherited from IReplicationTarget.) |
| AdditionalLocationsCount |
Gets the count of Additional Locations for this replication target.
(Inherited from IReplicationTarget.) |
| CancelReplication |
Cancels an ongoing replication and updates the Task Monitor to the cancelled state.
(Inherited from IReplicationTarget.) |
| CleanReplicate |
Performs a replication that removes all Files from the replication destination that no longer exist in the
Publishing Target Folder.
(Inherited from IReplicationTarget.) |
| CleanupExemptLocations |
Retrieves the collection of Cleanup Exempt Locations for this replication target, in a paginated fashion.
(Inherited from IReplicationTarget.) |
| CleanupExemptLocationsCount |
Gets the count of Cleanup Exempt Locations for this replication target.
(Inherited from IReplicationTarget.) |
| ClearExemptionAndAdditionalLocations | (Inherited from IReplicationTarget.) |
| ExemptLocations |
Retrieves the collection of Exempt Locations for this Replication Target, in a paginated fashion.
(Inherited from IReplicationTarget.) |
| ExemptLocationsCount |
Gets the count of Exempt Locations for this replication target.
(Inherited from IReplicationTarget.) |
| Replicate |
Performs replication on this target.
(Inherited from IReplicationTarget.) |
| SetExclusiveReplicateItems |
Sets the files to be replicated, besides the Additional Locations.
Once this method is called, these are the only files from the Publishing Target Folder
that will be replicated.
(Inherited from IReplicationTarget.) |
| 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.) |
Remarks
Only file replication targets have Impersonation Settings.
You can use Impersonation Settings to connect to the universal naming convention (UNC) path with a different user account.
See Also