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

Enum UserRole

java.lang.Object

java.lang.Enum<UserRole>

com.github.jamesnetherton.zulip.client.api.user.UserRole

All Implemented Interfaces:

Serializable, Comparable<UserRole>

public enum UserRole
extends Enum<UserRole>

Defines Zulip user roles.

Enum Constant Summary

Enum Constants

Enum Constant	Description
GUEST	Guest role.
MEMBER	Member role.
ORGANIZATION_ADMIN	Organization administrator role.
ORGANIZATION_MODERATOR	Organization moderator role.
ORGANIZATION_OWNER	Organization owner role.
UNKNOWN	Unknown role.

Method Summary

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

ORGANIZATION_OWNER

public static final UserRole ORGANIZATION_OWNER

Organization owner role.

ORGANIZATION_ADMIN

public static final UserRole ORGANIZATION_ADMIN

Organization administrator role.

ORGANIZATION_MODERATOR

public static final UserRole ORGANIZATION_MODERATOR

Organization moderator role.

MEMBER

public static final UserRole MEMBER

Member role.

GUEST

public static final UserRole GUEST

Guest role.

UNKNOWN

public static final UserRole UNKNOWN

Unknown role.

Method Details

values

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