SynchronizationInfoProvider.DeleteSynchronizationInfos Method

Deletes the synchronization info records. When serverId is specified, the siteId parameter is ignored. When siteId is specified and serverId is 0 method deletes records that belongs to all servers that are assigned to given site.

Namespace: CMS.Synchronization
Assembly: CMS.Synchronization (in CMS.Synchronization.dll) Version: 13.0.131

Syntax

public static void DeleteSynchronizationInfos(
	ICollection<int> taskIds,
	int serverId,
	int siteId,
	bool deleteFailedTasks = false
)

Parameters

taskIds

Type: System.Collections.Generic.ICollection<Int32>
Task IDs

serverId

Type: System.Int32
Server ID

siteId

Type: System.Int32
Site ID

deleteFailedTasks (Optional)

Type: System.Boolean
If set to false, failed synchronization records are not deleted.

Remarks

This site does not clean orphaned staging tasks. Call DeleteOrphanedTasks(ICollection<Int32>) if appropriate.