IContentConverter Plugin Type

Ben Tiedt — Tue, 19 Nov 2019 19:35:19 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 19:35:19

Obsolete. Use the Version3 implementation of IContentConverter instead.

Plugin that enables programmatic conversion between content types

IContentConverter is defined in the Telligent.Evolution.Extensibility.ContentConversion.Version1 namespace of Telligent.Evolution.Platform.dll

Definition

interface IContentConverter : [[IPlugin Plugin Type|IPlugin]]
{
	Guid SourceContentTypeId { get;  }
	Guid TargetContentTypeId { get;  }
	Guid Convert(Guid sourceContentId, Guid targetApplicationId, IDictionary options);
}

Properties

Name	Type	Description	Default	Options
SourceContentTypeId	`Guid`	Content Type Id to convert from
TargetContentTypeId	`Guid`	Content Type Id to convert to

Methods

Guid Convert(Guid sourceContentId, Guid targetApplicationId, IDictionary options);

Implements conversion from SourceContentTypeId to TargetContentTypeId for a given piece of content. Content ID of newly converted content.

Parameters

Name	Type	Description	Required
sourceContentId	`Guid`	Source content to convert	Required
targetApplicationId	`Guid`	Target application for resulting new content	Required
options	`IDictionary`	Optional extra parameters	Required

Return Type

Guid

Extensions

[[IConfigurableContentConverter Plugin Type|IConfigurableContentConverter]]
[[ISecuredContentConverter Plugin Type|ISecuredContentConverter]]
[[IValidatableContentConverter Plugin Type|IValidatableContentConverter]]