Package com.github.jamesnetherton.zulip.client.api.stream

Enum TopicVisibilityPolicy

java.lang.Object

java.lang.Enum<TopicVisibilityPolicy>

com.github.jamesnetherton.zulip.client.api.stream.TopicVisibilityPolicy

All Implemented Interfaces:

Serializable, Comparable<TopicVisibilityPolicy>

public enum TopicVisibilityPolicy
extends Enum<TopicVisibilityPolicy>

Defines the type of topic visibility policy. See https://zulip.com/api/update-user-topic#parameter-visibility_policy

Enum Constant Summary

Enum Constants

Enum Constant	Description
MUTED	Mutes the topic in a stream.
NONE	Removes the visibility policy previously set for the topic.
UNMUTED	Unmutes the topic in a muted stream.

Method Summary

Modifier and Type	Method	Description
static TopicVisibilityPolicy	fromInt(int visibilityPolicy)
int	getId()
static TopicVisibilityPolicy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TopicVisibilityPolicy[]	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 Details

NONE

public static final TopicVisibilityPolicy NONE

Removes the visibility policy previously set for the topic.

MUTED

public static final TopicVisibilityPolicy MUTED

Mutes the topic in a stream.

UNMUTED

public static final TopicVisibilityPolicy UNMUTED

Unmutes the topic in a muted stream.

Method Details

values

public static TopicVisibilityPolicy[] 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 TopicVisibilityPolicy 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

getId

public int getId()

fromInt

public static TopicVisibilityPolicy fromInt(int visibilityPolicy)