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

Enum Anchor

java.lang.Object

java.lang.Enum<Anchor>

com.github.jamesnetherton.zulip.client.api.message.Anchor

All Implemented Interfaces:

Serializable, Comparable<Anchor>

public enum Anchor
extends Enum<Anchor>

Defines anchor options for matching messages.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DATE	The first message on or after the datetime indicated by the anchor_date parameter, if any; otherwise, the most recent message.
FIRST_UNREAD	The oldest unread message matching the query, if any; otherwise, the most recent message.
NEWEST	The most recent message.
OLDEST	The oldest message.

Method Summary

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

DATE

public static final Anchor DATE

The first message on or after the datetime indicated by the anchor_date parameter, if any; otherwise, the most recent message.

See Also:

• https://zulip.com/api/get-messages#parameter-anchor

FIRST_UNREAD

public static final Anchor FIRST_UNREAD

The oldest unread message matching the query, if any; otherwise, the most recent message.

NEWEST

public static final Anchor NEWEST

The most recent message.

OLDEST

public static final Anchor OLDEST

The oldest message.

Method Details

values

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

toString

public String toString()

Overrides:

toString in class Enum<Anchor>