Scope (ultimategdbot-api 5.0.1 API)

java.lang.Object
- java.lang.Enum<Scope>
- - com.github.alex1304.ultimategdbot.api.command.Scope

All Implemented Interfaces:

Serializable, Comparable<Scope>
```
public enum Scope
extends Enum<Scope>
```
The scope of a command, that is, the kind of channels where the command is applicable.

Enum Constant Summary

Enum Constants
Enum Constant Description

ANYWHERE

DM_ONLY

GUILD_ONLY

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`isInScope(discord4j.core.object.entity.channel.Channel channel)`
`static Scope`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static Scope[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ANYWHERE
```
public static final Scope ANYWHERE
```
  - DM_ONLY
```
public static final Scope DM_ONLY
```
  - GUILD_ONLY
```
public static final Scope GUILD_ONLY
```
- Method Detail
  - values
```
public static Scope[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (Scope c : Scope.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Scope 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
  - isInScope
```
public boolean isInScope(discord4j.core.object.entity.channel.Channel channel)
```