A2uiCoreCatalog
public interface A2uiCoreCatalog
A registry of UI components and functions that a client surface can render.
Summary
Public methods |
|
|---|---|
abstract @NonNull A2uiCoreComponentDefinitionCollection |
The collection of component definitions available in this catalog. |
default String |
The description of this catalog. |
abstract @NonNull A2uiFunctionCollection |
The collection of functions available in this catalog. |
abstract @NonNull String |
getId()A unique identifier for this catalog. |
default A2uiSchema |
The schema this catalog uses to define the theme the is applied over the components. |
default String |
getTitle()The title of this catalog. |
default boolean |
isInline()Indicates whether this catalog's full JSON Schema should be serialized inline as part of the capabilities advertisement. |
Extension functions |
|
|---|---|
default final @NonNull A2uiCoreCatalogSerializer |
A2uiCoreCatalogKt.obtainSerializer(@NonNull A2uiCoreCatalog receiver)Creates an |
default final @NonNull A2uiInlineCatalog |
A2uiCoreCatalogKt.toInlineCatalog(@NonNull A2uiCoreCatalog receiver)Adapts this |
Public methods
getComponentDefinitions
abstract @NonNull A2uiCoreComponentDefinitionCollection getComponentDefinitions()
The collection of component definitions available in this catalog.
getDescription
default String getDescription()
The description of this catalog.
getFunctions
abstract @NonNull A2uiFunctionCollection getFunctions()
The collection of functions available in this catalog.
getId
abstract @NonNull String getId()
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
getThemeSchema
default A2uiSchema getThemeSchema()
The schema this catalog uses to define the theme the is applied over the components.
isInline
default boolean isInline()
Indicates whether this catalog's full JSON Schema should be serialized inline as part of the capabilities advertisement.
Extension functions
A2uiCoreCatalogKt.obtainSerializer
default final @NonNull A2uiCoreCatalogSerializer A2uiCoreCatalogKt.obtainSerializer(@NonNull A2uiCoreCatalog receiver)
Creates an A2uiCoreCatalogSerializer for this catalog.
| Returns | |
|---|---|
@NonNull A2uiCoreCatalogSerializer |
a new serializer instance configured for this catalog |
A2uiCoreCatalogKt.toInlineCatalog
default final @NonNull A2uiInlineCatalog A2uiCoreCatalogKt.toInlineCatalog(@NonNull A2uiCoreCatalog receiver)
Adapts this A2uiCoreCatalog into an A2uiInlineCatalog for use in client capabilities advertisement.
| Throws | |
|---|---|
IllegalStateException |
If |