View Source

Interface IDataTypeConfigurationConnector

Defines methods that can convert data type configuration to and 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. It can also contain references to other deployable artifacts, that need to be tracked as dependencies.

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, IContextCache)

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

Declaration

IDictionary<string, object> FromArtifact(IDataType dataType, string configuration, IContextCache contextCache)

Parameters

Type	Name	Description
IDataType	dataType	The data type.
System.String	configuration	The artifact configuration value.
IContextCache	contextCache	The context cache.

Returns

Type	Description
IDictionary<System.String, System.Object>	The data type configuration.

FromArtifactAsync(IDataType, String, IContextCache, CancellationToken)

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

Declaration

virtual Task<IDictionary<string, object>> FromArtifactAsync(IDataType dataType, string configuration, IContextCache contextCache, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IDataType	dataType	The data type.
System.String	configuration	The artifact configuration value.
IContextCache	contextCache	The context cache.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IDictionary<System.String, System.Object>>	A task that represents the asynchronous operation. The task result contains the data type configuration.

ToArtifact(IDataType, ICollection<ArtifactDependency>, IContextCache)

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

Declaration

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

Parameters

Type	Name	Description
IDataType	dataType	The data type.
ICollection<ArtifactDependency>	dependencies	The dependencies.
IContextCache	contextCache	The context cache.

Returns

Type	Description
System.String	The artifact configuration value.

ToArtifactAsync(IDataType, ICollection<ArtifactDependency>, IContextCache, CancellationToken)

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

Declaration

virtual Task<string> ToArtifactAsync(IDataType dataType, ICollection<ArtifactDependency> dependencies, IContextCache contextCache, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IDataType	dataType	The data type.
ICollection<ArtifactDependency>	dependencies	The dependencies.
IContextCache	contextCache	The context cache.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<System.String>	A task that represents the asynchronous operation. The task result contains the artifact configuration value.