net.dv8tion.jda

Enum Region

java.lang.Object

java.lang.Enum<Region>

net.dv8tion.jda.Region

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Region>

public enum Region
extends java.lang.Enum<Region>

Represents the Regions that Discord has servers in.
This is used by Guild to where the server that hosts the Guild is located.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AMSTERDAM
FRANKFURT
LONDON
SINGAPORE
SYDNEY
UNKNOWN
US_EAST
US_WEST

Method Summary

Modifier and Type	Method and Description
static Region	fromKey(java.lang.String key) Retrieves the Region based on the provided key.
java.lang.String	getKey() The Region key as defined by Discord.
java.lang.String	getName() The human readable region name.
java.lang.String	toString()
static Region	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Region[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AMSTERDAM

public static final Region AMSTERDAM

FRANKFURT

public static final Region FRANKFURT

LONDON

public static final Region LONDON

SINGAPORE

public static final Region SINGAPORE

SYDNEY

public static final Region SYDNEY

US_EAST

public static final Region US_EAST

US_WEST

public static final Region US_WEST

UNKNOWN

public static final Region UNKNOWN

Method Detail

values

public static Region[] 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 (Region c : Region.values())
    System.out.println(c);

Returns:

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

valueOf

public static Region valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getName

public java.lang.String getName()

The human readable region name.

Returns:

The name of this region

getKey

public java.lang.String getKey()

The Region key as defined by Discord.

Returns:

The key (internal name) of this region

fromKey

public static Region fromKey(java.lang.String key)

Retrieves the Region based on the provided key.

Parameters:

key - The key relating to the Region we wish to retrieve.

Returns:

The Region matching the key. If there is no match, returns UNKNOWN.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Region>