Interface ICodeGeneratorClient
Namespace: Noxum.Nova.Cms.Client
Assembly: Noxum.Nova.Cms.Client.dll
Syntax
public interface ICodeGeneratorClient
Methods
GetCSharpClassAsync(string, string, string, CancellationToken)
Get a c# class for a specific object type
Declaration
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
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. |