urbanairship-core/com.urbanairship.json

Package-level declarations

Types

class AirshipJsonSchema @JvmOverloads constructor(val type: AirshipJsonSchema.ValueType, val description: String? = null, extensions: Map<String, JsonValue> = emptyMap()) : JsonSerializable

Describes the structured JSON output an AI evaluation expects from a model.

JsonException

class JsonException : Exception

Thrown when a JsonValue is unable to wrap an object or unable to parse a JSON encoded String.

JsonList

class JsonList(list: List<JsonValue>?) : Iterable<JsonValue> , JsonSerializable

An immutable list of JsonValues.

JsonMap

class JsonMap(map: Map<String, JsonValue>?) : Iterable<Map.Entry<String, JsonValue>> , JsonSerializable

An immutable mapping of String keys to JsonValues.

JsonMatcher

class JsonMatcher : JsonSerializable, Predicate<JsonSerializable>

Class representing the leaf node of a JsonPredicate that contains the relevant field matching info.

JsonPredicate

class JsonPredicate : JsonSerializable, Predicate<JsonSerializable>

Class abstracting a JSON predicate. The predicate is contained to the following schema:

JsonSerializable

fun interface JsonSerializable

Interface for classes whose instances can be written as a JsonValue.

JsonValue

class JsonValue : Parcelable, JsonSerializable

A JsonValue is a representation of any value that can be described using JSON. It can contain one of the following: a JsonMap, a JsonList, a Number, a Boolean, String, or it can contain null.

ValueMatcher

abstract class ValueMatcher : JsonSerializable, Predicate<JsonSerializable>

Class representing the field matching type and values contained in a JsonMatcher.

Functions

emptyJsonList

fun emptyJsonList(): JsonList

Convenience method to create an empty JsonList.

emptyJsonMap

fun emptyJsonMap(): JsonMap

Convenience method to create an empty JsonMap.

jsonListOf

fun jsonListOf(vararg values: Any): JsonList

jsonMapOf

fun jsonMapOf(vararg fields: Pair<String, *>): JsonMap

Inherited functions

extend

fun JsonMap.extend(vararg fields: Pair<String, *>): JsonMap

isoDateAsInstant

fun JsonMap.isoDateAsInstant(key: String, defaultValue: Instant? = null): Instant?

Gets the field with the given key and parses it as an ISO date string.

optionalEpochMillis

fun JsonMap.optionalEpochMillis(key: String): Instant?

Reads the field with the given key, holding epoch milliseconds, as an Instant, or null if the field is absent or not a number.

optionalField

inline fun <T> JsonMap.optionalField(key: String): T?

Gets the field with the given key from the JsonMap, or null if not defined.

optionalList

fun JsonMap.optionalList(key: String): JsonList?

Gets a list with the given key from the JsonMap, or an null if not defined.

optionalMap

fun JsonMap.optionalMap(key: String): JsonMap?

Gets a map with the given key from the JsonMap, or an null if not defined.

requireEpochMillis

fun JsonMap.requireEpochMillis(key: String): Instant

Reads the field with the given key, holding epoch milliseconds, as an Instant.

fun JsonValue.requireEpochMillis(key: String? = null): Instant

Reads a JsonValue holding epoch milliseconds as an Instant.

requireField

inline fun <T> JsonMap.requireField(key: String): T

Gets the field with the given key from the JsonMap, ensuring it is non-null.

requireList

fun JsonMap.requireList(key: String): JsonList

Gets a list with the given key from the JsonMap.

requireMap

fun JsonMap.requireMap(key: String): JsonMap

Gets a map with the given key from the JsonMap.

toJsonList

fun <T : JsonSerializable> List<T>.toJsonList(): JsonList

toJsonMap

fun <T : JsonSerializable> Map<String, T?>.toJsonMap(): JsonMap

tryParse

inline fun <T, R : JsonSerializable> R.tryParse(logError: Boolean = false, parser: (R) -> T): T?