View Source

Interface IDataTypeConfigurationConnector

Defines methods that can convert data type configuration to / from an environment-agnostic string.

Namespace: Umbraco.Cms.Core.Deploy

Assembly: Umbraco.Core.dll

Syntax

public interface IDataTypeConfigurationConnector

Remarks

Configuration may contain values such as content identifiers, that would be local to one environment, and need to be converted in order to be deployed.

Properties

PropertyEditorAliases

Gets the property editor aliases that the value converter supports by default.

Declaration

IEnumerable<string> PropertyEditorAliases { get; }

Property Value

Type	Description
IEnumerable<System.String>	The property editor aliases.

Methods

FromArtifact(IDataType, String)

Gets the data type configuration corresponding to an artifact configuration value.

Declaration

object FromArtifact(IDataType dataType, string configuration)

Parameters

Type	Name	Description
IDataType	dataType	The data type.
System.String	configuration	The artifact configuration value.

Returns

Type	Description
System.Object	The data type configuration.

ToArtifact(IDataType, ICollection<ArtifactDependency>)

Gets the artifact configuration value corresponding to a data type configuration and gather dependencies.

Declaration

string ToArtifact(IDataType dataType, ICollection<ArtifactDependency> dependencies)

Parameters

Type	Name	Description
IDataType	dataType	The data type.
ICollection<ArtifactDependency>	dependencies	The dependencies.

Returns

Type	Description
System.String	The artifact configuration value.