Interface IDataSourceConfiguration

This helps a data source get configured. It manages all the properties which the data source will want to look up, as well as the LookUp engine which will perform the token resolution

Namespace: ToSic.Eav.DataSources

Assembly: ToSic.Eav.DataSources.dll

Syntax

[PublicApi_Stable_ForUseInYourCode]
public interface IDataSourceConfiguration

Properties

IsParsed

Tell us if the values have already been parsed or not. Ideal to check / avoid multiple calls to parse, which would just slow the system down.

Declaration

bool IsParsed { get; }

Property Value

Type	Description
System.Boolean

Item[String]

Quick read / add for values which the DataSource will use.

Declaration

string this[string key] { get; set; }

Parameters

Type	Name	Description
System.String	key	The property name/key, like SortOrder or similar

Property Value

Type	Description
System.String

LookUpEngine

The internal look up engine which manages value sources and will resolve the tokens

Declaration

ILookUpEngine LookUpEngine { get; }

Property Value

Type	Description
ILookUpEngine

Values

The values (and keys) used in the data source which owns this Configuration

Declaration

IDictionary<string, string> Values { get; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.String>

Methods

Parse()

Parse the values and change them so placeholders in the values are now the resolved value. This can only be called once - then the placeholder are gone. In scenarios where multiple parses are required, use the Parse(IDictionary) overload.

Declaration

void Parse()

Parse(IDictionary<String, String>)

This will parse a dictionary of values and return the result. It's used to resolve the values list without actually changing the values on the configuration object, in scenarios where multiple parses will be required.

Declaration

IDictionary<string, string> Parse(IDictionary<string, string> values)

Parameters

Type	Name	Description
System.Collections.Generic.IDictionary<System.String, System.String>	values

Returns

Type	Description
System.Collections.Generic.IDictionary<System.String, System.String>