Class ValidationClient
Inheritance
System.Object
ValidationClient
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()
Assembly: Dangl.AVACloud.Client.dll
Syntax
public class ValidationClient
Constructors
|
Improve this Doc
View Source
ValidationClient(String, HttpClient)
Declaration
public ValidationClient(string baseUrl, HttpClient httpClient)
Parameters
Type |
Name |
Description |
System.String |
baseUrl |
|
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 |
|
|
Improve this Doc
View Source
ReadResponseAsString
Declaration
public bool ReadResponseAsString { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Methods
|
Improve this Doc
View Source
ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<String, IEnumerable<String>>, CancellationToken)
Declaration
protected virtual async Task<ValidationClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)
Parameters
Type |
Name |
Description |
System.Net.Http.HttpResponseMessage |
response |
|
System.Collections.Generic.IReadOnlyDictionary<System.String, System.Collections.Generic.IEnumerable<System.String>> |
headers |
|
System.Threading.CancellationToken |
cancellationToken |
|
Returns
Type Parameters
|
Improve this Doc
View Source
ValidateFileAsync(FileParameter, Nullable<FileValidationSourceType>)
This endpoint validates AVA files, typically GAEB or ÖNorm. The type of file needs to be provided
as a query parameter, since there is no auto detection of the uploaded file type.
Declaration
public virtual Task<ValidationResult> ValidateFileAsync(FileParameter avaFile, FileValidationSourceType? fileValidationSourceType)
Parameters
Type |
Name |
Description |
FileParameter |
avaFile |
The file to validate
|
System.Nullable<FileValidationSourceType> |
fileValidationSourceType |
You need to indicate which type of file is being provided, there is no auto detection mechanism
|
Returns
Exceptions
|
Improve this Doc
View Source
ValidateFileAsync(FileParameter, Nullable<FileValidationSourceType>, CancellationToken)
This endpoint validates AVA files, typically GAEB or ÖNorm. The type of file needs to be provided
as a query parameter, since there is no auto detection of the uploaded file type.
Declaration
public virtual async Task<ValidationResult> ValidateFileAsync(FileParameter avaFile, FileValidationSourceType? fileValidationSourceType, CancellationToken cancellationToken)
Parameters
Type |
Name |
Description |
FileParameter |
avaFile |
The file to validate
|
System.Nullable<FileValidationSourceType> |
fileValidationSourceType |
You need to indicate which type of file is being provided, there is no auto detection mechanism
|
System.Threading.CancellationToken |
cancellationToken |
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
|
Returns
Exceptions
|
Improve this Doc
View Source
ValidateProjectAsync(PostAvaProjectValidationSourceOptions)
This endpoint provides a full validation of a provided ProjectDto. It will take the given exchange phase
into account and do some general project validation. Optionally, a conversion to a desired target can also
be done, in which case the target file will also be validated.
Declaration
public virtual Task<ValidationResult> ValidateProjectAsync(PostAvaProjectValidationSourceOptions avaProjectValidationSourceOptions)
Parameters
Returns
Exceptions
|
Improve this Doc
View Source
ValidateProjectAsync(PostAvaProjectValidationSourceOptions, CancellationToken)
This endpoint provides a full validation of a provided ProjectDto. It will take the given exchange phase
into account and do some general project validation. Optionally, a conversion to a desired target can also
be done, in which case the target file will also be validated.
Declaration
public virtual async Task<ValidationResult> ValidateProjectAsync(PostAvaProjectValidationSourceOptions avaProjectValidationSourceOptions, CancellationToken cancellationToken)
Parameters
Type |
Name |
Description |
PostAvaProjectValidationSourceOptions |
avaProjectValidationSourceOptions |
The options used for the validation operation
|
System.Threading.CancellationToken |
cancellationToken |
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
|
Returns
Exceptions