Package pw.chew.clickup4j.api.entities.customfields

Interface UsersCustomField

All Superinterfaces:
ICustomField
All Known Implementing Classes:
UsersCustomFieldImpl
public interface UsersCustomField extends ICustomField

  • Method Details

    • getValue

      List<User> 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

    • isSingleUser

      boolean isSingleUser()
      Whether this allows multiple values. If true, the value will be a single user.
      In the client, this is referred to as "Select multiple users," and this is actually inverted.
      Returns:
      Whether this allows multiple values.

    • shouldIncludeGuests

      boolean shouldIncludeGuests()
      Whether guests may show up in this field.
      Guests are not Members of the workspace, but may have rights in the list or task.
      Returns:
      Whether guests may show up in this field.

    • includeTeams

      boolean includeTeams()
      Whether teams may show up in the field response. If this is true, getValue() may break.
      Returns:
      Whether teams may show up in the field response.

    • includeEntireWorkspace

      boolean includeEntireWorkspace()
      Whether the entire workspace can show up in the field response. Normally, only members of the list this task is a part of can be here.
      Returns:
      Whether the entire workspace can show up in the field response.

    • 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