GetComponentResult

data class GetComponentResult(val bindingProperties: Map<String, ComponentBindingPropertiesValue>? = null, val children: List<ComponentChild>? = null, val collectionProperties: Map<String, ComponentDataConfiguration>? = null, val componentType: String? = null, val createdAt: String? = null, val events: Map<String, ComponentEvent>? = null, val id: String? = null, val modifiedAt: String? = null, val name: String? = null, val overrides: Map<String, Any>? = null, val properties: Map<String, ComponentProperty>? = null, val schemaVersion: String? = null, val sourceId: String? = null, val tags: Map<String, String>? = null, val variants: List<ComponentVariant>? = null)

Constructors

Link copied to clipboard
constructor(bindingProperties: Map<String, ComponentBindingPropertiesValue>? = null, children: List<ComponentChild>? = null, collectionProperties: Map<String, ComponentDataConfiguration>? = null, componentType: String? = null, createdAt: String? = null, events: Map<String, ComponentEvent>? = null, id: String? = null, modifiedAt: String? = null, name: String? = null, overrides: Map<String, Any>? = null, properties: Map<String, ComponentProperty>? = null, schemaVersion: String? = null, sourceId: String? = null, tags: Map<String, String>? = null, variants: List<ComponentVariant>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties .

Link copied to clipboard

A list of the component's ComponentChild instances.

Link copied to clipboard

The data binding configuration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties .

Link copied to clipboard
val componentType: String? = null

The type of the component. This can be an Amplify custom UI component or another custom component.

Link copied to clipboard
val createdAt: String? = null

The time that the component was created.

Link copied to clipboard

Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

Link copied to clipboard
val id: String? = null

The unique ID of the component.

Link copied to clipboard
val modifiedAt: String? = null

The time that the component was modified.

Link copied to clipboard
val name: String? = null

The name of the component.

Link copied to clipboard
val overrides: Map<String, Any>? = null

Describes the component's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides .

Link copied to clipboard

Describes the component's properties. You can't specify tags as a valid property for properties .

Link copied to clipboard
val schemaVersion: String? = null

The schema version of the component when it was imported.

Link copied to clipboard
val sourceId: String? = null

The unique ID of the component in its original source system, such as Figma.

Link copied to clipboard
val tags: Map<String, String>? = null

One or more key-value pairs to use when tagging the component.

Link copied to clipboard

A list of the component's variants. A variant is a unique style configuration of a main component.