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

Enum MarkReadOnScrollPolicy

java.lang.Object

java.lang.Enum<MarkReadOnScrollPolicy>

com.github.jamesnetherton.zulip.client.api.server.MarkReadOnScrollPolicy

All Implemented Interfaces:

Serializable, Comparable<MarkReadOnScrollPolicy>

public enum MarkReadOnScrollPolicy
extends Enum<MarkReadOnScrollPolicy>

Defines the mark read policy for when a user scrolls through their feed. See https://zulip.com/api/update-settings#parameter-web_mark_read_on_scroll_policy

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	Messages are always marked as read.
CONSERVATION_VIEWS	Messages are only marked as read in conversation views.
NEVER	Messages are never marked as read.

Method Summary

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

ALWAYS

public static final MarkReadOnScrollPolicy ALWAYS

Messages are always marked as read.

CONSERVATION_VIEWS

public static final MarkReadOnScrollPolicy CONSERVATION_VIEWS

Messages are only marked as read in conversation views.

NEVER

public static final MarkReadOnScrollPolicy NEVER

Messages are never marked as read.

Method Details

values

public static MarkReadOnScrollPolicy[] 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 MarkReadOnScrollPolicy 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 MarkReadOnScrollPolicy fromInt(int readOnScrollPolicy)