Class SerializationConfiguration

DataSource which changes how Streams will be serialized in the end.

Inheritance
System.Object
ToSic.Lib.Services.ServiceBase
ToSic.Lib.Services.ServiceBase<DataSourceBase.MyServices>
DataSourceBase
SerializationConfiguration
Inherited Members
Namespace: ToSic.Eav.DataSources
Assembly: ToSic.Eav.DataSources.dll
Syntax
[PublicApi_Stable_ForUseInYourCode]
[VisualQuery(NiceName = "Serialization Configuration", UiHint = "Determine how this data is Serialized", Icon = "settings_ethernet", Type = DataSourceType.Modify, NameId = "2952e680-4aaa-4a12-adf7-325cb2854358", DynamicOut = true, In = new string[]{"Default"}, ConfigurationType = "5c84cd3f-f853-40b3-81cf-dee6a07dc411", HelpLink = "https://r.2sxc.org/DsSerializationConfiguration")]
public class SerializationConfiguration : DataSourceBase, IDataSource, IDataSourceSource, IAppIdentity, IZoneIdentity, IAppIdentityLight, ICacheInfo, ICacheKey, ICacheExpiring, ITimestamped, ICanPurgeListCache, IHasLog, IDataSourceTarget, IDataTarget, IDataSourceShared, IAppIdentitySync, IDataSourceLinkable
Remarks

Properties

| Improve this Doc View Source

DropFalseValues

todo

Declaration
[Configuration(Field = "RemoveFalseValues")]
public string DropFalseValues { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IncludeAppId

Should the AppId be included in serialization. Especially for scenarios where data is retrieved from multiple Apps

Declaration
[Configuration]
public string IncludeAppId { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IncludeCreated

Should the Created date be included in serialization

Declaration
[Configuration]
public string IncludeCreated { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IncludeGuid

Should the GUID be included in serialization

Declaration
[Configuration]
public string IncludeGuid { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IncludeId

Should the ID be included in serialization

Declaration
[Configuration]
public string IncludeId { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IncludeMetadata

Should the Metadata ID be included in serialization

Declaration
[Configuration]
public string IncludeMetadata { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IncludeMetadataFor

Should the Metadata target/for information be included in serialization

Declaration
[Configuration]
public string IncludeMetadataFor { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IncludeMetadataForId

Should the Metadata target/for information be included in serialization

Declaration
[Configuration]
public string IncludeMetadataForId { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IncludeMetadataForType

Should the Metadata target/for information be included in serialization

Declaration
[Configuration]
public string IncludeMetadataForType { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IncludeMetadataGuid

Should the Metadata GUID be included in serialization

Declaration
[Configuration]
public string IncludeMetadataGuid { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IncludeMetadataId

Should the Metadata ID be included in serialization

Declaration
[Configuration]
public string IncludeMetadataId { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IncludeMetadataTitle

Should the default Title of the Metadata be included as "Title" in serialization

Declaration
[Configuration]
public string IncludeMetadataTitle { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IncludeModified

Should the Modified date be included in serialization

Declaration
[Configuration]
public string IncludeModified { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IncludeRelationshipGuid

Should the Relationship GUID be included in serialization

Declaration
[Configuration]
public string IncludeRelationshipGuid { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IncludeRelationshipId

Should the Relationship ID be included in serialization

Declaration
[Configuration]
public string IncludeRelationshipId { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IncludeRelationships

Should the Relationships be included in serialization

Declaration
[Configuration]
public string IncludeRelationships { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IncludeRelationshipsAsCsv

Should the Relationships be included as CSV like "42,27,999". Default is false in which case they are sub-objects.

Declaration
[Configuration(Fallback = false)]
public string IncludeRelationshipsAsCsv { get; }
Property Value
Type Description
System.String
Remarks

WIP / adding in v15.03

| Improve this Doc View Source

IncludeRelationshipTitle

Should the default Title of the Relationship be included as "Title" in serialization

Declaration
[Configuration]
public string IncludeRelationshipTitle { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IncludeTitle

Should the default Title be included as "Title" in serialization

Declaration
[Configuration]
public string IncludeTitle { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IncludeZoneId

Should the AppId be included in serialization. Especially for scenarios where data is retrieved from multiple Apps

Declaration
[Configuration]
public string IncludeZoneId { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Out

Gets the Dictionary of Out-Streams. This is the internal accessor, as usually you'll use this["name"] instead.
In rare cases you need the Out, for example to list the stream names in the data source.

Declaration
public override IDictionary<string, IDataStream> Out { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, IDataStream>

A dictionary of named IDataStream objects
Overrides
| Improve this Doc View Source

RemoveEmptyStrings

todo

Declaration
[Configuration(Field = "RemoveEmptyStringValues")]
public string RemoveEmptyStrings { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

RemoveNullValues

todo

Declaration
[Configuration]
public string RemoveNullValues { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

RemoveZeroValues

todo

Declaration
[Configuration]
public string RemoveZeroValues { get; }
Property Value
Type Description
System.String

Implements