Table of Contents

Class ReportRequestArguments

Namespace
GroupeIsa.Neos.Shared.Reports
Assembly
GroupeIsa.Neos.Shared.dll

Represent a demand for report generating from developer by code. Used for pipe communication.

public sealed class ReportRequestArguments : CommonReportingArguments<ReportRequestArguments, object?>
Inheritance
ReportRequestArguments
Inherited Members

Constructors

ReportRequestArguments(string, string?, Dictionary<string, object?>?, Dictionary<string, object?>?, string?)

Initializes a new instance of the ReportRequestArguments class.

public ReportRequestArguments(string reportName, string? filter = null, Dictionary<string, object?>? parameters = null, Dictionary<string, object?>? entityViewParameters = null, string? languageCode = null)

Parameters

reportName string

Report name.

filter string

Filter in OData format apply on report DataSource.

parameters Dictionary<string, object>

Parameters to provide to the third-party report engine.

entityViewParameters Dictionary<string, object>

Parameters for the Neos endpoint that provides the data.

languageCode string

The culture codename for localizing the report data (labels, native variables, business data). (e.g. "fr", "fr-CA", "fr-FR", etc.).

Remarks

The signature and implementation of this constructor are frozen. One should not add nor remove any properties to it. Please consider using a fluent API or static factory methods if you need to set properties that are not listed as parameters of this constructor.

Properties

LanguageCode

Gets the identifier for localizing the report data (labels, native variables, business data). (e.g. "fr", "fr-CA", "fr-FR", etc.).

[Obsolete("Use LocalizationDataCulture property instead.")]
public string LanguageCode { get; }

Property Value

string

Remarks

Obsolete property name. Use LocalizationDataCulture instead.

Methods

Clone()

Initializes a new instance of the ReportRequestArguments class by cloning the current instance.

public ReportRequestArguments Clone()

Returns

ReportRequestArguments

A clone of the current instance.

WithLanguageCode(string)

Set language code.

[Obsolete("Use WithLocalizationDataCulture property instead.")]
public ReportRequestArguments WithLanguageCode(string languageCode)

Parameters

languageCode string

Language code.

Returns

ReportRequestArguments

Modified instance of ReportRequestArguments.