Class CodeGeneratorClient

Inheritance

object

CodeGeneratorClient

Implements

ICodeGeneratorClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Noxum.Nova.Cms.Client

Assembly: Noxum.Nova.Cms.Client.dll

Syntax

public class CodeGeneratorClient : ICodeGeneratorClient

Constructors

CodeGeneratorClient(string, HttpClient)

Declaration

public CodeGeneratorClient(string baseUrl, HttpClient httpClient)

Parameters

Type	Name	Description
string	baseUrl
HttpClient	httpClient

Properties

BaseUrl

Declaration

public string BaseUrl { get; set; }

Property Value

Type	Description
string

JsonSerializerSettings

Declaration

protected JsonSerializerOptions JsonSerializerSettings { get; }

Property Value

Type	Description
JsonSerializerOptions

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Property Value

Type	Description
bool

Methods

GetCSharpClassAsync(string, string, string, CancellationToken)

Get a c# class for a specific object type

Declaration

public virtual Task<string> GetCSharpClassAsync(string branch, string language, string type, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	branch	The branch ID or ApiIdentifier
string	language	The programming language of the generated code
string	type	The object type ID or ApiIdentifier
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<string>	OK

Exceptions

Type	Condition
CmsApiException	A server side error occurred.

GetCSharpClassesAsync(string, string, string, CancellationToken)

Get generated class implementation for all objects with API identifiers

Declaration

public virtual Task<string> GetCSharpClassesAsync(string branch, string language, string ids = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	branch	The branch ID or ApiIdentifier
string	language	The programming language of the generated code
string	ids	A comma separated list of object type IDs, Guids or ApiIdentifiers or "all" for all custom object types that have an API Identifier
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<string>	OK

Exceptions

Type	Condition
CmsApiException	A server side error occurred.

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)

Declaration

protected virtual Task<CodeGeneratorClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)

Parameters

Type	Name	Description
HttpResponseMessage	response
IReadOnlyDictionary<string, IEnumerable<string>>	headers
CancellationToken	cancellationToken

Returns

Type	Description
Task<CodeGeneratorClient.ObjectResponseResult<T>>

Type Parameters

Name	Description
T

Implements

ICodeGeneratorClient