# A2uiRefSchema

Artifact: [androidx.a2ui:a2ui-model](https://developer.android.com/jetpack/androidx/releases/a2ui) [View Source](https://cs.android.com/search?q=file:androidx/a2ui/model/schema/A2uiRefSchema.kt+class:androidx.a2ui.model.schema.A2uiRefSchema) Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui#1.0.0-alpha02)

*** ** * ** ***


```
class A2uiRefSchema : A2uiSchema
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.a2ui.model.schema.A2uiSchema](https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiSchema) ||
|   | ↳ | [androidx.a2ui.model.schema.A2uiRefSchema](https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiRefSchema) |

*** ** * ** ***

Schema representing a reference to another schema definition.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiRefSchema#A2uiRefSchema(kotlin.String,kotlin.String,kotlin.collections.List)( ref: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?, keywords: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiSchemaKeyword<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html>> )` |

| ### Public functions |
|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiRefSchema#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiRefSchema#hashCode()()` |
| `open https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/-json-element/index.html` | `https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiRefSchema#toJsonElement()()` Returns the `https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/-json-element/index.html` hierarchy representing this schema. |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiRefSchema#toString()()` |

| ### Public properties |
|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | `https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiRefSchema#description()` semantic description of the schema |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiSchemaKeyword<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html>>` | `https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiRefSchema#keywords()` JSON Schema keywords applied to this schema node |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiRefSchema#ref()` reference path |

### Inherited functions

From [androidx.a2ui.model.schema.A2uiSchema](https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiSchema) `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` `https://developer.android.com/reference/kotlin/androidx/a2ui/model/schema/A2uiSchema#toJsonSchema()()`

Serializes this schema to a JSON Schema string representation.

## Public constructors

### A2uiRefSchema

```
A2uiRefSchema(
    ref: String,
    description: String? = null,
    keywords: List<A2uiSchemaKeyword<Any>> = emptyList()
)
```

## Public functions

### equals

```
open operator fun equals(other: Any?): Boolean
```

### hashCode

```
open fun hashCode(): Int
```

### toJsonElement

Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui#1.0.0-alpha02)

```
open fun toJsonElement(): JsonElement
```

Returns the `https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/-json-element/index.html` hierarchy representing this schema.

| Returns |
|---|---|
| `https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/-json-element/index.html` | the `https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/-json-element/index.html` hierarchy representing this schema |

### toString

```
open fun toString(): String
```

## Public properties

### description

```
open val description: String?
```

semantic description of the schema

### keywords

```
open val keywords: List<A2uiSchemaKeyword<Any>>
```

JSON Schema keywords applied to this schema node

### ref

Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui#1.0.0-alpha02)

```
val ref: String
```

reference path