Describes the interface for the plugin that can be used to compare a file during the publish operation.
void Initialize(IPublishCompareConfiguration configuration)
-
Initialize and validate all parameters and objects (e.g. LogService) used by the plugin
PublishCompareResult CompareXml(IshType ishType, string currentVersionFilePath, string compareVersionFilePath, string resultFilePath)
-
Compares 2 XML content files.
-
Note: The currentVersionFilePath or compareVersionFilePath can contain an empty string to indicate the file is not present in that version.
-
Note: The
PublishCompareResult can have the following values:
- Unchecked: The initial value before the files are compared
- Unchanged: There are no differences between the 2 files
- Changed: There are differences between the 2 files
- New: There was no matching file in the compare/old version. So, this is a new file
- Deleted: There is no matching file in the current version. So, the file is deleted
- Failed: An error occurred during the compare
PublishCompareResult CompareMetadata(IshType ishType, string currentVersionMetadataFilePath, string compareVersionMetadataFilePath, string resultMetadataFilePath)
-
Compares 2 XML metadata files.
-
Note: The currentVersionMetadataFilePath or compareVersionMetadataFilePath can contain an empty string to indicate the file is not present in that version.
-
Note: The
PublishCompareResult can have the following values:
- Unchecked: The initial value before the files are compared
- Unchanged: There are no differences between the 2 files
- Changed: There are differences between the 2 files
- New: There was no matching file in the compare/old version. So, this is a new file
- Deleted: There is no matching file in the current version. So, the file is deleted
- Failed: An error occurred during the compare