• Basics
  • Abyss
  • Web APIs
  • C# & Razor
  • .net API
  • JS & TS API

    Show / Hide Table of Contents

    Class DataSourceErrorHelper

    An Errors-helper which is automatically available on all DataSource objects.

    It helps create a stream of standardized error entities.

    Inheritance
    System.Object
    DataSourceErrorHelper
    Namespace: ToSic.Eav.DataSources
    Assembly: ToSic.Eav.DataSources.dll
    Syntax
    [PublicApi]
    public class DataSourceErrorHelper

    Constructors

    | Improve this Doc View Source

    DataSourceErrorHelper(DataBuilder)

    Constructor - to find out if it's used anywhere

    Declaration
    public DataSourceErrorHelper(DataBuilder builder)
    Parameters
    Type Name Description
    ToSic.Eav.Data.Build.DataBuilder builder

    Methods

    | Improve this Doc View Source

    Create(String, String, String, Exception, IDataSource, String)

    Create a stream containing an error entity.

    Declaration
    public IImmutableList<IEntity> Create(string noParamOrder = "Params must be named (https://r.2sxc.org/named-params)", string title = null, string message = null, Exception exception = null, IDataSource source = null, string streamName = "Default")
    Parameters
    Type Name Description
    System.String noParamOrder

    see Convention: Named Parameters

    System.String title

    Error title

    System.String message

    Error message

    System.Exception exception

    Exception (if there was an exception)

    IDataSource source

    The DataSource which created this error. If provided, will allow the message to contain more details.

    System.String streamName

    The stream name. If provided, will allow the message to contain more details.

    Returns
    Type Description
    System.Collections.Immutable.IImmutableList<IEntity>
    | Improve this Doc View Source

    TryGetInFailed(IDataSource, String)

    Declaration
    public IImmutableList<IEntity> TryGetInFailed(IDataSource source = null, string streamName = "Default")
    Parameters
    Type Name Description
    IDataSource source
    System.String streamName
    Returns
    Type Description
    System.Collections.Immutable.IImmutableList<IEntity>
    • Improve this Doc
    • View Source
    Back to top Generated by DocFX