com.sendbird.android

Enum GroupChannelListQuery.SuperChannelFilter

java.lang.Object

java.lang.Enum<GroupChannelListQuery.SuperChannelFilter>

com.sendbird.android.GroupChannelListQuery.SuperChannelFilter

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GroupChannelListQuery.SuperChannelFilter>

Enclosing class:

GroupChannelListQuery

public static enum GroupChannelListQuery.SuperChannelFilter
extends java.lang.Enum<GroupChannelListQuery.SuperChannelFilter>

The super channel filter. Refer to GroupChannelListQuery.setSuperChannelFilter(SuperChannelFilter).

Since:

3.0.49

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL When this filter is set, all channels will be retrieved whether it is a super or not.
BROADCAST_CHANNEL_ONLY When this filter is set, only broadcast channels will be retrieved.
NONSUPER_CHANNEL_ONLY When this filter is set, only non-super channels will be retrieved.
SUPER_CHANNEL_ONLY When this filter is set, only super channels will be retrieved.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	value

Method Summary

Modifier and Type	Method and Description
static GroupChannelListQuery.SuperChannelFilter	fromValue(java.lang.String value)
static GroupChannelListQuery.SuperChannelFilter	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GroupChannelListQuery.SuperChannelFilter[]	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 Detail

ALL

public static final GroupChannelListQuery.SuperChannelFilter ALL

When this filter is set, all channels will be retrieved whether it is a super or not.

SUPER_CHANNEL_ONLY

public static final GroupChannelListQuery.SuperChannelFilter SUPER_CHANNEL_ONLY

When this filter is set, only super channels will be retrieved. Broadcast channels will be included because broadcast channel is subset of super channel.

BROADCAST_CHANNEL_ONLY

public static final GroupChannelListQuery.SuperChannelFilter BROADCAST_CHANNEL_ONLY

When this filter is set, only broadcast channels will be retrieved.

NONSUPER_CHANNEL_ONLY

public static final GroupChannelListQuery.SuperChannelFilter NONSUPER_CHANNEL_ONLY

When this filter is set, only non-super channels will be retrieved. In other words, super channels won't be retrieved.

Field Detail

value

public final java.lang.String value

Method Detail

values

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

Returns:

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

valueOf

public static GroupChannelListQuery.SuperChannelFilter 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

fromValue

public static GroupChannelListQuery.SuperChannelFilter fromValue(java.lang.String value)