Class AvaConversionClient

Inheritance

System.Object

AvaConversionClient

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 AvaConversionClient

Constructors

| Improve this Doc View Source

AvaConversionClient(HttpClient)

Declaration

public AvaConversionClient(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

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

Converts Dangl.AVA projects to Excel

Declaration

public Task<FileResponse> ConvertToExcelAsync(ProjectDto avaProject, bool? writePrices, bool? writeLongTexts, string conversionCulture)

Parameters

Type	Name	Description
Dangl.AVA.IO.Dto.v1.ProjectDto	avaProject	The Dangl.AVA project
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(ProjectDto, Nullable<Boolean>, Nullable<Boolean>, String, CancellationToken)

Converts Dangl.AVA projects to Excel

Declaration

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

Parameters

Type	Name	Description
Dangl.AVA.IO.Dto.v1.ProjectDto	avaProject	The Dangl.AVA project
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(ProjectDto, Nullable<DestinationGaebType>, Nullable<DestinationGaebExchangePhase>)

Converts Dangl.AVA projects to GAEB

Declaration

public Task<FileResponse> ConvertToGaebAsync(ProjectDto avaProject, DestinationGaebType? destinationGaebType, DestinationGaebExchangePhase? targetExchangePhaseTransform)

Parameters

Type	Name	Description
Dangl.AVA.IO.Dto.v1.ProjectDto	avaProject	The Dangl.AVA project
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(ProjectDto, Nullable<DestinationGaebType>, Nullable<DestinationGaebExchangePhase>, CancellationToken)

Converts Dangl.AVA projects to GAEB

Declaration

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

Parameters

Type	Name	Description
Dangl.AVA.IO.Dto.v1.ProjectDto	avaProject	The Dangl.AVA project
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.

| Improve this Doc View Source

ConvertToRebAsync(ProjectDto)

Converts Dangl.AVA projects to REB

Declaration

public Task<FileResponse> ConvertToRebAsync(ProjectDto avaProject)

Parameters

Type	Name	Description
Dangl.AVA.IO.Dto.v1.ProjectDto	avaProject	The Dangl.AVA project

Returns

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

Exceptions

Type	Condition
SwaggerException	A server side error occurred.

| Improve this Doc View Source

ConvertToRebAsync(ProjectDto, CancellationToken)

Converts Dangl.AVA projects to REB

Declaration

public Task<FileResponse> ConvertToRebAsync(ProjectDto avaProject, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Dangl.AVA.IO.Dto.v1.ProjectDto	avaProject	The Dangl.AVA project
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.