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

Enum ProfileFieldType

java.lang.Object

java.lang.Enum<ProfileFieldType>

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

All Implemented Interfaces:

Serializable, Comparable<ProfileFieldType>

public enum ProfileFieldType
extends Enum<ProfileFieldType>

Defines the type of custom profile field. See https://zulip.com/help/add-custom-profile-fields#profile-field-types

Enum Constant Summary

Enum Constants

Enum Constant	Description
DATE_PICKER	Profile field with a date picker.
EXTERNAL_ACCOUNT	Profile field to for linking to GitHub, Twitter etc.
LINK	Profile field for a web site hyperlink.
LIST_OF_OPTIONS	Profile field with a list of options to choose from.
LONG_TEXT	Profile field for multiline responses.
PERSON_PICKER	Profile field with a person picker.
PRONOUNS	Profile field for pronouns.
SHORT_TEXT	Profile field for one line responses limited to 50 characters.
UNKNOWN	An unknown profile field type.

Method Summary

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

SHORT_TEXT

public static final ProfileFieldType SHORT_TEXT

Profile field for one line responses limited to 50 characters.

LONG_TEXT

public static final ProfileFieldType LONG_TEXT

Profile field for multiline responses.

LIST_OF_OPTIONS

public static final ProfileFieldType LIST_OF_OPTIONS

Profile field with a list of options to choose from.

DATE_PICKER

public static final ProfileFieldType DATE_PICKER

Profile field with a date picker.

LINK

public static final ProfileFieldType LINK

Profile field for a web site hyperlink.

PERSON_PICKER

public static final ProfileFieldType PERSON_PICKER

Profile field with a person picker.

EXTERNAL_ACCOUNT

public static final ProfileFieldType EXTERNAL_ACCOUNT

Profile field to for linking to GitHub, Twitter etc.

PRONOUNS

public static final ProfileFieldType PRONOUNS

Profile field for pronouns.

UNKNOWN

public static final ProfileFieldType UNKNOWN

An unknown profile field type. This usually indicates an error in the response from Zulip.

Method Details

values

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