EmojiCustomField (clickup4j 1.0-SNAPSHOT API)

All Superinterfaces:: ICustomField

All Known Implementing Classes:: EmojiCustomFieldImpl

public interface EmojiCustomField extends ICustomField

Method Summary

Modifier and Type

Method

Description

int

getCount()

Gets the count for the rating used for this Emoji.

String

getEmoji()

The emoji value associated with this custom field.

default CustomFieldType

getType()

Returns the type of this custom field.

Integer

getValue()

Returns the value of this custom field.

Methods inherited from interface pw.chew.clickup4j.api.entities.customfields.ICustomField
getClickUp4j, getId, getName, getTimeCreated, isRequired

Method Details
- getValue
  
  Integer getValue()
  
  Description copied from interface: ICustomField
  Returns the value of this custom field.
  It's highly recommended to cast this value to the appropriate type, because it returns more appropriate data. For example, if the custom field is of type CustomFieldType.TEXT, you can cast the value to TextCustomField, this class can be found using CustomFieldType.getAssociatedClass().
  
  This will be null under the following circumstances:
  
  No value is specified.
  
  The task response did not contain a value. Notably when an individual task is retrieved.
  Specified by:
  
  getValue in interface ICustomField
  
  Returns:
  
  the value of this custom field
- getEmoji
  
  String getEmoji()
  
  The emoji value associated with this custom field. E.g. 😎
  
  Returns:
  
  a string value of the unicode representation of the emoji
- getCount
  
  int getCount()
  
  Gets the count for the rating used for this Emoji. Must be between 1-5.
  
  Returns:
  
  an int value of 1-5
- getType
  
  default CustomFieldType getType()
  
  Description copied from interface: ICustomField
  
  Returns the type of this custom field. This will be one of CustomFieldType.
  
  Specified by:
  
  getType in interface ICustomField
  
  Returns:
  
  the type of this custom field