Namespace Noxum.Nova.Cms.Client
Classes
CmsApiException
CmsApiException<TResult>
CmsApplicationArea
The Object Type 60. This object type is used to structure the system thematically by bundling object types together. Application Areas can have grants and thus be used to restrict access to certain object types.
CmsAttribute
The Object Type 10. This object type allows the creation of an attribute which defines a property or a characteristic feature of an object such as name, data type, language-dependent, unit of measurement, etc. If an attribute is assigned to an 'Object Type', it is a property or a characteristic of the object. One or more attributes serve to describe an 'Object Type'.
CmsAttributeGroup
The Object Type 11. This object type defines a logic set of 'Attributes' and structures them in a group.
CmsAttributeMainGroup
The Object Type 12. This object type defines a logic set of 'Attribute Groups' and structures them in a main group. In a nesting of one or more 'Attributes Groups', the 'Attributes Main Group' is at the top level.
CmsBooleanValueCondition
The Object Type 176. This object type defines the conditions for triggers that refer to boolean attribute values on objects. The attribute values are validated by a defined boolean value.
CmsBranch
The Object Type 40. This object type represents the state of objects at a certain point in time. The application contains an initial 'Default' work package as a starting point for subordinate 'Work Packages'. The 'Default' work package cannot be deleted. From each 'Work Package' a subordinate 'Work Package', for the purpose of the execution of certain changes, can be created. By merging, it is possible to integrate the values of one 'Work Package' into another. A 'Work Package' can only be deleted if there are no more subordinate 'Work Packages'. A 'Work Package' can be specified by a 'Work Package Type'.
CmsBranchType
The Object Type 180. This object type specifies the type of a 'Work Package'. The instances of this object type are defined by a workflow and its associated workflow state, which characterize this type. These instances can only be edited in the 'Default' work package, otherwise they are 'read-only'.
CmsCascadingStyleSheet
The Object Type 301. Object type to define CSS style sheets for rendering of Razor Views, Visual Components etc.
CmsClient
Implementation of ICmsClient
CmsClientOptions
The CMS API Options
CmsClientServiceCollectionExtension
Extension functions to add CMS API Client and its options to the service collection.
CmsComment
A single comment.
CmsCommentList
A list of comments.
CmsExternalApi
The Object Type 200. This object type specifies system objects for defining access to external RESTful APIs. These can be hosted outside the cluster, e.g. ChatGPT, LanguageTool. An 'External API' definitions carries information about the external endpoint URL and credentials.
CmsFontFace
The Object Type 304. This object type defines the visual appearance of the attached font file. It describes the specific design and style of a user defined font with various properties such as thickness, slant (italic or normal), size and other typographical features.
CmsFontFamily
The Object Type 303. This object type covers several font faces of different styles and weights.
CmsForm
The Object Type 50. This object type describes a form with its maintainable attributes. If the created form is assigned to an object type, it is the description of the attributes of that object. One or more forms are used to describe the attributes of an object type. In this way, the same attributes can be maintained for different objects using different forms.
CmsJob
A single job.
CmsJobDefinition
The Object Type 120. This object type defines a task that can be assigned to objects. The 'Job Definition' defines suitable parameters for the execution of a job, such as container parameters, resource parameters, etc. Jobs run in the background in a 'docker' container.
CmsJobList
A list of jobs.
CmsKanbanBoard
The Object Type 90. This object type represents objects in different states of a workflow clearly and visually by using cards on a board. The attributes of this object type can be used to define the possible states and the content of the cards for the board.
CmsLanguage
The Object Type 20. This object type defines the 'Languages' available to the application for defining the contents. These 'Language' variants are used to display user interface elements and their contents in the desired 'Language' variant. One instance of this object type specifies one 'Language' at a time.
CmsMediaType
The Object Type 100. This object type describes the type and format of a media object, such as a picture or a document. It contains further parameters to describe the media type, such as the file extension or jobs that are executed when a new media type is uploaded.
CmsNumericValueCondition
The Object Type 174. This object type defines the conditions for triggers that refer to numeric attribute values on objects. The attribute values are validated by a defined 'floating-point number' and a comparison operator.
CmsObject
A single object with all its values, sorted by attribute, variant and language
CmsObjectConverter
Custom JSON converter for CmsObject.
CmsObjectList
A list of objects
CmsObjectMetadata
The meta data of an object
CmsObjectReferenceValueCondition
The Object Type 171. This object type defines the conditions for triggers that refer to object reference attribute values on objects. The attribute values are validated by the defined object references and a boolean 'not in' value.
CmsObjectType
The Object Type 0. This initial system object type is the basis for all further object types in 'NovaDB'. Any number of objects can be generated from an object type, which represent the concrete properties of the respective object type. These objects of an object type are also called 'instances'.
CmsObjectTypeAttribute
Attribute indicating an CmsObject implementation class
CmsPackage
The Object Type 130. This object type consists of an XML file in the specially defined '.opfz' format and serves to configure a completely new 'NovaDB' application or to extend an existing one. It is a combination of object definitions, object references, instances, and their contents to form a logical package unit. This allows the information required for a field of application, such as 'Web Shop', to be summarized thematically.
CmsParagraphStyle
The Object Type 300. Object type for defining special formatting of paragraphs that can be used in the 'Rich Text Editor' of 'NovaDB'.
CmsParameter
The Object Type 155. This object type defines 'Parameters' that can be assigned to a 'Job Definition', for example. A 'Parameter' is defined by a 'Name' and an 'Attribute' and can be used to influence a function output through a maintained value.
CmsPresentationAs
The Object Type 190.
CmsRazorView
The Object Type 150. This object type defines 'Razor Views' that are used as 'Previews' for object types. A 'Razor View' is specified by an 'API Identifier' and especially by a 'Razor Code' to define the 'Preview' content.
CmsScriptedCondition
The Object Type 170. This object type defines the conditions for triggers that refer to different attribute values on objects. The attribute values are validated by the defined 'JavaScript Code'.
CmsStringValueCondition
The Object Type 173. This object type defines the conditions for triggers that refer to string attribute values on objects. The attribute values are validated by defined string values and a boolean 'not in' or 'contains' value.
CmsTextAlignment
The Object Type 302. Object type for defining special alignments of characters and texts that can be used in the 'Rich Text Editor' of 'NovaDB'.
CmsTimerDefinition
The Object Type 161. This object type defines a 'Timer' that can be used to start jobs periodically in certain time intervals. The evaluated times of the set time attributes are always UTC-based. The execution takes place in the respective UTC time zone.
CmsTimestampValueCondition
The Object Type 175. This object type defines the conditions for triggers that refer to timestamp attribute values on objects. The attribute values are validated by a defined timestamp and a boolean 'is after' or 'is now' value.
CmsTransaction
A transaction
CmsTreeDefinition
The Object Type 140. This object type enables the structured representation of objects. A 'Structure' is a group of nodes that are related to each other, starting from a root node with child nodes.
CmsTriggerDefinition
The Object Type 160. This object type defines a 'Trigger' that specifies how job requests or other actions are automatically created and started. This happens when defined attribute values on objects are changed and the defined conditions are met. Conditions are set by the referenced condition objects on this object type.
CmsUiString
The Object Type 70. This object type is used to define all required texts for the user interface of the application. To localize the user interface, all texts can be maintained in the available languages.
CmsUnit
The Object Type 30. This object type defines exactly one geometric or physical quantity, such as meter, second, kilowatt, hertz or kilometer, to which a unique value can be assigned. A 'Unit of Measure' can be assigned to a 'Unit Group'.
CmsUnitGroup
The Object Type 31. This object type defines a logical grouping of 'Units of Measure' in order to summarize them in a set.
CmsUserNameValueCondition
The Object Type 172. This object type defines the conditions for triggers that refer to user name attribute values on objects. The attribute values are validated by the defined user names and a boolean 'not in' value.
CmsValue
A single value of an object
CmsValueComparer
Compare CmsValues.
CmsValueConverter
Custom JSON converter for CmsValue.
CmsVisualComponentDefinition
The Object Type 400. This object type specifies the type of content and behavior of a 'Visual Component' that is part of a 'Visual Document'. The respective component is assigned to a group. Depending on the type, different contents can be defined.
CmsVisualComponentDefinitionGroup
The Object Type 401. This object type specifies a logical compilation of 'Visual Components' for grouping content in the toolbar of the 'Visual Editor'.
CmsVisualComponentType
The Object Type 402.
CmsWebHookDefinition
The Object Type 210. This object type specifies configuration objects for the 'Web Hooks Service'. This enables web applications to get notified about specific 'Nova Events'. A 'Web Hook Definition' defines which 'Nova Event' to subscribe, an event condition, how to transform the event's JSON payload and which external API is to be called
CmsWorkflowState
The Object Type 80. This object type defines individual states of a workflow. These are combined via a workflow attribute and assigned to a 'Kanban Board'. The 'Workflow State' is represented on a 'Kanban Board' by a vertical column. A workflow can contain as many 'Workflow States' as required.
CodeGeneratorClient
CommentClient
CreateBranchRequest
Model to create a branch.
CreateCommentRequest
Model to create a comment.
CreateJobRequest
Model to create a job.
CreateObjectsRequest
A list of objects to be created
CreateObjectsResponse
Response to a CreateObjectsRequest
DeleteBranchRequest
Request model for deleting a branch
DeleteBranchResponse
Response to a delete branch request
DeleteObjectsRequest
A list of objects to be deleted
DeleteObjectsResponse
Response to a delete objects request
FileParameter
FileResponse
FileUploadRequest
Model for image upload with additional parameters.
FileUploadResult
File upload result.
FilesClient
Implementation of IFilesClient
IdentityClient
JobArtifact
A job artifact.
JobArtifactList
A list of artifacts.
JobClient
JobInputFileInfo
Job input file information
JobInputUploadResult
Job input upload result
JobMetrics
Represents a single job metric point.
JobParameter
Model for job parameters.
JobProgress
Represents job progress information.
ProblemDetails
UpdateBranchRequest
Model to update a branch.
UpdateBranchResponse
Response to an update branch request
UpdateCommentRequest
Model to update a comment.
UpdateJobRequest
Model to update a job.
UpdateObjectsRequest
A list of objects to be updated
UpdateObjectsResponse
Response to an update objects request
Structs
CmsClient.ObjectResponseResult<T>
CodeGeneratorClient.ObjectResponseResult<T>
CommentClient.ObjectResponseResult<T>
FilesClient.ObjectResponseResult<T>
IdentityClient.ObjectResponseResult<T>
JobClient.ObjectResponseResult<T>
Interfaces
ICmsClient
Interface of cms client
ICodeGeneratorClient
ICommentClient
IFilesClient
IIdentityClient
IJobClient
Enums
JobState
The status of a Nova job
JobStatus
The status of a Nova job queue entry