discord4j.discordjson.json.ApplicationCommandOptionData Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of discord-json Show documentation
Discord entity domain as immutable Jackson objects
There is a newer version: 1.7.9
package discord4j.discordjson.json;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import discord4j.discordjson.possible.Possible;
import org.immutables.value.Value;

import java.util.List;
import java.util.Map;
import java.util.Optional;

@Value.Immutable
@JsonSerialize(as = ImmutableApplicationCommandOptionData.class)
@JsonDeserialize(as = ImmutableApplicationCommandOptionData.class)
public interface ApplicationCommandOptionData {

    static ImmutableApplicationCommandOptionData.Builder builder() {
        return ImmutableApplicationCommandOptionData.builder();
    }

    /**
     * value of ApplicationCommandOptionType
     */
    int type();

    /**
     * 1-32 character name
     */
    String name();

    @JsonProperty("name_localizations")
    Possible>> nameLocalizations();

    /**
     * 1-100 character description
     */
    String description();

    @JsonProperty("description_localizations")
    Possible>> descriptionLocalizations();

    /**
     * if the parameter is required or optional -- default false
     */
    Possible required();

    /** choices for STRING, INTEGER, and NUMBER Application Command Option Types for the user to pick from */
    Possible> choices();

    /**
     * if the option is a subcommand or subcommand group type, this nested options will be the parameters
     */
    Possible> options();

    /**
     * Whether this option supports auto complete or not -- default false.
     * 
     * May not be set if choices are present
     */
    Possible autocomplete();

    /**
     * List of values of value of Channel.Type of which users can pick for the CHANNEL type option.
     * 

     * If not provided, no restriction is placed on channel types.
     */
    @JsonProperty("channel_types")
    Possible> channelTypes();

    /**
     * The minimum value allowed to be entered. Only valid for INTEGER and NUMBER type options.
     * 
     * If not provided, no restriction is placed on the minimum value permitted.
     */
    @JsonProperty("min_value")
    Possible minValue();

    /**
     * The maximum value allowed to be entered. Only valid for INTEGER and NUMBER type options.
     * 
     * If not provided, no restriction is placed on the maximum value permitted.
     */
    @JsonProperty("max_value")
    Possible maxValue();

    /**
     * The minimum value allowed to be entered (minimum of 0). Only valid for STRING type option.
     * 
     * If not provided, no restriction is placed on the minimum value permitted.
     */
    @JsonProperty("min_length")
    Possible minLength();

    /**
     * The maximum value allowed to be entered (minimum of 1). Only valid for STRING type option.
     * 
     * If not provided, no restriction is placed on the maximum value permitted.
     */
    @JsonProperty("max_length")
    Possible maxLength();
}