Package net.dv8tion.jda.api.interactions

Enum InteractionContextType

java.lang.Object

java.lang.Enum<InteractionContextType>

net.dv8tion.jda.api.interactions.InteractionContextType

All Implemented Interfaces:

Serializable, Comparable<InteractionContextType>

public enum InteractionContextType
extends Enum<InteractionContextType>

Represents where commands can be used.

See Also:

• Discord docs

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOT_DM	Usable in the bot's DM.
GUILD	Usable in guilds.
PRIVATE_CHANNEL	Usable in private channels other than the bot DMs, includes friend DMs and Group DMs.
UNKNOWN

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<InteractionContextType>	ALL	Contains all interaction types.

Method Summary

Modifier and Type	Method	Description
static InteractionContextType	fromKey(String key)	Gets the interaction context corresponding to the key, returns UNKNOWN if no entry matches.
String	getType()	The raw value of this interaction context.
static InteractionContextType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static InteractionContextType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final InteractionContextType UNKNOWN

GUILD

public static final InteractionContextType GUILD

Usable in guilds.

Note: Using this command in guilds the bot isn't in requires the USER_INSTALL installation context. (See CommandData.setContexts(InteractionContextType...))

BOT_DM

public static final InteractionContextType BOT_DM

Usable in the bot's DM.

PRIVATE_CHANNEL

public static final InteractionContextType PRIVATE_CHANNEL

Usable in private channels other than the bot DMs, includes friend DMs and Group DMs.

Requirements
This requires the USER_INSTALL installation context.

Field Details

ALL

public static final Set<InteractionContextType> ALL

Contains all interaction types.

Method Details

values

public static InteractionContextType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static InteractionContextType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getType

@Nonnull
public String getType()

The raw value of this interaction context.

Returns:

The raw value

fromKey

@Nonnull
public static InteractionContextType fromKey(@Nonnull
 String key)

Gets the interaction context corresponding to the key, returns UNKNOWN if no entry matches.

Parameters:

key - The key to match against

Returns:

The interaction context corresponding to the key