Class GaebConversionClient

Inheritance

System.Object

GaebConversionClient

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Dangl.AVACloud.Client

Assembly: Dangl.AVACloud.Client.dll

Syntax

public class GaebConversionClient

Constructors

| Improve this Doc View Source

GaebConversionClient(HttpClient)

Declaration

public GaebConversionClient(HttpClient httpClient)

Parameters

Type	Name	Description
System.Net.Http.HttpClient	httpClient

Properties

| Improve this Doc View Source

BaseUrl

Declaration

public string BaseUrl { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

JsonSerializerSettings

Declaration

protected JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

Type	Description
Newtonsoft.Json.JsonSerializerSettings

Methods

| Improve this Doc View Source

ConvertToAvaAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>)

Converts GAEB files to Dangl.AVA projects

Declaration

public Task<ProjectDto> ConvertToAvaAsync(FileParameter gaebFile, bool? removePlainTextLongTexts, bool? removeHtmlLongTexts)

Parameters

Type	Name	Description
FileParameter	gaebFile	The input file
System.Nullable<System.Boolean>	removePlainTextLongTexts	If set to true, plain text long texts will be removed from the output to reduce response sizes
System.Nullable<System.Boolean>	removeHtmlLongTexts	If set to true, html long texts will be removed from the output to reduce response sizes

Returns

Type	Description
System.Threading.Tasks.Task<Dangl.AVA.IO.Dto.v1.ProjectDto>

Exceptions

Type	Condition
SwaggerException	A server side error occurred.

| Improve this Doc View Source

ConvertToAvaAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

Converts GAEB files to Dangl.AVA projects

Declaration

public Task<ProjectDto> ConvertToAvaAsync(FileParameter gaebFile, bool? removePlainTextLongTexts, bool? removeHtmlLongTexts, CancellationToken cancellationToken)

Parameters

Type	Name	Description
FileParameter	gaebFile	The input file
System.Nullable<System.Boolean>	removePlainTextLongTexts	If set to true, plain text long texts will be removed from the output to reduce response sizes
System.Nullable<System.Boolean>	removeHtmlLongTexts	If set to true, html long texts will be removed from the output to reduce response sizes
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<Dangl.AVA.IO.Dto.v1.ProjectDto>

Exceptions

Type	Condition
SwaggerException	A server side error occurred.

| Improve this Doc View Source

ConvertToExcelAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, String)

Converts GAEB files to Excel

Declaration

public Task<FileResponse> ConvertToExcelAsync(FileParameter gaebFile, bool? writePrices, bool? writeLongTexts, string conversionCulture)

Parameters

Type	Name	Description
FileParameter	gaebFile	The input file
System.Nullable<System.Boolean>	writePrices	Defaults to true
System.Nullable<System.Boolean>	writeLongTexts	Defaults to true
System.String	conversionCulture	The culture that should be used for the conversion process, to have localized Excel files

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>

Exceptions

Type	Condition
SwaggerException	A server side error occurred.

| Improve this Doc View Source

ConvertToExcelAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, String, CancellationToken)

Converts GAEB files to Excel

Declaration

public Task<FileResponse> ConvertToExcelAsync(FileParameter gaebFile, bool? writePrices, bool? writeLongTexts, string conversionCulture, CancellationToken cancellationToken)

Parameters

Type	Name	Description
FileParameter	gaebFile	The input file
System.Nullable<System.Boolean>	writePrices	Defaults to true
System.Nullable<System.Boolean>	writeLongTexts	Defaults to true
System.String	conversionCulture	The culture that should be used for the conversion process, to have localized Excel files
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>

Exceptions

Type	Condition
SwaggerException	A server side error occurred.

| Improve this Doc View Source

ConvertToGaebAsync(FileParameter, Nullable<DestinationGaebType>, Nullable<DestinationGaebExchangePhase>)

Converts GAEB files to GAEB files. Used for example when transforming or repairing GAEB files.

Declaration

public Task<FileResponse> ConvertToGaebAsync(FileParameter gaebFile, DestinationGaebType? destinationGaebType, DestinationGaebExchangePhase? targetExchangePhaseTransform)

Parameters

Type	Name	Description
FileParameter	gaebFile	The input file
System.Nullable<DestinationGaebType>	destinationGaebType	Defaults to GAEB XML V3.2
System.Nullable<DestinationGaebExchangePhase>	targetExchangePhaseTransform	Defaults to none, meaning no transformation will be done

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>

Exceptions

Type	Condition
SwaggerException	A server side error occurred.

| Improve this Doc View Source

ConvertToGaebAsync(FileParameter, Nullable<DestinationGaebType>, Nullable<DestinationGaebExchangePhase>, CancellationToken)

Converts GAEB files to GAEB files. Used for example when transforming or repairing GAEB files.

Declaration

public Task<FileResponse> ConvertToGaebAsync(FileParameter gaebFile, DestinationGaebType? destinationGaebType, DestinationGaebExchangePhase? targetExchangePhaseTransform, CancellationToken cancellationToken)

Parameters

Type	Name	Description
FileParameter	gaebFile	The input file
System.Nullable<DestinationGaebType>	destinationGaebType	Defaults to GAEB XML V3.2
System.Nullable<DestinationGaebExchangePhase>	targetExchangePhaseTransform	Defaults to none, meaning no transformation will be done
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>

Exceptions

Type	Condition
SwaggerException	A server side error occurred.