Package net.dv8tion.jda.api.components.selections

Class EntitySelectMenu.DefaultValue

java.lang.Object

net.dv8tion.jda.api.components.selections.EntitySelectMenu.DefaultValue

All Implemented Interfaces:

ISnowflake, SerializableData

Enclosing interface:

EntitySelectMenu

public static class EntitySelectMenu.DefaultValue
extends Object
implements ISnowflake, SerializableData

Represents the default values used in EntitySelectMenu.getDefaultValues().
The value is typed correspondingly to the menu entity types.

The value is represented by the ID, corresponding to the entity of that ID.

Method Summary

Modifier and Type	Method	Description
static EntitySelectMenu.DefaultValue	channel(long id)	Creates a default value of type EntitySelectMenu.SelectTarget.CHANNEL with the provided id.
static EntitySelectMenu.DefaultValue	channel(String id)	Creates a default value of type EntitySelectMenu.SelectTarget.CHANNEL with the provided id.
boolean	equals(Object obj)
static EntitySelectMenu.DefaultValue	from(GuildChannel channel)	Creates a default value of type EntitySelectMenu.SelectTarget.CHANNEL for the provided channel.
static EntitySelectMenu.DefaultValue	from(Role role)	Creates a default value of type EntitySelectMenu.SelectTarget.ROLE for the provided role.
static EntitySelectMenu.DefaultValue	from(UserSnowflake user)	Creates a default value of type EntitySelectMenu.SelectTarget.USER for the provided user.
static EntitySelectMenu.DefaultValue	fromData(DataObject object)	Parses the provided DataObject into the default value.
long	getIdLong()	The Snowflake id of this entity.
EntitySelectMenu.SelectTarget	getType()
int	hashCode()
static EntitySelectMenu.DefaultValue	role(long id)	Creates a default value of type EntitySelectMenu.SelectTarget.ROLE with the provided id.
static EntitySelectMenu.DefaultValue	role(String id)	Creates a default value of type EntitySelectMenu.SelectTarget.ROLE with the provided id.
DataObject	toData()	Serialized DataObject for this object.
String	toString()
static EntitySelectMenu.DefaultValue	user(long id)	Creates a default value of type EntitySelectMenu.SelectTarget.USER with the provided id.
static EntitySelectMenu.DefaultValue	user(String id)	Creates a default value of type EntitySelectMenu.SelectTarget.USER with the provided id.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getTimeCreated

Method Details

fromData

@Nonnull
public static EntitySelectMenu.DefaultValue fromData(@Nonnull
 DataObject object)

Parses the provided DataObject into the default value.

Parameters:

object - The serialized default value, with a valid type and id

Returns:

Parsed default value

Throws:

IllegalArgumentException - If the provided object is invalid or missing required keys

from

@Nonnull
public static EntitySelectMenu.DefaultValue from(@Nonnull
 UserSnowflake user)

Creates a default value of type EntitySelectMenu.SelectTarget.USER for the provided user.

Parameters:

user - The corresponding user

Returns:

The default value

Throws:

IllegalArgumentException - If null is provided

from

@Nonnull
public static EntitySelectMenu.DefaultValue from(@Nonnull
 Role role)

Creates a default value of type EntitySelectMenu.SelectTarget.ROLE for the provided role.

Parameters:

role - The corresponding role

Returns:

The default value

Throws:

IllegalArgumentException - If null is provided

from

@Nonnull
public static EntitySelectMenu.DefaultValue from(@Nonnull
 GuildChannel channel)

Creates a default value of type EntitySelectMenu.SelectTarget.CHANNEL for the provided channel.

Parameters:

channel - The corresponding channel

Returns:

The default value

Throws:

IllegalArgumentException - If null is provided

role

@Nonnull
public static EntitySelectMenu.DefaultValue role(long id)

Creates a default value of type EntitySelectMenu.SelectTarget.ROLE with the provided id.

Parameters:

id - The role id

Returns:

The default value

role

@Nonnull
public static EntitySelectMenu.DefaultValue role(@Nonnull
 String id)

Creates a default value of type EntitySelectMenu.SelectTarget.ROLE with the provided id.

Parameters:

id - The role id

Returns:

The default value

Throws:

IllegalArgumentException - If the provided id is not a valid snowflake

user

@Nonnull
public static EntitySelectMenu.DefaultValue user(long id)

Creates a default value of type EntitySelectMenu.SelectTarget.USER with the provided id.

Parameters:

id - The user id

Returns:

The default value

user

@Nonnull
public static EntitySelectMenu.DefaultValue user(@Nonnull
 String id)

Creates a default value of type EntitySelectMenu.SelectTarget.USER with the provided id.

Parameters:

id - The user id

Returns:

The default value

Throws:

IllegalArgumentException - If the provided id is not a valid snowflake

channel

@Nonnull
public static EntitySelectMenu.DefaultValue channel(long id)

Creates a default value of type EntitySelectMenu.SelectTarget.CHANNEL with the provided id.

Parameters:

id - The channel id

Returns:

The default value

channel

@Nonnull
public static EntitySelectMenu.DefaultValue channel(@Nonnull
 String id)

Creates a default value of type EntitySelectMenu.SelectTarget.CHANNEL with the provided id.

Parameters:

id - The channel id

Returns:

The default value

Throws:

IllegalArgumentException - If the provided id is not a valid snowflake

getIdLong

public long getIdLong()

Description copied from interface: ISnowflake

The Snowflake id of this entity. This is unique to every entity and will never change.

Specified by:

getIdLong in interface ISnowflake

Returns:

Long containing the Id.

getType

@Nonnull
public EntitySelectMenu.SelectTarget getType()

toData

@Nonnull
public DataObject toData()

Description copied from interface: SerializableData

Serialized DataObject for this object.

Specified by:

toData in interface SerializableData

Returns:

DataObject

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object