Package zendesk.core

Class UserField


  • public class UserField
extends java.lang.Object
    This is a model class for a user field that will be created by the UserProvider as part of UserFieldResponse.
    See Also:
    User fields

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class and Description
      static class  UserField.UserFieldType
      Enum for describing the type of a user field.

    • Constructor Summary

      Constructors 
      Constructor and Description
      UserField() 

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.util.Date getCreatedAt()
      Gets the date that the user field was created at
      java.lang.String getDescription()
      Get the description of the user field.
      java.lang.Long getId()
      Get the id of the user field.
      java.lang.String getKey()
      Get the unique key of the user field.
      java.lang.Long getPosition()
      Gets the position of the user field
      java.lang.String getRawDescription()
      Get the raw description of the user field.
      java.lang.String getRawTitle()
      Gets the raw title of the user field
      java.lang.String getRegexpForValidation()
      Gets the regexp which is used to validate the user field
      java.lang.String getTitle()
      Get the title of the user field.
      java.util.Date getUpdatedAt()
      Gets the date that the user field was updated at
      java.lang.String getUrl()
      Gets the API URL of the user field
      java.util.List<UserFieldOption> getUserFieldOptions()
      Get a list of UserFieldOption.
      UserField.UserFieldType getUserFieldType()
      Get the type of the user field.
      boolean isActive()
      Checks if the user field is active or not
      boolean isSystem()
      Checks if the user field is a system field or not

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • UserField

        public UserField()

    • Method Detail

      • getId

        public java.lang.Long getId()
        Get the id of the user field.
        Returns:
        the id of the field

      • getUrl

        public java.lang.String getUrl()
        Gets the API URL of the user field
        Returns:
        the API URL of the user field

      • getUserFieldType

        public UserField.UserFieldType getUserFieldType()
        Get the type of the user field.
        Returns:
        the type of the field

      • getKey

        public java.lang.String getKey()
        Get the unique key of the user field.

        Use this property for updating the user field by calling UserProvider#setUserFields(Map, ZendeskCallback)

        Returns:
        the unique key of the field

      • getTitle

        public java.lang.String getTitle()
        Get the title of the user field.
        Returns:
        the title of the field

      • getDescription

        public java.lang.String getDescription()
        Get the description of the user field.
        Returns:
        the description of the field

      • getRawDescription

        public java.lang.String getRawDescription()
        Get the raw description of the user field.
        Returns:
        the raw description of the field

      • getRawTitle

        public java.lang.String getRawTitle()
        Gets the raw title of the user field
        Returns:
        the raw title of the user field

      • getPosition

        public java.lang.Long getPosition()
        Gets the position of the user field
        Returns:
        the position of the user field

      • isActive

        public boolean isActive()
        Checks if the user field is active or not
        Returns:
        true if it is active, false otherwise

      • isSystem

        public boolean isSystem()
        Checks if the user field is a system field or not
        Returns:
        @return true if it is system, false otherwise

      • getRegexpForValidation

        public java.lang.String getRegexpForValidation()
        Gets the regexp which is used to validate the user field
        Returns:
        the regexp which is used to validate the user field

      • getCreatedAt

        public java.util.Date getCreatedAt()
        Gets the date that the user field was created at
        Returns:
        the date that the user field was created at

      • getUpdatedAt

        public java.util.Date getUpdatedAt()
        Gets the date that the user field was updated at
        Returns:
        the date that the user field was updated at

      • getUserFieldOptions

        public java.util.List<UserFieldOption> getUserFieldOptions()
        Get a list of UserFieldOption.

        Options for the custom user field. Only for Dropdown type of user fields.

        Returns:
        the list of user field options