Schema.Companion

public static class Schema.Companion

Summary

Public methods
`static final @NonNull Schema<@NonNull List<@NonNull String>>`	`arr( @NonNull String name, @NonNull String description, Schema<@NonNull Object> items )` Registers a schema for an array.
`static final @NonNull Schema<@NonNull Boolean>`	`bool(@NonNull String name, @NonNull String description)` Registers a schema for a boolean
`static final @NonNull Schema<@NonNull String>`	`enum( @NonNull String name, @NonNull String description, @NonNull List<@NonNull String> values )` Registers a schema for an enum
`static final @NonNull Schema<@NonNull Long>`	`int(@NonNull String name, @NonNull String description)` Registers a schema for an integer number
`static final @NonNull Schema<@NonNull Double>`	`num(@NonNull String name, @NonNull String description)` Registers a schema for a floating point number
`static final @NonNull Schema<@NonNull JSONObject>`	`obj( @NonNull String name, @NonNull String description, @NonNull Schema<@NonNull Object> contents )` Registers a schema for a complex object.
`static final @NonNull Schema<@NonNull String>`	`str(@NonNull String name, @NonNull String description)` Registers a schema for a string

Public methods

arr

public static final @NonNull Schema<@NonNull List<@NonNull String>> arr(
    @NonNull String name,
    @NonNull String description,
    Schema<@NonNull Object> items
)

Registers a schema for an array.

Parameters
`Schema<@NonNull Object> items`	can be used to specify the type of the array

bool

public static final @NonNull Schema<@NonNull Boolean> bool(@NonNull String name, @NonNull String description)

Registers a schema for a boolean

enum

public static final @NonNull Schema<@NonNull String> enum(
    @NonNull String name,
    @NonNull String description,
    @NonNull List<@NonNull String> values
)

Registers a schema for an enum

int

public static final @NonNull Schema<@NonNull Long> int(@NonNull String name, @NonNull String description)

Registers a schema for an integer number

num

public static final @NonNull Schema<@NonNull Double> num(@NonNull String name, @NonNull String description)

Registers a schema for a floating point number

obj

public static final @NonNull Schema<@NonNull JSONObject> obj(
    @NonNull String name,
    @NonNull String description,
    @NonNull Schema<@NonNull Object> contents
)

Registers a schema for a complex object. In a function it will be returned as a JSONObject

str

public static final @NonNull Schema<@NonNull String> str(@NonNull String name, @NonNull String description)

Registers a schema for a string