Package com.github.twitch4j.helix.domain

Enum Class Video.SearchOrder

java.lang.Object

java.lang.Enum<Video.SearchOrder>

com.github.twitch4j.helix.domain.Video.SearchOrder

All Implemented Interfaces:

Serializable, Comparable<Video.SearchOrder>, Constable

Enclosing class:

Video

public static enum Video.SearchOrder
extends Enum<Video.SearchOrder>

The order to sort the returned videos in.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
TIME	Sort the results in descending order by when they were created (i.e., latest video first).
TRENDING	Sort the results in descending order by biggest gains in viewership (i.e., highest trending video first).
VIEWS	Sort the results in descending order by most views (i.e., highest number of views first).

Field Summary

Fields

Modifier and Type	Field	Description
static final Map<String,Video.SearchOrder>	MAPPINGS

Method Summary

Modifier and Type	Method	Description
String	toString()
static Video.SearchOrder	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Video.SearchOrder[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TIME

public static final Video.SearchOrder TIME

Sort the results in descending order by when they were created (i.e., latest video first).

TRENDING

public static final Video.SearchOrder TRENDING

Sort the results in descending order by biggest gains in viewership (i.e., highest trending video first).

VIEWS

public static final Video.SearchOrder VIEWS

Sort the results in descending order by most views (i.e., highest number of views first).

Field Details

MAPPINGS

@Internal
public static final Map<String,Video.SearchOrder> MAPPINGS

Method Details

values

public static Video.SearchOrder[] values()

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

Returns:

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

valueOf

public static Video.SearchOrder valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<Video.SearchOrder>