Package twitter4j.v1

Interface User

All Superinterfaces:
Comparable<User>, Serializable, TwitterResponse

public interface User extends Comparable<User>, TwitterResponse, Serializable
A data interface representing Basic user information element
  • Method Details

    • getId

      long getId()
      Returns the id of the user
      Returns:
      the id of the user
    • getName

      String getName()
      Returns the name of the user
      Returns:
      the name of the user
    • getEmail

      String getEmail()
      Returns the email of the user, if the app is whitelisted by Twitter
      Returns:
      the email of the user
    • getScreenName

      String getScreenName()
      Returns the screen name of the user
      Returns:
      the screen name of the user
    • getLocation

      String getLocation()
      Returns the location of the user
      Returns:
      the location of the user
    • getDescription

      String getDescription()
      Returns the description of the user
      Returns:
      the description of the user
    • isContributorsEnabled

      boolean isContributorsEnabled()
      Tests if the user is enabling contributors
      Returns:
      if the user is enabling contributors
      Since:
      Twitter4J 2.1.2
    • getProfileImageURL

      String getProfileImageURL()
      Returns the profile image url of the user
      Returns:
      the profile image url of the user
    • getBiggerProfileImageURL

      String getBiggerProfileImageURL()
      Returns:
      bigger profile image URL
    • getMiniProfileImageURL

      String getMiniProfileImageURL()
      Returns:
      mini profile image URL
    • getOriginalProfileImageURL

      String getOriginalProfileImageURL()
      Returns:
      original profile image URL
    • get400x400ProfileImageURL

      String get400x400ProfileImageURL()
      Returns:
      profile image url
      Since:
      Twitter4J 4.0.7
    • getProfileImageURLHttps

      String getProfileImageURLHttps()
      Returns:
      profile image URL
    • getBiggerProfileImageURLHttps

      String getBiggerProfileImageURLHttps()
      Returns:
      profile image URL
    • getMiniProfileImageURLHttps

      String getMiniProfileImageURLHttps()
      Returns:
      mini profile image URL
    • getOriginalProfileImageURLHttps

      String getOriginalProfileImageURLHttps()
      Returns:
      original profile image URL
    • get400x400ProfileImageURLHttps

      String get400x400ProfileImageURLHttps()
      Returns:
      profile image url
      Since:
      Twitter4J 4.0.7
    • isDefaultProfileImage

      boolean isDefaultProfileImage()
      Tests if the user has not uploaded their own avatar
      Returns:
      if the user has not uploaded their own avatar
    • getURL

      String getURL()
      Returns the url of the user
      Returns:
      the url of the user
    • isProtected

      boolean isProtected()
      Test if the user status is protected
      Returns:
      true if the user status is protected
    • getFollowersCount

      int getFollowersCount()
      Returns the number of followers
      Returns:
      the number of followers
      Since:
      Twitter4J 1.0.4
    • getStatus

      Status getStatus()
      Returns the current status of the user
      This can be null if the instance if from Status.getUser().
      Returns:
      current status of the user
      Since:
      Twitter4J 2.1.1
    • getProfileBackgroundColor

      String getProfileBackgroundColor()
      Returns:
      profile background color
    • getProfileTextColor

      String getProfileTextColor()
      Returns:
      profile text color
    • getProfileLinkColor

      String getProfileLinkColor()
      Returns:
      profile link color
    • getProfileSidebarFillColor

      String getProfileSidebarFillColor()
      Returns:
      profile sidebar fill color
    • getProfileSidebarBorderColor

      String getProfileSidebarBorderColor()
      Returns:
      profile sidebar border color
    • isProfileUseBackgroundImage

      boolean isProfileUseBackgroundImage()
      Returns:
      profile use background image
    • isDefaultProfile

      boolean isDefaultProfile()
      Tests if the user has not altered the theme or background
      Returns:
      if the user has not altered the theme or background
    • isShowAllInlineMedia

      boolean isShowAllInlineMedia()
      Returns:
      show all inline media
    • getFriendsCount

      int getFriendsCount()
      Returns the number of users the user follows (AKA "followings")
      Returns:
      the number of users the user follows
    • getCreatedAt

      LocalDateTime getCreatedAt()
      Returns:
      created at
    • getFavouritesCount

      int getFavouritesCount()
      Returns:
      favorites count
    • getUtcOffset

      int getUtcOffset()
      Returns:
      UTC offset
    • getTimeZone

      String getTimeZone()
      Returns:
      time zone
    • getProfileBackgroundImageURL

      String getProfileBackgroundImageURL()
      Returns:
      profile background image URL
    • getProfileBackgroundImageUrlHttps

      String getProfileBackgroundImageUrlHttps()
      Returns:
      profile background image URL
    • getProfileBannerURL

      String getProfileBannerURL()
      Returns:
      profile banner URL
      Since:
      Twitter4J 3.0.0
    • getProfileBannerRetinaURL

      String getProfileBannerRetinaURL()
      Returns:
      profile banner retina URL
      Since:
      Twitter4J 3.0.0
    • getProfileBannerIPadURL

      String getProfileBannerIPadURL()
      Returns:
      profile banner iPad URL
      Since:
      Twitter4J 3.0.0
    • getProfileBannerIPadRetinaURL

      String getProfileBannerIPadRetinaURL()
      Returns:
      profile banner iPad retina URL
      Since:
      Twitter4J 3.0.0
    • getProfileBannerMobileURL

      String getProfileBannerMobileURL()
      Returns:
      profile banner mobile URL
      Since:
      Twitter4J 3.0.0
    • getProfileBannerMobileRetinaURL

      String getProfileBannerMobileRetinaURL()
      Returns:
      profile banner mobile retina URL
      Since:
      Twitter4J 3.0.0
    • getProfileBanner300x100URL

      String getProfileBanner300x100URL()
      Returns:
      profile banner 300x100 URL
      Since:
      Twitter4J 4.0.7
    • getProfileBanner600x200URL

      String getProfileBanner600x200URL()
      Returns:
      profile banner 600x200 URL
      Since:
      Twitter4J 4.0.7
    • getProfileBanner1500x500URL

      String getProfileBanner1500x500URL()
      Returns:
      profile banner 1500x500 URL
      Since:
      Twitter4J 4.0.7
    • isProfileBackgroundTiled

      boolean isProfileBackgroundTiled()
      Returns:
      profile background tiled
    • getLang

      String getLang()
      Returns the preferred language of the user
      Returns:
      the preferred language of the user
      Since:
      Twitter4J 2.1.2
    • getStatusesCount

      int getStatusesCount()
      Returns:
      status count
    • isGeoEnabled

      boolean isGeoEnabled()
      Returns:
      the user is enabling geo location
      Since:
      Twitter4J 2.0.10
    • isVerified

      boolean isVerified()
      Returns:
      returns true if the user is a verified celebrity
      Since:
      Twitter4J 2.0.10
    • isTranslator

      boolean isTranslator()
      Returns:
      returns true if the user is a translator
      Since:
      Twitter4J 2.1.9
    • getListedCount

      int getListedCount()
      Returns the number of public lists the user is listed on, or -1 if the count is unavailable.
      Returns:
      the number of public lists the user is listed on.
      Since:
      Twitter4J 2.1.4
    • isFollowRequestSent

      boolean isFollowRequestSent()
      Returns true if the authenticating user has requested to follow this user, otherwise false.
      Returns:
      true if the authenticating user has requested to follow this user.
      Since:
      Twitter4J 2.1.4
    • getDescriptionURLEntities

      URLEntity[] getDescriptionURLEntities()
      Returns URL entities for user description.
      Returns:
      URL entities for user description
      Since:
      Twitter4J 3.0.3
    • getURLEntity

      URLEntity getURLEntity()
      Returns URL entity for user's URL.
      Returns:
      URL entity for user's URL.
      Since:
      Twitter4J 3.0.3
    • getWithheldInCountries

      String[] getWithheldInCountries()
      Returns the list of country codes where the user is withheld
      Returns:
      list of country codes where the tweet is withheld - null if not withheld
      Since:
      Twitter4j 4.0.3