A2uiCoreCatalog
interface A2uiCoreCatalog
A registry of UI components and functions that a client surface can render.
Summary
Public properties |
|
|---|---|
A2uiCoreComponentDefinitionCollection |
The collection of component definitions available in this catalog. |
open String? |
The description of this catalog. |
A2uiFunctionCollection |
The collection of functions available in this catalog. |
String |
A unique identifier for this catalog. |
open Boolean |
Indicates whether this catalog's full JSON Schema should be serialized inline as part of the capabilities advertisement. |
open A2uiSchema? |
The schema this catalog uses to define the theme the is applied over the components. |
open String? |
The title of this catalog. |
Extension functions |
|
|---|---|
A2uiCoreCatalogSerializer |
Creates an |
A2uiInlineCatalog |
Adapts this |
Public properties
componentDefinitions
val componentDefinitions: A2uiCoreComponentDefinitionCollection
The collection of component definitions available in this catalog.
functions
val functions: A2uiFunctionCollection
The collection of functions available in this catalog.
id
val id: String
A unique identifier for this catalog. Ideally, this is a URI including a version number. Full guidelines regarding catalog id convention can be found in: https://a2ui.org/concepts/catalogs/#catalog-naming-versioning
isInline
open val isInline: Boolean
Indicates whether this catalog's full JSON Schema should be serialized inline as part of the capabilities advertisement.
themeSchema
open val themeSchema: A2uiSchema?
The schema this catalog uses to define the theme the is applied over the components.
Extension functions
A2uiCoreCatalog.obtainSerializer
fun A2uiCoreCatalog.obtainSerializer(): A2uiCoreCatalogSerializer
Creates an A2uiCoreCatalogSerializer for this catalog.
| Returns | |
|---|---|
A2uiCoreCatalogSerializer |
a new serializer instance configured for this catalog |
A2uiCoreCatalog.toInlineCatalog
fun A2uiCoreCatalog.toInlineCatalog(): A2uiInlineCatalog
Adapts this A2uiCoreCatalog into an A2uiInlineCatalog for use in client capabilities advertisement.
| Throws | |
|---|---|
IllegalStateException |
If |