Plugin that enables programmatic conversion between applications
IApplicationMerger
is defined in the Telligent.Evolution.Extensibility.ApplicationMerge.Version2
namespace of Telligent.Evolution.Platform.dll
Definition
interface IApplicationMerger : IPlugin { Guid SourceApplicationTypeId { get; } Guid TargetApplicationTypeId { get; } PropertyGroup[] GetMergeOptions(Guid sourceApplicationId, Guid targetApplicationId); bool Merge(Guid sourceApplicationTypeId, Guid sourceApplicationId, Guid targetApplicationId, Guid targetApplicationTypeId, IDictionary options); bool Validate(Guid sourceApplicationId); }
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
SourceApplicationTypeId | Guid | Application Type Id to convert from | ||
TargetApplicationTypeId | Guid | Application Type Id to convert to |
Methods
PropertyGroup[] GetMergeOptions(Guid sourceApplicationId, Guid targetApplicationId);
Configuration metadata
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
sourceApplicationId | Guid | Source application being merged into a target application. | Required | ||
targetApplicationId | Guid | Target application | Required |
Return Type
bool Merge(Guid sourceApplicationTypeId, Guid sourceApplicationId, Guid targetApplicationId, Guid targetApplicationTypeId, IDictionary options);
Implements conversion from SourceApplicationId to TargetApplicationId for all content withing the source application.
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
sourceApplicationTypeId | Guid | Source application type id | Required | ||
sourceApplicationId | Guid | Source application | Required | ||
targetApplicationId | Guid | Target application | Required | ||
targetApplicationTypeId | Guid | Target application type id | Required | ||
options | IDictionary | Optional extra parameters | Required |
Return Type
bool
bool Validate(Guid sourceApplicationId);
Implements validation of when the merger should be available for a given source and target application type id pair. When false, the merger is not returned when listing available target application types, even if source's application type matches.
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
sourceApplicationId | Guid | Source application id of the application to be merged into a target application. | Required |
Return Type
bool